PageRenderTime 62ms CodeModel.GetById 23ms RepoModel.GetById 1ms app.codeStats 0ms

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

https://github.com/aeha/cakephp
PHP | 3094 lines | 2016 code | 260 blank | 818 comment | 536 complexity | f27b6a2c21718903289fd062c738257b MD5 | raw file

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 serialzed 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 esacped.
  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 esacped.
  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, suchs 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. return true;
  397. }
  398. return $query;
  399. } catch (PDOException $e) {
  400. if (isset($query->queryString)) {
  401. $e->queryString = $query->queryString;
  402. } else {
  403. $e->queryString = $sql;
  404. }
  405. throw $e;
  406. }
  407. }
  408. /**
  409. * Returns a formatted error message from previous database operation.
  410. *
  411. * @param PDOStatement $query the query to extract the error from if any
  412. * @return string Error message with error number
  413. */
  414. public function lastError(PDOStatement $query = null) {
  415. if ($query) {
  416. $error = $query->errorInfo();
  417. } else {
  418. $error = $this->_connection->errorInfo();
  419. }
  420. if (empty($error[2])) {
  421. return null;
  422. }
  423. return $error[1] . ': ' . $error[2];
  424. }
  425. /**
  426. * Returns number of affected rows in previous database operation. If no previous operation exists,
  427. * this returns false.
  428. *
  429. * @param mixed $source
  430. * @return integer Number of affected rows
  431. */
  432. public function lastAffected($source = null) {
  433. if ($this->hasResult()) {
  434. return $this->_result->rowCount();
  435. }
  436. return null;
  437. }
  438. /**
  439. * Returns number of rows in previous resultset. If no previous resultset exists,
  440. * this returns false.
  441. *
  442. * @param mixed $source Not used
  443. * @return integer Number of rows in resultset
  444. */
  445. public function lastNumRows($source = null) {
  446. return $this->lastAffected();
  447. }
  448. /**
  449. * DataSource Query abstraction
  450. *
  451. * @return resource Result resource identifier.
  452. */
  453. public function query() {
  454. $args = func_get_args();
  455. $fields = null;
  456. $order = null;
  457. $limit = null;
  458. $page = null;
  459. $recursive = null;
  460. if (count($args) === 1) {
  461. return $this->fetchAll($args[0]);
  462. } elseif (count($args) > 1 && (strpos($args[0], 'findBy') === 0 || strpos($args[0], 'findAllBy') === 0)) {
  463. $params = $args[1];
  464. if (substr($args[0], 0, 6) === 'findBy') {
  465. $all = false;
  466. $field = Inflector::underscore(substr($args[0], 6));
  467. } else {
  468. $all = true;
  469. $field = Inflector::underscore(substr($args[0], 9));
  470. }
  471. $or = (strpos($field, '_or_') !== false);
  472. if ($or) {
  473. $field = explode('_or_', $field);
  474. } else {
  475. $field = explode('_and_', $field);
  476. }
  477. $off = count($field) - 1;
  478. if (isset($params[1 + $off])) {
  479. $fields = $params[1 + $off];
  480. }
  481. if (isset($params[2 + $off])) {
  482. $order = $params[2 + $off];
  483. }
  484. if (!array_key_exists(0, $params)) {
  485. return false;
  486. }
  487. $c = 0;
  488. $conditions = array();
  489. foreach ($field as $f) {
  490. $conditions[$args[2]->alias . '.' . $f] = $params[$c++];
  491. }
  492. if ($or) {
  493. $conditions = array('OR' => $conditions);
  494. }
  495. if ($all) {
  496. if (isset($params[3 + $off])) {
  497. $limit = $params[3 + $off];
  498. }
  499. if (isset($params[4 + $off])) {
  500. $page = $params[4 + $off];
  501. }
  502. if (isset($params[5 + $off])) {
  503. $recursive = $params[5 + $off];
  504. }
  505. return $args[2]->find('all', compact('conditions', 'fields', 'order', 'limit', 'page', 'recursive'));
  506. } else {
  507. if (isset($params[3 + $off])) {
  508. $recursive = $params[3 + $off];
  509. }
  510. return $args[2]->find('first', compact('conditions', 'fields', 'order', 'recursive'));
  511. }
  512. } else {
  513. if (isset($args[1]) && $args[1] === true) {
  514. return $this->fetchAll($args[0], true);
  515. } else if (isset($args[1]) && !is_array($args[1]) ) {
  516. return $this->fetchAll($args[0], false);
  517. } else if (isset($args[1]) && is_array($args[1])) {
  518. $offset = 0;
  519. if (isset($args[2])) {
  520. $cache = $args[2];
  521. } else {
  522. $cache = true;
  523. }
  524. return $this->fetchAll($args[0], $args[1], array('cache' => $cache));
  525. }
  526. }
  527. }
  528. /**
  529. * Returns a row from current resultset as an array
  530. *
  531. * @param string $sql Some SQL to be executed.
  532. * @return array The fetched row as an array
  533. */
  534. public function fetchRow($sql = null) {
  535. if (is_string($sql) && strlen($sql) > 5 && !$this->execute($sql)) {
  536. return null;
  537. }
  538. if ($this->hasResult()) {
  539. $this->resultSet($this->_result);
  540. $resultRow = $this->fetchResult();
  541. if (isset($resultRow[0])) {
  542. $this->fetchVirtualField($resultRow);
  543. }
  544. return $resultRow;
  545. } else {
  546. return null;
  547. }
  548. }
  549. /**
  550. * Returns an array of all result rows for a given SQL query.
  551. * Returns false if no rows matched.
  552. *
  553. *
  554. * ### Options
  555. *
  556. * - `cache` - Returns the cached version of the query, if exists and stores the result in cache.
  557. * This is a non-persistent cache, and only lasts for a single request. This option
  558. * defaults to true. If you are directly calling this method, you can disable caching
  559. * by setting $options to `false`
  560. *
  561. * @param string $sql SQL statement
  562. * @param array $params parameters to be bound as values for the SQL statement
  563. * @param array $options additional options for the query.
  564. * @return array Array of resultset rows, or false if no rows matched
  565. */
  566. public function fetchAll($sql, $params = array(), $options = array()) {
  567. if (is_string($options)) {
  568. $options = array('modelName' => $options);
  569. }
  570. if (is_bool($params)) {
  571. $options['cache'] = $params;
  572. $params = array();
  573. }
  574. $options += array('cache' => true);
  575. $cache = $options['cache'];
  576. if ($cache && ($cached = $this->getQueryCache($sql, $params)) !== false) {
  577. return $cached;
  578. }
  579. if ($result = $this->execute($sql, array(), $params)) {
  580. $out = array();
  581. if ($this->hasResult()) {
  582. $first = $this->fetchRow();
  583. if ($first != null) {
  584. $out[] = $first;
  585. }
  586. while ($item = $this->fetchResult()) {
  587. if (isset($item[0])) {
  588. $this->fetchVirtualField($item);
  589. }
  590. $out[] = $item;
  591. }
  592. }
  593. if (!is_bool($result) && $cache) {
  594. $this->_writeQueryCache($sql, $out, $params);
  595. }
  596. if (empty($out) && is_bool($this->_result)) {
  597. return $this->_result;
  598. }
  599. return $out;
  600. }
  601. return false;
  602. }
  603. /**
  604. * Fetches the next row from the current result set
  605. *
  606. * @return boolean
  607. */
  608. public function fetchResult() {
  609. return false;
  610. }
  611. /**
  612. * Modifies $result array to place virtual fields in model entry where they belongs to
  613. *
  614. * @param array $result Reference to the fetched row
  615. * @return void
  616. */
  617. public function fetchVirtualField(&$result) {
  618. if (isset($result[0]) && is_array($result[0])) {
  619. foreach ($result[0] as $field => $value) {
  620. if (strpos($field, $this->virtualFieldSeparator) === false) {
  621. continue;
  622. }
  623. list($alias, $virtual) = explode($this->virtualFieldSeparator, $field);
  624. if (!ClassRegistry::isKeySet($alias)) {
  625. return;
  626. }
  627. $model = ClassRegistry::getObject($alias);
  628. if ($model->isVirtualField($virtual)) {
  629. $result[$alias][$virtual] = $value;
  630. unset($result[0][$field]);
  631. }
  632. }
  633. if (empty($result[0])) {
  634. unset($result[0]);
  635. }
  636. }
  637. }
  638. /**
  639. * Returns a single field of the first of query results for a given SQL query, or false if empty.
  640. *
  641. * @param string $name Name of the field
  642. * @param string $sql SQL query
  643. * @return mixed Value of field read.
  644. */
  645. public function field($name, $sql) {
  646. $data = $this->fetchRow($sql);
  647. if (empty($data[$name])) {
  648. return false;
  649. }
  650. return $data[$name];
  651. }
  652. /**
  653. * Empties the method caches.
  654. * These caches are used by DboSource::name() and DboSource::conditions()
  655. *
  656. * @return void
  657. */
  658. public function flushMethodCache() {
  659. $this->_methodCacheChange = true;
  660. self::$methodCache = array();
  661. }
  662. /**
  663. * Cache a value into the methodCaches. Will respect the value of DboSource::$cacheMethods.
  664. * Will retrieve a value from the cache if $value is null.
  665. *
  666. * If caching is disabled and a write is attempted, the $value will be returned.
  667. * A read will either return the value or null.
  668. *
  669. * @param string $method Name of the method being cached.
  670. * @param string $key The keyname for the cache operation.
  671. * @param mixed $value The value to cache into memory.
  672. * @return mixed Either null on failure, or the value if its set.
  673. */
  674. public function cacheMethod($method, $key, $value = null) {
  675. if ($this->cacheMethods === false) {
  676. return $value;
  677. }
  678. if (empty(self::$methodCache)) {
  679. self::$methodCache = Cache::read('method_cache', '_cake_core_');
  680. }
  681. if ($value === null) {
  682. return (isset(self::$methodCache[$method][$key])) ? self::$methodCache[$method][$key] : null;
  683. }
  684. $this->_methodCacheChange = true;
  685. return self::$methodCache[$method][$key] = $value;
  686. }
  687. /**
  688. * Returns a quoted name of $data for use in an SQL statement.
  689. * Strips fields out of SQL functions before quoting.
  690. *
  691. * Results of this method are stored in a memory cache. This improves performance, but
  692. * because the method uses a simple hashing algorithm it can infrequently have collisions.
  693. * Setting DboSource::$cacheMethods to false will disable the memory cache.
  694. *
  695. * @param mixed $data Either a string with a column to quote. An array of columns to quote or an
  696. * object from DboSource::expression() or DboSource::identifier()
  697. * @return string SQL field
  698. */
  699. public function name($data) {
  700. if (is_object($data) && isset($data->type)) {
  701. return $data->value;
  702. }
  703. if ($data === '*') {
  704. return '*';
  705. }
  706. if (is_array($data)) {
  707. foreach ($data as $i => $dataItem) {
  708. $data[$i] = $this->name($dataItem);
  709. }
  710. return $data;
  711. }
  712. $cacheKey = crc32($this->startQuote.$data.$this->endQuote);
  713. if ($return = $this->cacheMethod(__FUNCTION__, $cacheKey)) {
  714. return $return;
  715. }
  716. $data = trim($data);
  717. if (preg_match('/^[\w-]+(?:\.[^ \*]*)*$/', $data)) { // string, string.string
  718. if (strpos($data, '.') === false) { // string
  719. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  720. }
  721. $items = explode('.', $data);
  722. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  723. $this->startQuote . implode($this->endQuote . '.' . $this->startQuote, $items) . $this->endQuote
  724. );
  725. }
  726. if (preg_match('/^[\w-]+\.\*$/', $data)) { // string.*
  727. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  728. $this->startQuote . str_replace('.*', $this->endQuote . '.*', $data)
  729. );
  730. }
  731. if (preg_match('/^([\w-]+)\((.*)\)$/', $data, $matches)) { // Functions
  732. return $this->cacheMethod(__FUNCTION__, $cacheKey,
  733. $matches[1] . '(' . $this->name($matches[2]) . ')'
  734. );
  735. }
  736. if (
  737. preg_match('/^([\w-]+(\.[\w-]+|\(.*\))*)\s+' . preg_quote($this->alias) . '\s*([\w-]+)$/i', $data, $matches
  738. )) {
  739. return $this->cacheMethod(
  740. __FUNCTION__, $cacheKey,
  741. preg_replace(
  742. '/\s{2,}/', ' ', $this->name($matches[1]) . ' ' . $this->alias . ' ' . $this->name($matches[3])
  743. )
  744. );
  745. }
  746. if (preg_match('/^[\w-_\s]*[\w-_]+/', $data)) {
  747. return $this->cacheMethod(__FUNCTION__, $cacheKey, $this->startQuote . $data . $this->endQuote);
  748. }
  749. return $this->cacheMethod(__FUNCTION__, $cacheKey, $data);
  750. }
  751. /**
  752. * Checks if the source is connected to the database.
  753. *
  754. * @return boolean True if the database is connected, else false
  755. */
  756. public function isConnected() {
  757. return $this->connected;
  758. }
  759. /**
  760. * Checks if the result is valid
  761. *
  762. * @return boolean True if the result is valid else false
  763. */
  764. public function hasResult() {
  765. return is_a($this->_result, 'PDOStatement');
  766. }
  767. /**
  768. * Get the query log as an array.
  769. *
  770. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  771. * @param boolean $clear If True the existing log will cleared.
  772. * @return array Array of queries run as an array
  773. */
  774. public function getLog($sorted = false, $clear = true) {
  775. if ($sorted) {
  776. $log = sortByKey($this->_queriesLog, 'took', 'desc', SORT_NUMERIC);
  777. } else {
  778. $log = $this->_queriesLog;
  779. }
  780. if ($clear) {
  781. $this->_queriesLog = array();
  782. }
  783. return array('log' => $log, 'count' => $this->_queriesCnt, 'time' => $this->_queriesTime);
  784. }
  785. /**
  786. * Outputs the contents of the queries log. If in a non-CLI environment the sql_log element
  787. * will be rendered and output. If in a CLI environment, a plain text log is generated.
  788. *
  789. * @param boolean $sorted Get the queries sorted by time taken, defaults to false.
  790. * @return void
  791. */
  792. public function showLog($sorted = false) {
  793. $log = $this->getLog($sorted, false);
  794. if (empty($log['log'])) {
  795. return;
  796. }
  797. if (PHP_SAPI != 'cli') {
  798. $controller = null;
  799. $View = new View($controller, false);
  800. $View->set('logs', array($this->configKeyName => $log));
  801. echo $View->element('sql_dump', array('_forced_from_dbo_' => true));
  802. } else {
  803. foreach ($log['log'] as $k => $i) {
  804. print (($k + 1) . ". {$i['query']}\n");
  805. }
  806. }
  807. }
  808. /**
  809. * Log given SQL query.
  810. *
  811. * @param string $sql SQL statement
  812. * @return void
  813. */
  814. public function logQuery($sql) {
  815. $this->_queriesCnt++;
  816. $this->_queriesTime += $this->took;
  817. $this->_queriesLog[] = array(
  818. 'query' => $sql,
  819. 'affected' => $this->affected,
  820. 'numRows' => $this->numRows,
  821. 'took' => $this->took
  822. );
  823. if (count($this->_queriesLog) > $this->_queriesLogMax) {
  824. array_pop($this->_queriesLog);
  825. }
  826. }
  827. /**
  828. * Gets full table name including prefix
  829. *
  830. * @param mixed $model Either a Model object or a string table name.
  831. * @param boolean $quote Whether you want the table name quoted.
  832. * @return string Full quoted table name
  833. */
  834. public function fullTableName($model, $quote = true) {
  835. if (is_object($model)) {
  836. $table = $model->tablePrefix . $model->table;
  837. } elseif (isset($this->config['prefix'])) {
  838. $table = $this->config['prefix'] . strval($model);
  839. } else {
  840. $table = strval($model);
  841. }
  842. if ($quote) {
  843. return $this->name($table);
  844. }
  845. return $table;
  846. }
  847. /**
  848. * The "C" in CRUD
  849. *
  850. * Creates new records in the database.
  851. *
  852. * @param Model $model Model object that the record is for.
  853. * @param array $fields An array of field names to insert. If null, $model->data will be
  854. * used to generate field names.
  855. * @param array $values An array of values with keys matching the fields. If null, $model->data will
  856. * be used to generate values.
  857. * @return boolean Success
  858. */
  859. public function create(Model $model, $fields = null, $values = null) {
  860. $id = null;
  861. if ($fields == null) {
  862. unset($fields, $values);
  863. $fields = array_keys($model->data);
  864. $values = array_values($model->data);
  865. }
  866. $count = count($fields);
  867. for ($i = 0; $i < $count; $i++) {
  868. $valueInsert[] = $this->value($values[$i], $model->getColumnType($fields[$i]));
  869. }
  870. for ($i = 0; $i < $count; $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();
  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 = $this->_filterResults($resultSet, $model);
  949. if ($model->recursive > -1) {
  950. foreach ($_associations as $type) {
  951. foreach ($model->{$type} as $assoc => $assocData) {
  952. $linkModel = $model->{$assoc};
  953. if (!isset($linkedModels[$type . '/' . $assoc])) {
  954. if ($model->useDbConfig === $linkModel->useDbConfig) {
  955. $db = $this;
  956. } else {
  957. $db = ConnectionManager::getDataSource($linkModel->useDbConfig);
  958. }
  959. } elseif ($model->recursive > 1 && ($type === 'belongsTo' || $type === 'hasOne')) {
  960. $db = $this;
  961. }
  962. if (isset($db) && method_exists($db, 'queryAssociation')) {
  963. $stack = array($assoc);
  964. $db->queryAssociation($model, $linkModel, $type, $assoc, $assocData, $array, true, $resultSet, $model->recursive - 1, $stack);
  965. unset($db);
  966. if ($type === 'hasMany') {
  967. $filtered[] = $assoc;
  968. }
  969. }
  970. }
  971. }
  972. $this->_filterResults($resultSet, $model, $filtered);
  973. }
  974. if (!is_null($recursive)) {
  975. $model->recursive = $_recursive;
  976. }
  977. return $resultSet;
  978. }
  979. /**
  980. * Passes association results thru afterFind filters of corresponding model
  981. *
  982. * @param array $results Reference of resultset to be filtered
  983. * @param Model $model Instance of model to operate against
  984. * @param array $filtered List of classes already filtered, to be skipped
  985. * @return array Array of results that have been filtered through $model->afterFind
  986. */
  987. protected function _filterResults(&$results, Model $model, $filtered = array()) {
  988. $current = current($results);
  989. if (!is_array($current)) {
  990. return array();
  991. }
  992. $keys = array_diff(array_keys($current), $filtered, array($model->alias));
  993. $filtering = array();
  994. foreach ($keys as $className) {
  995. if (!isset($model->{$className}) || !is_object($model->{$className})) {
  996. continue;
  997. }
  998. $linkedModel = $model->{$className};
  999. $filtering[] = $className;
  1000. foreach ($results as &$result) {
  1001. $data = $linkedModel->afterFind(array(array($className => $result[$className])), false);
  1002. if (isset($data[0][$className])) {
  1003. $result[$className] = $data[0][$className];
  1004. }
  1005. }
  1006. }
  1007. return $filtering;
  1008. }
  1009. /**
  1010. * Queries associations. Used to fetch results on recursive models.
  1011. *
  1012. * @param Model $model Primary Model object
  1013. * @param Model $linkModel Linked model that
  1014. * @param string $type Association type, one of the model association types ie. hasMany
  1015. * @param string $association
  1016. * @param array $assocData
  1017. * @param array $queryData
  1018. * @param boolean $external Whether or not the association query is on an external datasource.
  1019. * @param array $resultSet Existing results
  1020. * @param integer $recursive Number of levels of association
  1021. * @param array $stack
  1022. * @return mixed
  1023. */
  1024. public function queryAssociation($model, &$linkModel, $type, $association, $assocData, &$queryData, $external = false, &$resultSet, $recursive, $stack) {
  1025. if ($query = $this->generateAssociationQuery($model, $linkModel, $type, $association, $assocData, $queryData, $external, $resultSet)) {
  1026. if (!is_array($resultSet)) {
  1027. throw new CakeException(__d('cake_dev', 'Error in Model %s', get_class($model)));
  1028. }
  1029. if ($type === 'hasMany' && empty($assocData['limit']) && !empty($assocData['foreignKey'])) {
  1030. $ins = $fetch = array();
  1031. foreach ($resultSet as &$result) {
  1032. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1033. $ins[] = $in;
  1034. }
  1035. }
  1036. if (!empty($ins)) {
  1037. $ins = array_unique($ins);
  1038. $fetch = $this->fetchAssociated($model, $query, $ins);
  1039. }
  1040. if (!empty($fetch) && is_array($fetch)) {
  1041. if ($recursive > 0) {
  1042. foreach ($linkModel->associations() as $type1) {
  1043. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1044. $deepModel = $linkModel->{$assoc1};
  1045. $tmpStack = $stack;
  1046. $tmpStack[] = $assoc1;
  1047. if ($linkModel->useDbConfig === $deepModel->useDbConfig) {
  1048. $db = $this;
  1049. } else {
  1050. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1051. }
  1052. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1053. }
  1054. }
  1055. }
  1056. }
  1057. $this->_filterResults($fetch, $model);
  1058. return $this->_mergeHasMany($resultSet, $fetch, $association, $model, $linkModel);
  1059. } elseif ($type === 'hasAndBelongsToMany') {
  1060. $ins = $fetch = array();
  1061. foreach ($resultSet as &$result) {
  1062. if ($in = $this->insertQueryData('{$__cakeID__$}', $result, $association, $assocData, $model, $linkModel, $stack)) {
  1063. $ins[] = $in;
  1064. }
  1065. }
  1066. if (!empty($ins)) {
  1067. $ins = array_unique($ins);
  1068. if (count($ins) > 1) {
  1069. $query = str_replace('{$__cakeID__$}', '(' .implode(', ', $ins) .')', $query);
  1070. $query = str_replace('= (', 'IN (', $query);
  1071. } else {
  1072. $query = str_replace('{$__cakeID__$}', $ins[0], $query);
  1073. }
  1074. $query = str_replace(' WHERE 1 = 1', '', $query);
  1075. }
  1076. $foreignKey = $model->hasAndBelongsToMany[$association]['foreignKey'];
  1077. $joinKeys = array($foreignKey, $model->hasAndBelongsToMany[$association]['associationForeignKey']);
  1078. list($with, $habtmFields) = $model->joinModel($model->hasAndBelongsToMany[$association]['with'], $joinKeys);
  1079. $habtmFieldsCount = count($habtmFields);
  1080. $q = $this->insertQueryData($query, null, $association, $assocData, $model, $linkModel, $stack);
  1081. if ($q !== false) {
  1082. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1083. } else {
  1084. $fetch = null;
  1085. }
  1086. }
  1087. $modelAlias = $model->alias;
  1088. $modelPK = $model->primaryKey;
  1089. foreach ($resultSet as &$row) {
  1090. if ($type !== 'hasAndBelongsToMany') {
  1091. $q = $this->insertQueryData($query, $row, $association, $assocData, $model, $linkModel, $stack);
  1092. if ($q !== false) {
  1093. $fetch = $this->fetchAll($q, $model->cacheQueries);
  1094. } else {
  1095. $fetch = null;
  1096. }
  1097. }
  1098. $selfJoin = $linkModel->name === $model->name;
  1099. if (!empty($fetch) && is_array($fetch)) {
  1100. if ($recursive > 0) {
  1101. foreach ($linkModel->associations() as $type1) {
  1102. foreach ($linkModel->{$type1} as $assoc1 => $assocData1) {
  1103. $deepModel = $linkModel->{$assoc1};
  1104. if ($type1 === 'belongsTo' || ($deepModel->alias === $modelAlias && $type === 'belongsTo') || ($deepModel->alias !== $modelAlias)) {
  1105. $tmpStack = $stack;
  1106. $tmpStack[] = $assoc1;
  1107. if ($linkModel->useDbConfig == $deepModel->useDbConfig) {
  1108. $db = $this;
  1109. } else {
  1110. $db = ConnectionManager::getDataSource($deepModel->useDbConfig);
  1111. }
  1112. $db->queryAssociation($linkModel, $deepModel, $type1, $assoc1, $assocData1, $queryData, true, $fetch, $recursive - 1, $tmpStack);
  1113. }
  1114. }
  1115. }
  1116. }
  1117. if ($type === 'hasAndBelongsToMany') {
  1118. $uniqueIds = $merge = array();
  1119. foreach ($fetch as $j => $data) {
  1120. if (isset($data[$with]) && $data[$with][$foreignKey] === $row[$modelAlias][$modelPK]) {
  1121. if ($habtmFieldsCount <= 2) {
  1122. unset($data[$with]);
  1123. }
  1124. $merge[] = $data;
  1125. }
  1126. }
  1127. if (empty($merge) && !isset($row[$association])) {
  1128. $row[$association] = $merge;
  1129. } else {
  1130. $this->_mergeAssociation($row, $merge, $association, $type);
  1131. }
  1132. } else {
  1133. $this->_mergeAssociation($row, $fetch, $association, $type, $selfJoin);
  1134. }
  1135. if (isset($row[$association])) {
  1136. $row[$association] = $linkModel->afterFind($row[$association], false);
  1137. }
  1138. } else {
  1139. $tempArray[0][$association] = false;
  1140. $this->_mergeAssociation($row, $tempArray, $association, $type, $selfJoin);
  1141. }
  1142. }
  1143. }
  1144. }
  1145. /**
  1146. * A more efficient way to fetch associations. Woohoo!
  1147. *
  1148. * @param Model $model Primary model object
  1149. * @param string $query Association query
  1150. * @param array $ids Array of IDs of associated records
  1151. * @return array Association results
  1152. */
  1153. public function fetchAssociated($model, $query, $ids) {
  1154. $query = str_replace('{$__cakeID__$}', implode(', ', $ids), $query);
  1155. if (count($ids) > 1) {
  1156. $query = str_replace('= (', 'IN (', $query);
  1157. }
  1158. return $this->fetchAll($query, $model->cacheQueries);
  1159. }
  1160. /**
  1161. * mergeHasMany - Merge the results of hasMany relations.
  1162. *
  1163. *
  1164. * @param array $resultSet Data to merge into
  1165. * @param array $merge Data to merge
  1166. * @param string $association Name of Model being Merged
  1167. * @param Model $model Model being merged onto
  1168. * @param Model $linkModel Model being merged
  1169. * @return void
  1170. */
  1171. protected function _mergeHasMany(&$resultSet, $merge, $association, $model, $linkModel) {
  1172. $modelAlias = $model->alias;
  1173. $modelPK = $model->primaryKey;
  1174. $modelFK = $model->hasMany[$association]['foreignKey'];
  1175. foreach ($resultSet as &$result) {
  1176. if (!isset($result[$modelAlias])) {
  1177. continue;
  1178. }
  1179. $merged = array();
  1180. foreach ($merge as $data) {
  1181. if ($result[$modelAlias][$modelPK] === $data[$association][$modelFK]) {
  1182. if (count($data) > 1) {
  1183. $data = array_merge($data[$association], $data);
  1184. unset($data[$association]);
  1185. foreach ($data as $key => $name) {
  1186. if (is_numeric($key)) {
  1187. $data[$association][] = $name;
  1188. unset($data[$key]);
  1189. }
  1190. }
  1191. $merged[] = $data;
  1192. } else {
  1193. $merged[] = $data[$association];
  1194. }
  1195. }
  1196. }
  1197. $result = Set::pushDiff($result, array($association => $merged));
  1198. }
  1199. }
  1200. /**
  1201. * Merge association of merge into data
  1202. *
  1203. * @param array $data
  1204. * @param array $merge
  1205. * @param string $association
  1206. * @param string $type
  1207. * @param boolean $selfJoin
  1208. * @return void
  1209. */
  1210. protected function _mergeAssociation(&$data, &$merge, $association, $type, $selfJoin = false) {
  1211. if (isset($merge[0]) && !isset($merge[0][$association])) {
  1212. $association = Inflector::pluralize($association);
  1213. }
  1214. if ($type === 'belongsTo' || $type === 'hasOne') {
  1215. if (isset($merge[$association])) {
  1216. $data[$association] = $merge[$association][0];
  1217. } else {
  1218. if (count($merge[0][$association]) > 1) {
  1219. foreach ($merge[0] as $assoc => $data2) {
  1220. if ($assoc !== $association) {
  1221. $merge[0][$association][$assoc] = $data2;
  1222. }
  1223. }
  1224. }
  1225. if (!isset($data[$association])) {
  1226. if ($merge[0][$association] != null) {
  1227. $data[$association] = $merge[0][$association];
  1228. } else {
  1229. $data[$association] = array();
  1230. }
  1231. } else {
  1232. if (is_array($merge[0][$association])) {
  1233. foreach ($data[$association] as $k => $v) {
  1234. if (!is_array($v)) {
  1235. $dataAssocTmp[$k] = $v;
  1236. }
  1237. }
  1238. foreach ($merge[0][$association] as $k => $v) {
  1239. if (!is_array($v)) {
  1240. $mergeAssocTmp[$k] = $v;
  1241. }
  1242. }
  1243. $dataKeys = array_keys($data);
  1244. $mergeKeys = array_keys($merge[0]);
  1245. if ($mergeKeys[0] === $dataKeys[0] || $mergeKeys === $dataKeys) {
  1246. $data[$association][$association] = $merge[0][$association];
  1247. } else {
  1248. $diff = Set::diff($dataAssocTmp, $mergeAssocTmp);
  1249. $data[$association] = array_merge($merge[0][$association], $diff);
  1250. }
  1251. } elseif ($selfJoin && array_key_exists($association, $merge[0])) {
  1252. $data[$association] = array_merge($data[$association], array($association => array()));
  1253. }
  1254. }
  1255. }
  1256. } else {
  1257. if (isset($merge[0][$association]) && $merge[0][$association] === false) {
  1258. if (!isset($data[$association])) {
  1259. $data[$association] = array();
  1260. }
  1261. } else {
  1262. foreach ($merge as $i => $row) {
  1263. if (count($row) === 1) {
  1264. if (empty($data[$association]) || (isset($data[$association]) && !in_array($row[$association], $data[$association]))) {
  1265. $data[$association][] = $row[$association];
  1266. }
  1267. } elseif (!empty($row)) {
  1268. $tmp = array_merge($row[$association], $row);
  1269. unset($tmp[$association]);
  1270. $data[$association][] = $tmp;
  1271. }
  1272. }
  1273. }
  1274. }
  1275. }
  1276. /**
  1277. * Generates an array representing a query or part of a query from a single model or two associated models
  1278. *
  1279. * @param Model $model
  1280. * @param Model $linkModel
  1281. * @param string $type
  1282. * @param string $association
  1283. * @param array $assocData
  1284. * @param array $queryData
  1285. * @param boolean $external
  1286. * @param array $resultSet
  1287. * @return mixed
  1288. */
  1289. public function generateAssociationQuery($model, $linkModel, $type, $association = null, $assocData = array(), &$queryData, $external = false, &$resultSet) {
  1290. $queryData = $this->_scrubQueryData($queryData);
  1291. $assocData = $this->_scrubQueryData($assocData);
  1292. $modelAlias = $model->alias;
  1293. if (empty($queryData['fields'])) {
  1294. $queryData['fields'] = $this->fields($model, $modelAlias);
  1295. } elseif (!empty($model->hasMany) && $model->recursive > -1) {
  1296. $assocFields = $this->fields($model, $modelAlias, array("{$modelAlias}.{$model->primaryKey}"));
  1297. $passedFields = $queryData['fields'];
  1298. if (count($passedFields) === 1) {
  1299. if (strpos($passedFields[0], $assocFields[0]) === false && !preg_match('/^[a-z]+\(/i', $passedFields[0])) {
  1300. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1301. } else {
  1302. $queryData['fields'] = $passedFields;
  1303. }
  1304. } else {
  1305. $queryData['fields'] = array_merge($passedFields, $assocFields);
  1306. }
  1307. unset($assocFields, $passedFields);
  1308. }
  1309. if ($linkModel === null) {
  1310. return $this->buildStatement(
  1311. array(
  1312. 'fields' => array_unique($queryData['fields']),
  1313. 'table' => $this->fullTableName($model),
  1314. 'alias' => $modelAlias,
  1315. 'limit' => $queryData['limit'],
  1316. 'offset' => $queryData['offset'],
  1317. 'joins' => $queryData['joins'],
  1318. 'conditions' => $queryData['conditions'],
  1319. 'order' => $queryData['order'],
  1320. 'group' => $queryData['group']
  1321. ),
  1322. $model
  1323. );
  1324. }
  1325. if ($external && !empty($assocData['finderQuery'])) {
  1326. return $assocData['finderQuery'];
  1327. }
  1328. $self = $model->name === $linkModel->name;
  1329. $fields = array();
  1330. if ($external || (in_array($type, array('hasOne', 'belongsTo')) && $assocData['fields'] !== false)) {
  1331. $fields = $this->fields($linkModel, $association, $assocData['fields']);
  1332. }
  1333. if (empty($assocData['offset']) && !empty($assocData['page'])) {
  1334. $assocData['offset'] = ($assocData['page'] - 1) * $assocData['limit'];
  1335. }
  1336. $assocData['limit'] = $this->limit($assocData['limit'], $assocData['offset']);
  1337. switch ($type) {
  1338. case 'hasOne':
  1339. case 'belongsTo':
  1340. $conditions = $this->_mergeConditions(
  1341. $assocData['conditions'],
  1342. $this->getConstraint($type, $model, $linkModel, $association, array_merge($assocData, compact('external', 'self')))
  1343. );
  1344. if (!$self && $external) {
  1345. foreach ($conditions as $key => $condition) {
  1346. if (is_numeric($key) && strpos($condition, $modelAlias . '.') !== false) {
  1347. unset($conditions[$key]);
  1348. }
  1349. }
  1350. }
  1351. if ($external) {
  1352. $query = array_merge($assocData, array(
  1353. 'conditions' => $conditions,
  1354. 'table' => $this->fullTableName($linkModel),
  1355. 'fields' => $fields,
  1356. 'alias' => $association,
  1357. 'group' => null
  1358. ));
  1359. $query += array('order' => $assocData['order'], 'limit' => $assocData['limit']);
  1360. } else {
  1361. $join = array(
  1362. 'table' => $linkModel,
  1363. 'alias' => $association,
  1364. 'type' => isset($assocData['type']) ? $assocData['type'] : 'LEFT',
  1365. 'conditions' => trim($this->conditions($conditions, true, false, $model))
  1366. );
  1367. $queryData['fields'] = array_merge($queryData['fields'], $fields);
  1368. if (!empty($assocData['order'])) {
  1369. $queryData['order'][] = $assocData['order'];
  1370. }
  1371. if (!in_array($join, $queryData['joins'])) {
  1372. $queryData['joins'][] = $join;
  1373. }
  1374. return true;
  1375. }
  1376. break;
  1377. case 'hasMany':
  1378. $assocData['fields'] = $this->fields($linkModel, $association, $assocData['fields']);
  1379. if (!empty($assocData['foreignKey'])) {
  1380. $assocData['fields'] = array_merge($assocData['fields'], $this->fields($linkModel, $association, array("{$association}.{$assocData['foreignKey']}")));
  1381. }
  1382. $query = array(
  1383. 'conditions' => $this->_mergeConditions($this->getConstraint('hasMany', $model, $linkModel, $association, $assocData), $assocData['conditions']),
  1384. 'fields' => array_unique($assocData['fields']),
  1385. 'table' => $this->fullTableName($linkModel),
  1386. 'alias' => $association,
  1387. 'order' => $assocData['order'],
  1388. 'limit' => $assocData['limit'],
  1389. 'group' => null
  1390. );
  1391. break;
  1392. case 'hasAndBelongsToMany':
  1393. $joinFields = array();
  1394. $joinAssoc = null;
  1395. if (isset($assocData['with']) && !empty($assocData['with'])) {
  1396. $joinKeys = array($assocData['foreignKey'], $assocData['associationForeignKey']);
  1397. list($with, $joinFields) = $model->joinModel($assocData['with'], $joinKeys);
  1398. $joinTbl = $model->{$with};
  1399. $joinAlias = $joinTbl;
  1400. if (is_array($joinFields) && !empty($joinFields)) {
  1401. $joinAssoc = $joinAlias = $model->{$with}->alias;
  1402. $joinFields = $this->fields($model->{$with}, $joinAlias, $joinFields);
  1403. } else {
  1404. $joinFields = array();
  1405. }
  1406. } else {
  1407. $joinTbl = $assocData['joinTable'];
  1408. $joinAlias = $this->fullTableName($assocData['joinTable']);
  1409. }
  1410. $query = array(
  1411. 'conditions' => $assocData['conditions'],
  1412. 'limit' => $assocData['limit'],
  1413. 'table' => $this->fullTableName($linkModel),
  1414. 'alias' => $association,
  1415. 'fields' => array_merge($this->fields($linkModel, $association, $assocData['fields']), $joinFields),
  1416. 'order' => $assocData['order'],
  1417. 'group' => null,
  1418. 'joins' => array(array(
  1419. 'table' => $joinTbl,
  1420. 'alias' => $joinAssoc,
  1421. 'conditions' => $this->getConstraint('hasAndBelongsToMany', $model, $linkModel, $joinAlias, $assocData, $association)
  1422. ))
  1423. );
  1424. break;
  1425. }
  1426. if (isset($query)) {
  1427. return $this->buildStatement($query, $model);
  1428. }
  1429. return null;
  1430. }
  1431. /**
  1432. * Returns a conditions array for the constraint between two models
  1433. *
  1434. * @param string $type Association type
  1435. * @param Model $model Model object
  1436. * @param string $linkModel
  1437. * @param string $alias
  1438. * @param array $assoc
  1439. * @param string $alias2
  1440. * @return array Conditions array defining the constraint between $model and $association
  1441. */
  1442. public function getConstraint($type, $model, $linkModel, $alias, $assoc, $alias2 = null) {
  1443. $assoc += array('external' => false, 'self' => false);
  1444. if (empty($assoc['foreignKey'])) {
  1445. return array();
  1446. }
  1447. switch (true) {
  1448. case ($assoc['external'] && $type === 'hasOne'):
  1449. return array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}');
  1450. case ($assoc['external'] && $type === 'belongsTo'):
  1451. return array("{$alias}.{$linkModel->primaryKey}" => '{$__cakeForeignKey__$}');
  1452. case (!$assoc['external'] && $type === 'hasOne'):
  1453. return array("{$alias}.{$assoc['foreignKey']}" => $this->identifier("{$model->alias}.{$model->primaryKey}"));
  1454. case (!$assoc['external'] && $type === 'belongsTo'):
  1455. return array("{$model->alias}.{$assoc['foreignKey']}" => $this->identifier("{$alias}.{$linkModel->primaryKey}"));
  1456. case ($type === 'hasMany'):
  1457. return array("{$alias}.{$assoc['foreignKey']}" => array('{$__cakeID__$}'));
  1458. case ($type === 'hasAndBelongsToMany'):
  1459. return array(
  1460. array("{$alias}.{$assoc['foreignKey']}" => '{$__cakeID__$}'),
  1461. array("{$alias}.{$assoc['associationForeignKey']}" => $this->identifier("{$alias2}.{$linkModel->primaryKey}"))
  1462. );
  1463. }
  1464. return array();
  1465. }
  1466. /**
  1467. * Builds and generates a JOIN statement from an array. Handles final clean-up before conversion.
  1468. *
  1469. * @param array $join An array defining a JOIN statement in a query
  1470. * @return string An SQL JOIN statement to be used in a query
  1471. * @see DboSource::renderJoinStatement()
  1472. * @see DboSource::buildStatement()
  1473. */
  1474. public function buildJoinStatement($join) {
  1475. $data = array_merge(array(
  1476. 'type' => null,
  1477. 'alias' => null,
  1478. 'table' => 'join_table',
  1479. 'conditions' => array()
  1480. ), $join);
  1481. if (!empty($data['alias'])) {
  1482. $data['alias'] = $this->alias . $this->name($data['alias']);
  1483. }
  1484. if (!empty($data['conditions'])) {
  1485. $data['conditions'] = trim($this->conditions($data['conditions'], true, false));
  1486. }
  1487. if (!empty($data['table'])) {
  1488. $data['table'] = $this->fullTableName($data['table']);
  1489. }
  1490. return $this->renderJoinStatement($data);
  1491. }
  1492. /**
  1493. * Builds and generates an SQL statement from an array. Handles final clean-up before conversion.
  1494. *
  1495. * @param array $query An array defining an SQL query
  1496. * @param Model $model The model object which initiated the query
  1497. * @return string An executable SQL statement
  1498. * @see DboSource::renderStatement()
  1499. */
  1500. public function buildStatement($query, $model) {
  1501. $query = array_merge(array('offset' => null, 'joins' => array()), $query);
  1502. if (!empty($query['joins'])) {
  1503. $count = count($query['joins']);
  1504. for ($i = 0; $i < $count; $i++) {
  1505. if (is_array($query['joins'][$i])) {
  1506. $query['joins'][$i] = $this->buildJoinStatement($query['joins'][$i]);
  1507. }
  1508. }
  1509. }
  1510. return $this->renderStatement('select', array(
  1511. 'conditions' => $this->conditions($query['conditions'], true, true, $model),
  1512. 'fields' => implode(', ', $query['fields']),
  1513. 'table' => $query['table'],
  1514. 'alias' => $this->alias . $this->name($query['alias']),
  1515. 'order' => $this->order($query['order'], 'ASC', $model),
  1516. 'limit' => $this->limit($query['limit'], $query['offset']),
  1517. 'joins' => implode(' ', $query['joins']),
  1518. 'group' => $this->group($query['group'], $model)
  1519. ));
  1520. }
  1521. /**
  1522. * Renders a final SQL JOIN statement
  1523. *
  1524. * @param array $data
  1525. * @return string
  1526. */
  1527. public function renderJoinStatement($data) {
  1528. extract($data);
  1529. return trim("{$type} JOIN {$table} {$alias} ON ({$conditions})");
  1530. }
  1531. /**
  1532. * Renders a final SQL statement by putting together the component parts in the correct order
  1533. *
  1534. * @param string $type type of query being run. e.g select, create, update, delete, schema, alter.
  1535. * @param array $data Array of data to insert into the query.
  1536. * @return string Rendered SQL expression to be run.
  1537. */
  1538. public function renderStatement($type, $data) {
  1539. extract($data);
  1540. $aliases = null;
  1541. switch (strtolower($type)) {
  1542. case 'select':
  1543. return "SELECT {$fields} FROM {$table} {$alias} {$joins} {$conditions} {$group} {$order} {$limit}";
  1544. case 'create':
  1545. return "INSERT INTO {$table} ({$fields}) VALUES ({$values})";
  1546. case 'update':
  1547. if (!empty($alias)) {
  1548. $aliases = "{$this->alias}{$alias} {$joins} ";
  1549. }
  1550. return "UPDATE {$table} {$aliases}SET {$fields} {$conditions}";
  1551. case '…

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