PageRenderTime 63ms CodeModel.GetById 27ms RepoModel.GetById 0ms app.codeStats 0ms

/lib/Cake/Model/Datasource/DboSource.php

http://github.com/cakephp/cakephp
PHP | 2221 lines | 1411 code | 181 blank | 629 comment | 355 complexity | 86f1999909b5c8a4f0c01da8c2f24612 MD5 | raw file
Possible License(s): JSON

Large files files are truncated, but you can click here to view the full file

  1. <?php
  2. /**
  3. * Dbo Source
  4. *
  5. * PHP 5
  6. *
  7. * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
  8. * Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  9. *
  10. * Licensed under The MIT License
  11. * Redistributions of files must retain the above copyright notice.
  12. *
  13. * @copyright Copyright 2005-2011, Cake Software Foundation, Inc. (http://cakefoundation.org)
  14. * @link http://cakephp.org CakePHP(tm) Project
  15. * @package Cake.Model.Datasource
  16. * @since CakePHP(tm) v 0.10.0.1076
  17. * @license MIT License (http://www.opensource.org/licenses/mit-license.php)
  18. */
  19. App::uses('DataSource', 'Model/Datasource');
  20. App::uses('String', 'Utility');
  21. App::uses('View', 'View');
  22. /**
  23. * DboSource
  24. *
  25. * Creates DBO-descendant objects from a given db connection configuration
  26. *
  27. * @package Cake.Model.Datasource
  28. */
  29. class DboSource extends DataSource {
  30. /**
  31. * Description string for this Database Data Source.
  32. *
  33. * @var string
  34. */
  35. public $description = "Database Data Source";
  36. /**
  37. * index definition, standard cake, primary, index, unique
  38. *
  39. * @var array
  40. */
  41. public $index = array('PRI' => 'primary', 'MUL' => 'index', 'UNI' => 'unique');
  42. /**
  43. * Database keyword used to assign aliases to identifiers.
  44. *
  45. * @var string
  46. */
  47. public $alias = 'AS ';
  48. /**
  49. * Caches result from query parsing operations. Cached results for both DboSource::name() and
  50. * DboSource::conditions() will be stored here. Method caching uses `crc32()` which is
  51. * fast but can collisions more easily than other hashing algorithms. If you have problems
  52. * with collisions, set DboSource::$cacheMethods to false.
  53. *
  54. * @var array
  55. */
  56. public static $methodCache = array();
  57. /**
  58. * Whether or not to cache the results of DboSource::name() and DboSource::conditions()
  59. * into the memory cache. Set to false to disable the use of the memory cache.
  60. *
  61. * @var boolean.
  62. */
  63. public $cacheMethods = true;
  64. /**
  65. * Print full query debug info?
  66. *
  67. * @var boolean
  68. */
  69. public $fullDebug = false;
  70. /**
  71. * String to hold how many rows were affected by the last SQL operation.
  72. *
  73. * @var string
  74. */
  75. public $affected = null;
  76. /**
  77. * Number of rows in current resultset
  78. *
  79. * @var integer
  80. */
  81. public $numRows = null;
  82. /**
  83. * Time the last query took
  84. *
  85. * @var integer
  86. */
  87. public $took = null;
  88. /**
  89. * Result
  90. *
  91. * @var array
  92. */
  93. protected $_result = null;
  94. /**
  95. * Queries count.
  96. *
  97. * @var integer
  98. */
  99. protected $_queriesCnt = 0;
  100. /**
  101. * Total duration of all queries.
  102. *
  103. * @var integer
  104. */
  105. protected $_queriesTime = null;
  106. /**
  107. * Log of queries executed by this DataSource
  108. *
  109. * @var array
  110. */
  111. protected $_queriesLog = array();
  112. /**
  113. * Maximum number of items in query log
  114. *
  115. * This is to prevent query log taking over too much memory.
  116. *
  117. * @var integer Maximum number of queries in the queries log.
  118. */
  119. protected $_queriesLogMax = 200;
  120. /**
  121. * Caches serialized results of executed queries
  122. *
  123. * @var array Maximum number of queries in the queries log.
  124. */
  125. protected $_queryCache = array();
  126. /**
  127. * A reference to the physical connection of this DataSource
  128. *
  129. * @var array
  130. */
  131. protected $_connection = null;
  132. /**
  133. * The DataSource configuration key name
  134. *
  135. * @var string
  136. */
  137. public $configKeyName = null;
  138. /**
  139. * The starting character that this DataSource uses for quoted identifiers.
  140. *
  141. * @var string
  142. */
  143. public $startQuote = null;
  144. /**
  145. * The ending character that this DataSource uses for quoted identifiers.
  146. *
  147. * @var string
  148. */
  149. public $endQuote = null;
  150. /**
  151. * The set of valid SQL operations usable in a WHERE statement
  152. *
  153. * @var array
  154. */
  155. protected $_sqlOps = array('like', 'ilike', 'or', 'not', 'in', 'between', 'regexp', 'similar to');
  156. /**
  157. * Indicates the level of nested transactions
  158. *
  159. * @var integer
  160. */
  161. protected $_transactionNesting = 0;
  162. /**
  163. * Index of basic SQL commands
  164. *
  165. * @var array
  166. */
  167. protected $_commands = array(
  168. 'begin' => 'BEGIN',
  169. 'commit' => 'COMMIT',
  170. 'rollback' => 'ROLLBACK'
  171. );
  172. /**
  173. * Separator string for virtualField composition
  174. *
  175. * @var string
  176. */
  177. public $virtualFieldSeparator = '__';
  178. /**
  179. * List of table engine specific parameters used on table creating
  180. *
  181. * @var array
  182. */
  183. public $tableParameters = array();
  184. /**
  185. * List of engine specific additional field parameters used on table creating
  186. *
  187. * @var array
  188. */
  189. public $fieldParameters = array();
  190. /**
  191. * Indicates whether there was a change on the cached results on the methods of this class
  192. * This will be used for storing in a more persistent cache
  193. *
  194. * @var boolean
  195. */
  196. protected $_methodCacheChange = false;
  197. /**
  198. * Constructor
  199. *
  200. * @param array $config Array of configuration information for the Datasource.
  201. * @param boolean $autoConnect Whether or not the datasource should automatically connect.
  202. */
  203. public function __construct($config = null, $autoConnect = true) {
  204. if (!isset($config['prefix'])) {
  205. $config['prefix'] = '';
  206. }
  207. parent::__construct($config);
  208. $this->fullDebug = Configure::read('debug') > 1;
  209. if (!$this->enabled()) {
  210. throw new MissingConnectionException(array(
  211. 'class' => get_class($this)
  212. ));
  213. }
  214. if ($autoConnect) {
  215. $this->connect();
  216. }
  217. }
  218. /**
  219. * Reconnects to database server with optional new settings
  220. *
  221. * @param array $config An array defining the new configuration settings
  222. * @return boolean True on success, false on failure
  223. */
  224. public function reconnect($config = array()) {
  225. $this->disconnect();
  226. $this->setConfig($config);
  227. $this->_sources = null;
  228. return $this->connect();
  229. }
  230. /**
  231. * Disconnects from database.
  232. *
  233. * @return boolean True if the database could be disconnected, else false
  234. */
  235. public function disconnect() {
  236. if ($this->_result instanceof PDOStatement) {
  237. $this->_result->closeCursor();
  238. }
  239. unset($this->_connection);
  240. $this->connected = false;
  241. return true;
  242. }
  243. /**
  244. * Get the underlying connection object.
  245. *
  246. * @return PDOConnection
  247. */
  248. public function getConnection() {
  249. return $this->_connection;
  250. }
  251. /**
  252. * Returns a quoted and escaped string of $data for use in an SQL statement.
  253. *
  254. * @param string $data String to be prepared for use in an SQL statement
  255. * @param string $column The column into which this data will be inserted
  256. * @return string Quoted and escaped data
  257. */
  258. public function value($data, $column = null) {
  259. if (is_array($data) && !empty($data)) {
  260. return array_map(
  261. array(&$this, 'value'),
  262. $data, array_fill(0, count($data), $column)
  263. );
  264. } elseif (is_object($data) && isset($data->type, $data->value)) {
  265. if ($data->type == 'identifier') {
  266. return $this->name($data->value);
  267. } elseif ($data->type == 'expression') {
  268. return $data->value;
  269. }
  270. } elseif (in_array($data, array('{$__cakeID__$}', '{$__cakeForeignKey__$}'), true)) {
  271. return $data;
  272. }
  273. if ($data === null || (is_array($data) && empty($data))) {
  274. return 'NULL';
  275. }
  276. if (empty($column)) {
  277. $column = $this->introspectType($data);
  278. }
  279. switch ($column) {
  280. case 'binary':
  281. return $this->_connection->quote($data, PDO::PARAM_LOB);
  282. break;
  283. case 'boolean':
  284. return $this->_connection->quote($this->boolean($data, true), PDO::PARAM_BOOL);
  285. break;
  286. case 'string':
  287. case 'text':
  288. return $this->_connection->quote($data, PDO::PARAM_STR);
  289. default:
  290. if ($data === '') {
  291. return 'NULL';
  292. }
  293. if (is_float($data)) {
  294. return str_replace(',', '.', strval($data));
  295. }
  296. if ((is_int($data) || $data === '0') || (
  297. is_numeric($data) && strpos($data, ',') === false &&
  298. $data[0] != '0' && strpos($data, 'e') === false)
  299. ) {
  300. return $data;
  301. }
  302. return $this->_connection->quote($data);
  303. break;
  304. }
  305. }
  306. /**
  307. * Returns an object to represent a database identifier in a query. Expression objects
  308. * are not sanitized or escaped.
  309. *
  310. * @param string $identifier A SQL expression to be used as an identifier
  311. * @return stdClass An object representing a database identifier to be used in a query
  312. */
  313. public function identifier($identifier) {
  314. $obj = new stdClass();
  315. $obj->type = 'identifier';
  316. $obj->value = $identifier;
  317. return $obj;
  318. }
  319. /**
  320. * Returns an object to represent a database expression in a query. Expression objects
  321. * are not sanitized or escaped.
  322. *
  323. * @param string $expression An arbitrary SQL expression to be inserted into a query.
  324. * @return stdClass An object representing a database expression to be used in a query
  325. */
  326. public function expression($expression) {
  327. $obj = new stdClass();
  328. $obj->type = 'expression';
  329. $obj->value = $expression;
  330. return $obj;
  331. }
  332. /**
  333. * Executes given SQL statement.
  334. *
  335. * @param string $sql SQL statement
  336. * @param array $params Additional options for the query.
  337. * @return boolean
  338. */
  339. public function rawQuery($sql, $params = array()) {
  340. $this->took = $this->numRows = false;
  341. return $this->execute($sql, $params);
  342. }
  343. /**
  344. * Queries the database with given SQL statement, and obtains some metadata about the result
  345. * (rows affected, timing, any errors, number of rows in resultset). The query is also logged.
  346. * If Configure::read('debug') is set, the log is shown all the time, else it is only shown on errors.
  347. *
  348. * ### Options
  349. *
  350. * - log - Whether or not the query should be logged to the memory log.
  351. *
  352. * @param string $sql
  353. * @param array $options
  354. * @param array $params values to be bided to the query
  355. * @return mixed Resource or object representing the result set, or false on failure
  356. */
  357. public function execute($sql, $options = array(), $params = array()) {
  358. $options += array('log' => $this->fullDebug);
  359. $t = microtime(true);
  360. $this->_result = $this->_execute($sql, $params);
  361. if ($options['log']) {
  362. $this->took = round((microtime(true) - $t) * 1000, 0);
  363. $this->numRows = $this->affected = $this->lastAffected();
  364. $this->logQuery($sql);
  365. }
  366. return $this->_result;
  367. }
  368. /**
  369. * Executes given SQL statement.
  370. *
  371. * @param string $sql SQL statement
  372. * @param array $params list of params to be bound to query
  373. * @param array $prepareOptions Options to be used in the prepare statement
  374. * @return mixed PDOStatement if query executes with no problem, true as the result of a successful, false on error
  375. * query returning no rows, such as a CREATE statement, false otherwise
  376. */
  377. protected function _execute($sql, $params = array(), $prepareOptions = array()) {
  378. $sql = trim($sql);
  379. if (preg_match('/^(?:CREATE|ALTER|DROP)/i', $sql)) {
  380. $statements = array_filter(explode(';', $sql));
  381. if (count($statements) > 1) {
  382. $result = array_map(array($this, '_execute'), $statements);
  383. return array_search(false, $result) === false;
  384. }
  385. }
  386. try {
  387. $query = $this->_connection->prepare($sql, $prepareOptions);
  388. $query->setFetchMode(PDO::FETCH_LAZY);
  389. if (!$query->execute($params)) {
  390. $this->_results = $query;
  391. $query->closeCursor();
  392. return false;
  393. }
  394. if (!$query->columnCount()) {
  395. $query->closeCursor();
  396. if (!$query->rowCount()) {
  397. return true;
  398. }
  399. }
  400. return $query;
  401. } catch (PDOException $e) {
  402. if (isset($query->queryString)) {
  403. $e->queryString = $query->queryString;
  404. } else {
  405. $e->queryString = $sql;
  406. }
  407. throw $e;
  408. }
  409. }
  410. /**
  411. * Returns a formatted error message from previous database operation.
  412. *
  413. * @param PDOStatement $query the query to extract the error from if any
  414. * @return string Error message with error number
  415. */
  416. public function lastError(PDOStatement $query = null) {
  417. if ($query) {
  418. $error = $query->errorInfo();
  419. } else {
  420. $error = $this->_connection->errorInfo();
  421. }
  422. if (empty($error[2])) {
  423. return null;
  424. }
  425. return $error[1] . ': ' . $error[2];
  426. }
  427. /**
  428. * Returns number of affected rows in previous database operation. If no previous operation exists,
  429. * this returns false.
  430. *
  431. * @param mixed $source
  432. * @return integer Number of affected rows
  433. */
  434. public function lastAffected($source = null) {
  435. if ($this->hasResult()) {
  436. return $this->_result->rowCount();
  437. }
  438. return null;
  439. }
  440. /**
  441. * Returns number of rows in previous resultset. If no previous resultset exists,
  442. * this returns false.
  443. *
  444. * @param mixed $source Not used
  445. * @return integer Number of rows in resultset
  446. */
  447. public function lastNumRows($source = null) {
  448. return $this->lastAffected();
  449. }
  450. /**
  451. * DataSource Query abstraction
  452. *
  453. * @return resource Result resource identifier.
  454. */
  455. public function query() {
  456. $args = func_get_args();
  457. $fields = null;
  458. $order = null;
  459. $limit = null;
  460. $page = null;
  461. $recursive = null;
  462. if (count($args) === 1) {
  463. return $this->fetchAll($args[0]);
  464. } elseif (count($args) > 1 && (strpos($args[0], 'findBy') === 0 || strpos($args[0], 'findAllBy') === 0)) {
  465. $params = $args[1];
  466. if (substr($args[0], 0, 6) === 'findBy') {
  467. $all = false;
  468. $field = Inflector::underscore(substr($args[0], 6));
  469. } else {
  470. $all = true;
  471. $field = Inflector::underscore(substr($args[0], 9));
  472. }
  473. $or = (strpos($field, '_or_') !== false);
  474. if ($or) {
  475. $field = explode('_or_', $field);
  476. } else {
  477. $field = explode('_and_', $field);
  478. }
  479. $off = count($field) - 1;
  480. if (isset($params[1 + $off])) {
  481. $fields = $params[1 + $off];
  482. }
  483. if (isset($params[2 + $off])) {
  484. $order = $params[2 + $off];
  485. }
  486. if (!array_key_exists(0, $params)) {
  487. return false;
  488. }
  489. $c = 0;
  490. $conditions = array();
  491. foreach ($field as $f) {
  492. $conditions[$args[2]->alias . '.' . $f] = $params[$c++];
  493. }
  494. if ($or) {
  495. $conditions = array('OR' => $conditions);
  496. }
  497. if ($all) {
  498. if (isset($params[3 + $off])) {
  499. $limit = $params[3 + $off];
  500. }
  501. if (isset($params[4 + $off])) {
  502. $page = $params[4 + $off];
  503. }
  504. if (isset($params[5 + $off])) {
  505. $recursive = $params[5 + $off];
  506. }
  507. return $args[2]->find('all', compact('conditions', 'fields', 'order', 'limit', 'page', 'recursive'));
  508. } else {
  509. if (isset($params[3 + $off])) {
  510. $recursive = $params[3 + $off];
  511. }
  512. return $args[2]->find('first', compact('conditions', 'fields', 'order', 'recursive'));
  513. }
  514. } else {
  515. if (isset($args[1]) && $args[1] === true) {
  516. return $this->fetchAll($args[0], true);
  517. } else if (isset($args[1]) && !is_array($args[1]) ) {
  518. return $this->fetchAll($args[0], false);
  519. } else if (isset($args[1]) && is_array($args[1])) {
  520. $offset = 0;
  521. if (isset($args[2])) {
  522. $cache = $args[2];
  523. } else {
  524. $cache = true;
  525. }
  526. return $this->fetchAll($args[0], $args[1], array('cache' => $cache));
  527. }
  528. }
  529. }
  530. /**
  531. * Returns a row from current resultset as an array
  532. *
  533. * @param string $sql Some SQL to be executed.
  534. * @return array The fetched row as an array
  535. */
  536. public function fetchRow($sql = null) {
  537. if (is_string($sql) && strlen($sql) > 5 && !$this->execute($sql)) {
  538. return null;
  539. }
  540. if ($this->hasResult()) {
  541. $this->resultSet($this->_result);
  542. $resultRow = $this->fetchResult();
  543. if (isset($resultRow[0])) {
  544. $this->fetchVirtualField($resultRow);
  545. }
  546. return $resultRow;
  547. } else {
  548. return null;
  549. }
  550. }
  551. /**
  552. * Returns an array of all result rows for a given SQL query.
  553. * Returns false if no rows matched.
  554. *
  555. *
  556. * ### Options
  557. *
  558. * - `cache` - Returns the cached version of the query, if exists and stores the result in cache.
  559. * This is a non-persistent cache, and only lasts for a single request. This option
  560. * defaults to true. If you are directly calling this method, you can disable caching
  561. * by setting $options to `false`
  562. *
  563. * @param string $sql SQL statement
  564. * @param array $params parameters to be bound as values for the SQL statement
  565. * @param array $options additional options for the query.
  566. * @return array Array of resultset rows, or false if no rows matched
  567. */
  568. public function fetchAll($sql, $params = array(), $options = array()) {
  569. if (is_string($options)) {
  570. $options = array('modelName' => $options);
  571. }
  572. if (is_bool($params)) {
  573. $options['cache'] = $params;
  574. $params = array();
  575. }
  576. $options += array('cache' => true);
  577. $cache = $options['cache'];
  578. if ($cache && ($cached = $this->getQueryCache($sql, $params)) !== false) {
  579. return $cached;
  580. }
  581. if ($result = $this->execute($sql, array(), $params)) {
  582. $out = array();
  583. if ($this->hasResult()) {
  584. $first = $this->fetchRow();
  585. if ($first != null) {
  586. $out[] = $first;
  587. }
  588. while ($item = $this->fetchResult()) {
  589. if (isset($item[0])) {
  590. $this->fetchVirtualField($item);
  591. }
  592. $out[] = $item;
  593. }
  594. }
  595. if (!is_bool($result) && $cache) {
  596. $this->_writeQueryCache($sql, $out, $params);
  597. }
  598. if (empty($out) && is_bool($this->_result)) {
  599. return $this->_result;
  600. }
  601. return $out;
  602. }
  603. return false;
  604. }
  605. /**
  606. * Fetches the next row from the current result set
  607. *
  608. * @return boolean
  609. */
  610. public function fetchResult() {
  611. return false;
  612. }
  613. /**
  614. * Modifies $result array to place virtual fields in model entry where they belongs to
  615. *
  616. * @param array $result Reference to the fetched row
  617. * @return void
  618. */
  619. public function fetchVirtualField(&$result) {
  620. if (isset($result[0]) && is_array($result[0])) {
  621. foreach ($result[0] as $field => $value) {
  622. if (strpos($field, $this->virtualFieldSeparator) === false) {
  623. continue;
  624. }
  625. list($alias, $virtual) = explode($this->virtualFieldSeparator, $field);
  626. if (!ClassRegistry::isKeySet($alias)) {
  627. return;
  628. }
  629. $model = ClassRegistry::getObject($alias);
  630. if ($model->isVirtualField($virtual)) {
  631. $result[$alias][$virtual] = $value;
  632. unset($result[0][$field]);
  633. }
  634. }
  635. if (empty($result[0])) {
  636. unset($result[0]);
  637. }
  638. }
  639. }
  640. /**
  641. * Returns a single field of the first of query results for a given SQL query, or false if empty.
  642. *
  643. * @param string $name Name of the field
  644. * @param string $sql SQL query
  645. * @return mixed Value of field read.
  646. */
  647. public function field($name, $sql) {
  648. $data = $this->fetchRow($sql);
  649. if (empty($data[$name])) {
  650. return false;
  651. }
  652. return $data[$name];
  653. }
  654. /**
  655. * Empties the method caches.
  656. * These caches are used by DboSource::name() and DboSource::conditions()
  657. *
  658. * @return void
  659. */
  660. public function flushMethodCache() {
  661. $this->_methodCacheChange = true;
  662. self::$methodCache = array();
  663. }
  664. /**
  665. * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods.
  666. * Will retrieve a value from the cache if $value is null.
  667. *
  668. * If caching is disabled and a write is attempted, the $value will be returned.
  669. * A read will either return the value or null.
  670. *
  671. * @param string $method Name of the method being cached.
  672. * @param string $key The key name for the cache operation.
  673. * @param mixed $value The value to cache into memory.
  674. * @return mixed Either null on failure, or the value if its set.
  675. */
  676. public function cacheMethod($method, $key, $value = null) {
  677. if ($this->cacheMethods === false) {
  678. return $value;
  679. }
  680. if (empty(self::$methodCache)) {
  681. self::$methodCache = Cache::read('method_cache', '_cake_core_');
  682. }
  683. if ($value === null) {
  684. return (isset(self::$methodCache[$method][$key])) ? self::$methodCache[$method][$key] : null;
  685. }
  686. $this->_methodCacheChange = true;
  687. return self::$methodCache[$method][$key] = $value;
  688. }
  689. /**
  690. * Returns a quoted name of $data for use in an SQL statement.
  691. * Strips fields out of SQL functions before quoting.
  692. *
  693. * Results of this method are stored in a memory cache. This improves performance, but
  694. * because the method uses a simple hashing algorithm it can infrequently have collisions.
  695. * Setting DboSource::$cacheMethods to false will disable the memory cache.
  696. *
  697. * @param mixed $data Either a string with a column to quote. An array of columns to quote or an
  698. * object from DboSource::expression() or DboSource::identifier()
  699. * @return string SQL field
  700. */
  701. public function name($data) {
  702. if (is_object($data) && isset($data->type)) {
  703. return $data->value;
  704. }
  705. if ($data === '*') {
  706. return '*';
  707. }
  708. if (is_array($data)) {
  709. foreach ($data as $i => $dataItem) {
  710. $data[$i] = $this->name($dataItem);
  711. }
  712. return $data;
  713. }
  714. $cacheKey = crc32($this->startQuote . $data . $this->endQuote);
  715. if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
  716. return $return;
  717. }
  718. $data = trim($data);
  719. if (preg_match('/^[\w-]+(?:\.[^ \*]*)*$/', $data)) { // string, string.string
  720. if (strpos($data, '.') === false) { // string
  721. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  722. }
  723. $items = explode('.', $data);
  724. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  725. $this->startQuote . implode($this->endQuote . '.' . $this->startQuote, $items) . $this->endQuote
  726. );
  727. }
  728. if (preg_match('/^[\w-]+\.\*$/', $data)) { // string.*
  729. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  730. $this->startQuote . str_replace('.*', $this->endQuote . '.*', $data)
  731. );
  732. }
  733. if (preg_match('/^([\w-]+)\((.*)\)$/', $data, $matches)) { // Functions
  734. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  735. $matches[1] . '(' . $this->name($matches[2]) . ')'
  736. );
  737. }
  738. if (
  739. preg_match('/^([\w-]+(\.[\w-]+|\(.*\))*)\s+' . preg_quote($this->alias) . '\s*([\w-]+)$/i', $data, $matches
  740. )) {
  741. return $this->cacheMethod(
  742. __FUNCTION__, $cacheKey,
  743. preg_replace(
  744. '/\s{2,}/', ' ', $this->name($matches[1]) . ' ' . $this->alias . ' ' . $this->name($matches[3])
  745. )
  746. );
  747. }
  748. if (preg_match('/^[\w-_\s]*[\w-_]+/', $data)) {
  749. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  750. }
  751. return $this->cacheMethod(__FUNCTION__, $cacheKey, $data);
  752. }
  753. /**
  754. * Checks if the source is connected to the database.
  755. *
  756. * @return boolean True if the database is connected, else false
  757. */
  758. public function isConnected() {
  759. return $this->connected;
  760. }
  761. /**
  762. * Checks if the result is valid
  763. *
  764. * @return boolean True if the result is valid else false
  765. */
  766. public function hasResult() {
  767. return is_a($this->_result, 'PDOStatement');
  768. }
  769. /**
  770. * Get the query log as an array.
  771. *
  772. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  773. * @param boolean $clear If True the existing log will cleared.
  774. * @return array Array of queries run as an array
  775. */
  776. public function getLog($sorted = false, $clear = true) {
  777. if ($sorted) {
  778. $log = sortByKey($this->_queriesLog, 'took', 'desc', SORT_NUMERIC);
  779. } else {
  780. $log = $this->_queriesLog;
  781. }
  782. if ($clear) {
  783. $this->_queriesLog = array();
  784. }
  785. return array('log' => $log, 'count' => $this->_queriesCnt, 'time' => $this->_queriesTime);
  786. }
  787. /**
  788. * Outputs the contents of the queries log. If in a non-CLI environment the sql_log element
  789. * will be rendered and output. If in a CLI environment, a plain text log is generated.
  790. *
  791. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  792. * @return void
  793. */
  794. public function showLog($sorted = false) {
  795. $log = $this->getLog($sorted, false);
  796. if (empty($log['log'])) {
  797. return;
  798. }
  799. if (PHP_SAPI != 'cli') {
  800. $controller = null;
  801. $View = new View($controller, false);
  802. $View->set('logs', array($this->configKeyName => $log));
  803. echo $View->element('sql_dump', array('_forced_from_dbo_' => true));
  804. } else {
  805. foreach ($log['log'] as $k => $i) {
  806. print (($k + 1) . ". {$i['query']}\n");
  807. }
  808. }
  809. }
  810. /**
  811. * Log given SQL query.
  812. *
  813. * @param string $sql SQL statement
  814. * @return void
  815. */
  816. public function logQuery($sql) {
  817. $this->_queriesCnt++;
  818. $this->_queriesTime += $this->took;
  819. $this->_queriesLog[] = array(
  820. 'query' => $sql,
  821. 'affected' => $this->affected,
  822. 'numRows' => $this->numRows,
  823. 'took' => $this->took
  824. );
  825. if (count($this->_queriesLog) > $this->_queriesLogMax) {
  826. array_pop($this->_queriesLog);
  827. }
  828. }
  829. /**
  830. * Gets full table name including prefix
  831. *
  832. * @param mixed $model Either a Model object or a string table name.
  833. * @param boolean $quote Whether you want the table name quoted.
  834. * @return string Full quoted table name
  835. */
  836. public function fullTableName($model, $quote = true) {
  837. if (is_object($model)) {
  838. $table = $model->tablePrefix . $model->table;
  839. } elseif (isset($this->config['prefix'])) {
  840. $table = $this->config['prefix'] . strval($model);
  841. } else {
  842. $table = strval($model);
  843. }
  844. if ($quote) {
  845. return $this->name($table);
  846. }
  847. return $table;
  848. }
  849. /**
  850. * The "C" in CRUD
  851. *
  852. * Creates new records in the database.
  853. *
  854. * @param Model $model Model object that the record is for.
  855. * @param array $fields An array of field names to insert. If null, $model->data will be
  856. * used to generate field names.
  857. * @param array $values An array of values with keys matching the fields. If null, $model->data will
  858. * be used to generate values.
  859. * @return boolean Success
  860. */
  861. public function create(Model $model, $fields = null, $values = null) {
  862. $id = null;
  863. if ($fields == null) {
  864. unset($fields, $values);
  865. $fields = array_keys($model->data);
  866. $values = array_values($model->data);
  867. }
  868. $count = count($fields);
  869. for ($i = 0; $i < $count; $i++) {
  870. $valueInsert[] = $this->value($values[$i], $model->getColumnType($fields[$i]));
  871. $fieldInsert[] = $this->name($fields[$i]);
  872. if ($fields[$i] == $model->primaryKey) {
  873. $id = $values[$i];
  874. }
  875. }
  876. $query = array(
  877. 'table' => $this->fullTableName($model),
  878. 'fields' => implode(', ', $fieldInsert),
  879. 'values' => implode(', ', $valueInsert)
  880. );
  881. if ($this->execute($this->renderStatement('create', $query))) {
  882. if (empty($id)) {
  883. $id = $this->lastInsertId($this->fullTableName($model, false), $model->primaryKey);
  884. }
  885. $model->setInsertID($id);
  886. $model->id = $id;
  887. return true;
  888. }
  889. $model->onError();
  890. return false;
  891. }
  892. /**
  893. * The "R" in CRUD
  894. *
  895. * Reads record(s) from the database.
  896. *
  897. * @param Model $model A Model object that the query is for.
  898. * @param array $queryData An array of queryData information containing keys similar to Model::find()
  899. * @param integer $recursive Number of levels of association
  900. * @return mixed boolean false on error/failure. An array of results on success.
  901. */
  902. public function read(Model $model, $queryData = array(), $recursive = null) {
  903. $queryData = $this->_scrubQueryData($queryData);
  904. $null = null;
  905. $array = array('callbacks' => $queryData['callbacks']);
  906. $linkedModels = array();
  907. $bypass = false;
  908. if ($recursive === null && isset($queryData['recursive'])) {
  909. $recursive = $queryData['recursive'];
  910. }
  911. if (!is_null($recursive)) {
  912. $_recursive = $model->recursive;
  913. $model->recursive = $recursive;
  914. }
  915. if (!empty($queryData['fields'])) {
  916. $bypass = true;
  917. $queryData['fields'] = $this->fields($model, null, $queryData['fields']);
  918. } else {
  919. $queryData['fields'] = $this->fields($model);
  920. }
  921. $_associations = $model->associations();
  922. if ($model->recursive == -1) {
  923. $_associations = array();
  924. } elseif ($model->recursive == 0) {
  925. unset($_associations[2], $_associations[3]);
  926. }
  927. foreach ($_associations as $type) {
  928. foreach ($model->{$type} as $assoc => $assocData) {
  929. $linkModel = $model->{$assoc};
  930. $external = isset($assocData['external']);
  931. $linkModel->getDataSource();
  932. if ($model->useDbConfig === $linkModel->useDbConfig) {
  933. if ($bypass) {
  934. $assocData['fields'] = false;
  935. }
  936. if (true === $this->generateAssociationQuery($model, $linkModel, $type, $assoc, $assocData, $queryData, $external, $null)) {
  937. $linkedModels[$type . '/' . $assoc] = true;
  938. }
  939. }
  940. }
  941. }
  942. $query = trim($this->generateAssociationQuery($model, null, null, null, null, $queryData, false, $null));
  943. $resultSet = $this->fetchAll($query, $model->cacheQueries);
  944. if ($resultSet === false) {
  945. $model->onError();
  946. return false;
  947. }
  948. $filtered = array();
  949. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  950. $filtered = $this->_filterResults($resultSet, $model);
  951. }
  952. if ($model->recursive > -1) {
  953. foreach ($_associations as $type) {
  954. foreach ($model->{$type} as $assoc => $assocData) {
  955. $linkModel = $model->{$assoc};
  956. if (!isset($linkedModels[$type . '/' . $assoc])) {
  957. if ($model->useDbConfig === $linkModel->useDbConfig) {
  958. $db = $this;
  959. } else {
  960. $db = ConnectionManager::getDataSource($linkModel->useDbConfig);
  961. }
  962. } elseif ($model->recursive > 1 && ($type === 'belongsTo' || $type === 'hasOne')) {
  963. $db = $this;
  964. }
  965. if (isset($db) && method_exists($db, 'queryAssociation')) {
  966. $stack = array($assoc);
  967. $db->queryAssociation($model, $linkModel, $type, $assoc, $assocData, $array, true, $resultSet, $model->recursive - 1, $stack);
  968. unset($db);
  969. if ($type === 'hasMany') {
  970. $filtered[] = $assoc;
  971. }
  972. }
  973. }
  974. }
  975. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  976. $this->_filterResults($resultSet, $model, $filtered);
  977. }
  978. }
  979. if (!is_null($recursive)) {
  980. $model->recursive = $_recursive;
  981. }
  982. return $resultSet;
  983. }
  984. /**
  985. * Passes association results thru afterFind filters of corresponding model
  986. *
  987. * @param array $results Reference of resultset to be filtered
  988. * @param Model $model Instance of model to operate against
  989. * @param array $filtered List of classes already filtered, to be skipped
  990. * @return array Array of results that have been filtered through $model->afterFind
  991. */
  992. protected function _filterResults(&$results, Model $model, $filtered = array()) {
  993. $current = current($results);
  994. if (!is_array($current)) {
  995. return array();
  996. }
  997. $keys = array_diff(array_keys($current), $filtered, array($model->alias));
  998. $filtering = array();
  999. foreach ($keys as $className) {
  1000. if (!isset($model->{$className}) || !is_object($model->{$className})) {
  1001. continue;
  1002. }
  1003. $linkedModel = $model->{$className};
  1004. $filtering[] = $className;
  1005. foreach ($results as &$result) {
  1006. $data = $linkedModel->afterFind(array(array($className => $result[$className])), false);
  1007. if (isset($data[0][$className])) {
  1008. $result[$className] = $data[0][$className];
  1009. }
  1010. }
  1011. }
  1012. return $filtering;
  1013. }
  1014. /**
  1015. * Queries associations. Used to fetch results on recursive models.
  1016. *
  1017. * @param Model $model Primary Model object
  1018. * @param Model $linkModel Linked model that
  1019. * @param string $type Association type, one of the model association types ie. hasMany
  1020. * @param string $association
  1021. * @param array $assocData
  1022. * @param array $queryData
  1023. * @param boolean $external Whether or not the association query is on an external datasource.
  1024. * @param array $resultSet Existing results
  1025. * @param integer $recursive Number of levels of association
  1026. * @param array $stack
  1027. * @return mixed
  1028. */
  1029. public function queryAssociation($model, &$linkModel, $type, $association, $assocData, &$queryData, $external = false, &$resultSet, $recursive, $stack) {
  1030. if ($query = $this->generateAssociationQuery($model, $linkModel, $type, $association, $assocData, $queryData, $external, $resultSet)) {
  1031. if (!is_array($resultSet)) {
  1032. throw new CakeException(__d('cake_dev', 'Error in Model %s', get_class($model)));
  1033. }
  1034. if ($type === 'hasMany' && empty($assocData['limit']) && !empty($assocData['foreignKey'])) {
  1035. $ins = $fetch = array();
  1036. foreach ($resultSet as &$result) {
  1037. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1038. $ins[] = $in;
  1039. }
  1040. }
  1041. if (!empty($ins)) {
  1042. $ins = array_unique($ins);
  1043. $fetch = $this->fetchAssociated($model, $query, $ins);
  1044. }
  1045. if (!empty($fetch) && is_array($fetch)) {
  1046. if ($recursive > 0) {
  1047. foreach ($linkModel->associations() as $type1) {
  1048. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1049. $deepModel = $linkModel->{$assoc1};
  1050. $tmpStack = $stack;
  1051. $tmpStack[] = $assoc1;
  1052. if ($linkModel->useDbConfig === $deepModel->useDbConfig) {
  1053. $db = $this;
  1054. } else {
  1055. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1056. }
  1057. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1058. }
  1059. }
  1060. }
  1061. }
  1062. if ($queryData['callbacks'] === true || $queryData['callbacks'] === 'after') {
  1063. $this->_filterResults($fetch, $model);
  1064. }
  1065. return $this->_mergeHasMany($resultSet, $fetch, $association, $model, $linkModel);
  1066. } elseif ($type === 'hasAndBelongsToMany') {
  1067. $ins = $fetch = array();
  1068. foreach ($resultSet as &$result) {
  1069. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1070. $ins[] = $in;
  1071. }
  1072. }
  1073. if (!empty($ins)) {
  1074. $ins = array_unique($ins);
  1075. if (count($ins) > 1) {
  1076. $query = str_replace('{$__cakeID__$}', '(' .implode(', ', $ins) .')', $query);
  1077. $query = str_replace('= (', 'IN (', $query);
  1078. } else {
  1079. $query = str_replace('{$__cakeID__$}', $ins[0], $query);
  1080. }
  1081. $query = str_replace(' WHERE 1 = 1', '', $query);
  1082. }
  1083. $foreignKey = $model->hasAndBelongsToMany[$association]['foreignKey'];
  1084. $joinKeys = array($foreignKey, $model->hasAndBelongsToMany[$association]['associationForeignKey']);
  1085. list($with, $habtmFields) = $model->joinModel($model->hasAndBelongsToMany[$association]['with'], $joinKeys);
  1086. $habtmFieldsCount = count($habtmFields);
  1087. $q = $this->insertQueryData($query, null, $association, $assocData, $model, $linkModel, $stack);
  1088. if ($q !== false) {
  1089. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1090. } else {
  1091. $fetch = null;
  1092. }
  1093. }
  1094. $modelAlias = $model->alias;
  1095. $modelPK = $model->primaryKey;
  1096. foreach ($resultSet as &$row) {
  1097. if ($type !== 'hasAndBelongsToMany') {
  1098. $q = $this->insertQueryData($query, $row, $association, $assocData, $model, $linkModel, $stack);
  1099. if ($q !== false) {
  1100. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1101. } else {
  1102. $fetch = null;
  1103. }
  1104. }
  1105. $selfJoin = $linkModel->name === $model->name;
  1106. if (!empty($fetch) && is_array($fetch)) {
  1107. if ($recursive > 0) {
  1108. foreach ($linkModel->associations() as $type1) {
  1109. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1110. $deepModel = $linkModel->{$assoc1};
  1111. if ($type1 === 'belongsTo' || ($deepModel->alias === $modelAlias && $type === 'belongsTo') || ($deepModel->alias !== $modelAlias)) {
  1112. $tmpStack = $stack;
  1113. $tmpStack[] = $assoc1;
  1114. if ($linkModel->useDbConfig == $deepModel->useDbConfig) {
  1115. $db = $this;
  1116. } else {
  1117. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1118. }
  1119. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1120. }
  1121. }
  1122. }
  1123. }
  1124. if ($type === 'hasAndBelongsToMany') {
  1125. $uniqueIds = $merge = array();
  1126. foreach ($fetch as $j => $data) {
  1127. if (isset($data[$with]) && $data[$with][$foreignKey] === $row[$modelAlias][$modelPK]) {
  1128. if ($habtmFieldsCount <= 2) {
  1129. unset($data[$with]);
  1130. }
  1131. $merge[] = $data;
  1132. }
  1133. }
  1134. if (empty($merge) && !isset($row[$association])) {
  1135. $row[$association] = $merge;
  1136. } else {
  1137. $this->_mergeAssociation($row, $merge, $association, $type);
  1138. }
  1139. } else {
  1140. $this->_mergeAssociation($row, $fetch, $association, $type, $selfJoin);
  1141. }
  1142. if (isset($row[$association])) {
  1143. $row[$association] = $linkModel->afterFind($row[$association], false);
  1144. }
  1145. } else {
  1146. $tempArray[0][$association] = false;
  1147. $this->_mergeAssociation($row, $tempArray, $association, $type, $selfJoin);
  1148. }
  1149. }
  1150. }
  1151. }
  1152. /**
  1153. * A more efficient way to fetch associations. Woohoo!
  1154. *
  1155. * @param Model $model Primary model object
  1156. * @param string $query Association query
  1157. * @param array $ids Array of IDs of associated records
  1158. * @return array Association results
  1159. */
  1160. public function fetchAssociated($model, $query, $ids) {
  1161. $query = str_replace('{$__cakeID__$}', implode(', ', $ids), $query);
  1162. if (count($ids) > 1) {
  1163. $query = str_replace('= (', 'IN (', $query);
  1164. }
  1165. return $this->fetchAll($query, $model->cacheQueries);
  1166. }
  1167. /**
  1168. * mergeHasMany - Merge the results of hasMany relations.
  1169. *
  1170. *
  1171. * @param array $resultSet Data to merge into
  1172. * @param array $merge Data to merge
  1173. * @param string $association Name of Model being Merged
  1174. * @param Model $model Model being merged onto
  1175. * @param Model $linkModel Model being merged
  1176. * @return void
  1177. */
  1178. protected function _mergeHasMany(&$resultSet, $merge, $association, $model, $linkModel) {
  1179. $modelAlias = $model->alias;
  1180. $modelPK = $model->primaryKey;
  1181. $modelFK = $model->hasMany[$association]['foreignKey'];
  1182. foreach ($resultSet as &$result) {
  1183. if (!isset($result[$modelAlias])) {
  1184. continue;
  1185. }
  1186. $merged = array();
  1187. foreach ($merge as $data) {
  1188. if ($result[$modelAlias][$modelPK] === $data[$association][$modelFK]) {
  1189. if (count($data) > 1) {
  1190. $data = array_merge($data[$association], $data);
  1191. unset($data[$association]);
  1192. foreach ($data as $key => $name) {
  1193. if (is_numeric($key)) {
  1194. $data[$association][] = $name;
  1195. unset($data[$key]);
  1196. }
  1197. }
  1198. $merged[] = $data;
  1199. } else {
  1200. $merged[] = $data[$association];
  1201. }
  1202. }
  1203. }
  1204. $result = Set::pushDiff($result, array($association => $merged));
  1205. }
  1206. }
  1207. /**
  1208. * Merge association of merge into data
  1209. *
  1210. * @param array $data
  1211. * @param array $merge
  1212. * @param string $association
  1213. * @param string $type
  1214. * @param boolean $selfJoin
  1215. * @return void
  1216. */
  1217. protected function _mergeAssociation(&$data, &$merge, $association, $type, $selfJoin = false) {
  1218. if (isset($merge[0]) && !isset($merge[0][$association])) {
  1219. $association = Inflector::pluralize($association);
  1220. }
  1221. if ($type === 'belongsTo' || $type === 'hasOne') {
  1222. if (isset($merge[$association])) {
  1223. $data[$association] = $merge[$association][0];
  1224. } else {
  1225. if (count($merge[0][$association]) > 1) {
  1226. foreach ($merge[0] as $assoc => $data2) {
  1227. if ($assoc !== $association) {
  1228. $merge[0][$association][$assoc] = $data2;
  1229. }
  1230. }
  1231. }
  1232. if (!isset($data[$association])) {
  1233. if ($merge[0][$association] != null) {
  1234. $data[$association] = $merge[0][$association];
  1235. } else {
  1236. $data[$association] = array();
  1237. }
  1238. } else {
  1239. if (is_array($merge[0][$association])) {
  1240. foreach ($data[$association] as $k => $v) {
  1241. if (!is_array($v)) {
  1242. $dataAssocTmp[$k] = $v;
  1243. }
  1244. }
  1245. foreach ($merge[0][$association] as $k => $v) {
  1246. if (!is_array($v)) {
  1247. $mergeAssocTmp[$k] = $v;
  1248. }
  1249. }
  1250. $dataKeys = array_keys($data);
  1251. $mergeKeys = array_keys($merge[0]);
  1252. if ($mergeKeys[0] === $dataKeys[0] || $mergeKeys === $dataKeys) {
  1253. $data[$association][$association] = $merge[0][$association];
  1254. } else {
  1255. $diff = Set::diff($dataAssocTmp, $mergeAssocTmp);
  1256. $data[$association] = array_merge($merge[0][$association], $diff);
  1257. }
  1258. } elseif ($selfJoin && array_key_exists($association, $merge[0])) {
  1259. $data[$association] = array_merge($data[$association], array($association => array()));
  1260. }
  1261. }
  1262. }
  1263. } else {
  1264. if (isset($merge[0][$association]) && $merge[0][$association] === false) {
  1265. if (!isset($data[$association])) {
  1266. $data[$association] = array();
  1267. }
  1268. } else {
  1269. foreach ($merge as $i => $row) {
  1270. if (count($row) === 1) {
  1271. if (empty($data[$association]) || (isset($data[$association]) && !in_array($row[$association], $data[$association]))) {
  1272. $data[$association][] = $row[$association];
  1273. }
  1274. } elseif (!empty($row)) {
  1275. $tmp = array_merge($row[$association], $row);
  1276. unset($tmp[$association]);
  1277. $data[$association][] = $tmp;
  1278. }
  1279. }
  1280. }
  1281. }
  1282. }
  1283. /**
  1284. * Generates an array representing a query or part of a query from a single model or two associated models
  1285. *
  1286. * @param Model $model
  1287. * @param Model $linkModel
  1288. * @param string $type
  1289. * @param string $association
  1290. * @param array $assocData
  1291. * @param array $queryData
  1292. * @param boolean $external
  1293. * @param array $resultSet
  1294. * @return mixed
  1295. */
  1296. public function generateAssociationQuery($model, $linkModel, $type, $association = null, $assocData = array(), &$queryData, $external = false, &$resultSet) {
  1297. $queryData = $this->_scrubQueryData($queryData);
  1298. $assocData = $this->_scrubQueryData($assocData);
  1299. $modelAlias = $model->alias;
  1300. if (empty($queryData['fields'])) {
  1301. $queryData['fields'] = $this->fields($model, $modelAlias);
  1302. } elseif (!empty($model->hasMany) && $model->recursive > -1) {
  1303. $assocFields = $this->fields($model, $modelAlias, array("{$modelAlias}.{$model->primaryKey}"));
  1304. $passedFields = $queryData['fields'];
  1305. if (count($passedFields) === 1) {
  1306. if (strpos($passedFields[0], $assocFields[0]) === false && !preg_match('/^[a-z]+\(/i', $passedFields[0])) {
  1307. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1308. } else {
  1309. $queryData['fields'] = $passedFields;
  1310. }
  1311. } else {
  1312. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1313. }
  1314. unset($assocFields, $passedFields);
  1315. }
  1316. if ($linkModel === null) {
  1317. return $this->buildStatement(
  1318. array(
  1319. 'fields' => array_unique($queryData['fields']),
  1320. 'table' => $this->fullTableName($model),
  1321. 'alias' => $modelAlias,
  1322. 'limit' => $queryData['limit'],
  1323. 'offset' => $queryData['offset'],
  1324. 'joins' => $queryData['joins'],
  1325. 'conditions' => $queryData['conditions'],
  1326. 'order' => $queryData['order'],
  1327. 'group' => $queryData['group']
  1328. ),
  1329. $model
  1330. );
  1331. }
  1332. if ($external && !empty($assocData['finderQuery'])) {
  1333. return $assocData['finderQuery'];
  1334. }
  1335. $self = $model->name === $linkModel->name;
  1336. $fields = array();
  1337. if ($external || (in_array($type, array('hasOne', 'belongsTo')) && $assocData['fields'] !== false)) {
  1338. $fields = $this->fields($linkModel, $association, $assocData['fields']);
  1339. }
  1340. if (empty($assocData['offset']) && !empty($assocData['page'])) {
  1341. $assocData['offset'] = ($assocData['page'] - 1) * $assocData['limit'];
  1342. }
  1343. $assocData['limit'] = $this->limit($assocData['limit'], $assocData['offset']);
  1344. switch ($type) {
  1345. case 'hasOne':
  1346. case 'belongsTo':
  1347. $conditions = $this->_mergeConditions(
  1348. $assocData['conditions'],
  1349. $this->getConstraint($type, $model, $linkModel, $association, array_merge($assocData, compact('external', 'self')))
  1350. );
  1351. if (!$self && $external) {
  1352. foreach ($conditions as $key => $condition) {
  1353. if (is_numeric($key) && strpos($condition, $modelAlias . '.') !== false) {
  1354. unset($conditions[$key]);
  1355. }
  1356. }
  1357. }
  1358. if ($external) {
  1359. $query = array_merge($assocData, array(
  1360. 'conditions' => $conditions,
  1361. 'table' => $this->fullTableName($linkModel),
  1362. 'fields' => $fields,
  1363. 'alias' => $association,
  1364. 'group' => null
  1365. ));
  1366. $query += array('order' => $assocData['order'], 'limit' => $assocData['limit']);
  1367. } else {
  1368. $join = array(
  1369. 'table' => $linkModel,
  1370. 'alias' => $association,
  1371. 'type' => isset($assocData['type']) ? $assocData['type'] : 'LEFT',
  1372. 'conditions' => trim($this->conditions($conditions, true, false, $model))
  1373. );
  1374. $queryData['fields'] = array_merge($queryData['fields'], $fields);
  1375. if (!empty($assocData['order'])) {
  1376. $queryData['order'][] = $assocData['order'];
  1377. }
  1378. if (!in_array($join, $queryData['joins'])) {
  1379. $queryData['joins'][] = $join;
  1380. }
  1381. return true;
  1382. }
  1383. break;
  1384. case 'hasMany':
  1385. $assocData['fields'] = $this->fields($linkModel, $association, $assocData['fields']);
  1386. if (!empty($assocData['foreignKey'])) {
  1387. $assocData['fields'] = array_merge($assocData['fields'], $this->fields($linkModel, $association, array("{$association}.{$assocData['foreignKey']}")));
  1388. }
  1389. $query = array(
  1390. 'conditions' => $this->_mergeConditions($this->getConstraint('hasMany', $model, $linkModel, $association, $assocData), $assocData['conditions']),
  1391. 'fields' => array_unique($assocData['fields']),
  1392. 'table' => $this->fullTableName($linkModel),
  1393. 'alias' => $association,
  1394. 'order' => $assocData['order'],
  1395. 'limit' => $assocData['limit'],
  1396. 'group' => null
  1397. );
  1398. break;
  1399. case 'hasAndBelongsToMany':
  1400. $joinFields = array();
  1401. $joinAssoc = null;
  1402. if (isset($assocData['with']) && !empty($assocData['with'])) {
  1403. $joinKeys = array($assocData['foreignKey'], $assocData['associationForeignKey']);
  1404. list($with, $joinFields) = $model->joinModel($assocData['with'], $joinKeys);
  1405. $joinTbl = $model->{$with};
  1406. $joinAlias = $joinTbl;
  1407. if (is_array($joinFields) && !empty($joinFields)) {
  1408. $joinAssoc = $joinAlias = $model->{$with}->alias;
  1409. $joinFields = $this->fields($model->{$with}, $joinAlias, $joinFields);
  1410. } else {
  1411. $joinFields = array();
  1412. }
  1413. } else {
  1414. $joinTbl = $assocData['joinTable'];
  1415. $joinAlias = $this->fullTableName($assocData['joinTable']);
  1416. }
  1417. $query = array(
  1418. 'conditions' => $assocData['conditions'],
  1419. 'limit' => $assocData['limit'],
  1420. 'table' => $this->fullTableName($linkModel),
  1421. 'alias' => $association,
  1422. 'fields' => array_merge($this->fields($linkModel, $association, $assocData['fields']), $joinFields),
  1423. 'order' => $assocData['order'],
  1424. 'group' => null,
  1425. 'joins' => array(array(
  1426. 'table' => $joinTbl,
  1427. 'alias' => $joinAssoc,
  1428. 'conditions' => $this->getConstraint('hasAndBelongsToMany', $model, $linkModel, $joinAlias, $assocData, $association)
  1429. ))
  1430. );
  1431. break;
  1432. }
  1433. if (isset($query)) {
  1434. return $this->buildStatement($query, $model);
  1435. }
  1436. return null;
  1437. }
  1438. /**
  1439. * Returns a conditions array for the constraint between two models
  1440. *
  1441. * @param string $type Association type
  1442. * @param Model $model Model object
  1443. * @param string $linkModel
  1444. * @param string $alias
  1445. * @param array $assoc
  1446. * @param string $alias2
  1447. * @return array Conditions array defining the constraint between $model and $association
  1448. */
  1449. public function getConstraint($type, $model, $linkModel, $alias, $assoc, $alias2 = null) {
  1450. $assoc += array('external' => false, 'self' => false);
  1451. if (empty($assoc['foreignKey'])) {
  1452. return array();
  1453. }
  1454. switch (true) {
  1455. case ($assoc['external'] && $type === 'hasOne'):
  1456. return array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}');
  1457. case ($assoc['external'] && $type === 'belongsTo'):
  1458. return array("{$alias}.{$linkModel->primaryKey}" => '{$__cakeForeignKey__$}');
  1459. case (!$assoc['external'] && $type === 'hasOne'):
  1460. return array("{$alias}.{$assoc['foreignKey']}" => $this->identifier("{$model->alias}.{$model->primaryKey}"));
  1461. case (!$assoc['external'] && $type === 'belongsTo'):
  1462. return array("{$model->alias}.{$assoc['foreignKey']}" => $this->identifier("{$alias}.{$linkModel->primaryKey}"));
  1463. case ($type === 'hasMany'):
  1464. return array("{$alias}.{$assoc['foreignKey']}" => array('{$__cakeID__$}'));
  1465. case ($type === 'hasAndBelongsToMany'):
  1466. return array(
  1467. array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}'),
  1468. array("{$alias}.{$assoc['associationForeignKey']}" => $this->identifier("{$alias2}.{$linkModel->primaryKey}"))
  1469. );
  1470. }
  1471. return array();
  1472. }
  1473. /**
  1474. * Builds and generates a JOIN statement from an array. Handles final clean-up before conversion.
  1475. *
  1476. * @param array $join An array defining a JOIN statement in a query
  1477. * @return string An SQL JOIN statement to be used in a query
  1478. * @see DboSource::renderJoinStatement()
  1479. * @see DboSource::buildStatement()
  1480. */
  1481. public function buildJoinStatement($join) {
  1482. $data = array_merge(array(
  1483. 'type' => null,
  1484. 'alias' => null,
  1485. 'table' => 'join_table',
  1486. 'conditions' => array()
  1487. ), $join);
  1488. if (!empty($data['alias'])) {
  1489. $data['alias'] = $this->alias . $this->name($data['alias']);
  1490. }
  1491. if (!empty($data['conditions'])) {
  1492. $data['conditions'] = trim($this->conditions($data['conditions'], true, false));
  1493. }
  1494. if (!empty($data['table'])) {
  1495. $data['table'] = $this->fullTableName($data['table']);
  1496. }
  1497. return $this->renderJoinStatement($data);
  1498. }
  1499. /**
  1500. * Builds and generates an SQL statement from an array. Handles final clean-up before conversion.
  1501. *
  1502. * @param array $query An array defining an SQL query
  1503. * @param Model $model The model object which initiated the query
  1504. * @return string An executable SQL statement
  1505. * @see DboSource::renderStatement()
  1506. */
  1507. public function buildStatement($query, $model) {
  1508. $query = array_merge(array('offset' => null, 'joins' => array()), $query);
  1509. if (!empty($query['joins'])) {
  1510. $count = count($query['joins']);
  1511. for ($i = 0; $i < $count; $i++) {
  1512. if (is_array($query['joins'][$i])) {
  1513. $query['joins'][$i] = $this->buildJoinStatement($query['joins'][$i]);
  1514. }
  1515. }
  1516. }
  1517. return $this->renderStatement('select', array(
  1518. 'conditions' => $this->conditions($query['conditions'], true, true, $model),
  1519. 'fields' => implode(', ', $query['fields']),
  1520. 'table' => $query['table'],
  1521. 'alias' => $this->alias . $this->name($query['alias']),
  1522. 'order' => $this->order($query['order'], 'ASC', $model),
  1523. 'limit' => $this->limit($query['limit'], $query['offset']),
  1524. 'joins' => implode(' ', $query['joins']),
  1525. 'group' => $this->group($query['group'], $model)
  1526. ));
  1527. }
  1528. /**
  1529. * Renders a final SQL JOIN statement
  1530. *
  1531. * @param array $data
  1532. * @return string
  1533. */
  1534. public function renderJoinStatement($data) {
  1535. extract($data);
  1536. return trim("{$type} JOIN {$table} {$alias} ON ({$conditions})");
  1537. }
  1538. /**
  1539. * Renders a final SQL statement by putting together the component parts in the correct order
  1540. *
  1541. * @param string $type type of query being run. e.g select, create, update, delete, schema, alter.
  1542. * @param array $data Array of data to insert into the query.
  1543. * @return string Rendered SQL expression to be run.
  1544. */
  1545. public function renderStatement($type, $data) {
  1546. extract($data);
  1547. $aliases = null;
  1548. switch (strtolower($type)) {
  1549. case 'select':
  1550. return "SELECT {$fields} FROM {$ta…

Large files files are truncated, but you can click here to view the full file