CDbCommand.php 62 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610
  1. <?php
  2. /**
  3. * This file contains the CDbCommand class.
  4. *
  5. * @author Qiang Xue <qiang.xue@gmail.com>
  6. * @link http://www.yiiframework.com/
  7. * @copyright 2008-2013 Yii Software LLC
  8. * @license http://www.yiiframework.com/license/
  9. */
  10. /**
  11. * CDbCommand represents an SQL statement to execute against a database.
  12. *
  13. * It is usually created by calling {@link CDbConnection::createCommand}.
  14. * The SQL statement to be executed may be set via {@link setText Text}.
  15. *
  16. * To execute a non-query SQL (such as insert, delete, update), call
  17. * {@link execute}. To execute an SQL statement that returns result data set
  18. * (such as SELECT), use {@link query} or its convenient versions {@link queryRow},
  19. * {@link queryColumn}, or {@link queryScalar}.
  20. *
  21. * If an SQL statement returns results (such as a SELECT SQL), the results
  22. * can be accessed via the returned {@link CDbDataReader}.
  23. *
  24. * CDbCommand supports SQL statement preparation and parameter binding.
  25. * Call {@link bindParam} to bind a PHP variable to a parameter in SQL.
  26. * Call {@link bindValue} to bind a value to an SQL parameter.
  27. * When binding a parameter, the SQL statement is automatically prepared.
  28. * You may also call {@link prepare} to explicitly prepare an SQL statement.
  29. *
  30. * Starting from version 1.1.6, CDbCommand can also be used as a query builder
  31. * that builds a SQL statement from code fragments. For example,
  32. * <pre>
  33. * $user = Yii::app()->db->createCommand()
  34. * ->select('username, password')
  35. * ->from('tbl_user')
  36. * ->where('id=:id', array(':id'=>1))
  37. * ->queryRow();
  38. * </pre>
  39. *
  40. * @property string $text The SQL statement to be executed.
  41. * @property CDbConnection $connection The connection associated with this command.
  42. * @property PDOStatement $pdoStatement The underlying PDOStatement for this command
  43. * It could be null if the statement is not prepared yet.
  44. * @property string $select The SELECT part (without 'SELECT') in the query.
  45. * @property boolean $distinct A value indicating whether SELECT DISTINCT should be used.
  46. * @property string $from The FROM part (without 'FROM' ) in the query.
  47. * @property string $where The WHERE part (without 'WHERE' ) in the query.
  48. * @property mixed $join The join part in the query. This can be an array representing
  49. * multiple join fragments, or a string representing a single join fragment.
  50. * Each join fragment will contain the proper join operator (e.g. LEFT JOIN).
  51. * @property string $group The GROUP BY part (without 'GROUP BY' ) in the query.
  52. * @property string $having The HAVING part (without 'HAVING' ) in the query.
  53. * @property string $order The ORDER BY part (without 'ORDER BY' ) in the query.
  54. * @property string $limit The LIMIT part (without 'LIMIT' ) in the query.
  55. * @property string $offset The OFFSET part (without 'OFFSET' ) in the query.
  56. * @property mixed $union The UNION part (without 'UNION' ) in the query.
  57. * This can be either a string or an array representing multiple union parts.
  58. *
  59. * @author Qiang Xue <qiang.xue@gmail.com>
  60. * @package system.db
  61. * @since 1.0
  62. */
  63. class CDbCommand extends CComponent
  64. {
  65. /**
  66. * @var array the parameters (name=>value) to be bound to the current query.
  67. * @since 1.1.6
  68. */
  69. public $params=array();
  70. private $_connection;
  71. private $_text;
  72. private $_statement;
  73. private $_paramLog=array();
  74. private $_query;
  75. private $_fetchMode = array(PDO::FETCH_ASSOC);
  76. /**
  77. * Constructor.
  78. * @param CDbConnection $connection the database connection
  79. * @param mixed $query the DB query to be executed. This can be either
  80. * a string representing a SQL statement, or an array whose name-value pairs
  81. * will be used to set the corresponding properties of the created command object.
  82. *
  83. * For example, you can pass in either <code>'SELECT * FROM tbl_user'</code>
  84. * or <code>array('select'=>'*', 'from'=>'tbl_user')</code>. They are equivalent
  85. * in terms of the final query result.
  86. *
  87. * When passing the query as an array, the following properties are commonly set:
  88. * {@link select}, {@link distinct}, {@link from}, {@link where}, {@link join},
  89. * {@link group}, {@link having}, {@link order}, {@link limit}, {@link offset} and
  90. * {@link union}. Please refer to the setter of each of these properties for details
  91. * about valid property values. This feature has been available since version 1.1.6.
  92. *
  93. * Since 1.1.7 it is possible to use a specific mode of data fetching by setting
  94. * {@link setFetchMode FetchMode}. See {@link http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php}
  95. * for more details.
  96. */
  97. public function __construct(CDbConnection $connection,$query=null)
  98. {
  99. $this->_connection=$connection;
  100. if(is_array($query))
  101. {
  102. foreach($query as $name=>$value)
  103. $this->$name=$value;
  104. }
  105. else
  106. $this->setText($query);
  107. }
  108. /**
  109. * Set the statement to null when serializing.
  110. * @return array
  111. */
  112. public function __sleep()
  113. {
  114. $this->_statement=null;
  115. return array_keys(get_object_vars($this));
  116. }
  117. /**
  118. * Set the default fetch mode for this statement
  119. * @param mixed $mode fetch mode
  120. * @return CDbCommand
  121. * @see http://www.php.net/manual/en/function.PDOStatement-setFetchMode.php
  122. * @since 1.1.7
  123. */
  124. public function setFetchMode($mode)
  125. {
  126. $params=func_get_args();
  127. $this->_fetchMode = $params;
  128. return $this;
  129. }
  130. /**
  131. * Cleans up the command and prepares for building a new query.
  132. * This method is mainly used when a command object is being reused
  133. * multiple times for building different queries.
  134. * Calling this method will clean up all internal states of the command object.
  135. * @return CDbCommand this command instance
  136. * @since 1.1.6
  137. */
  138. public function reset()
  139. {
  140. $this->_text=null;
  141. $this->_query=null;
  142. $this->_statement=null;
  143. $this->_paramLog=array();
  144. $this->params=array();
  145. return $this;
  146. }
  147. /**
  148. * @return string the SQL statement to be executed
  149. */
  150. public function getText()
  151. {
  152. if($this->_text=='' && !empty($this->_query))
  153. $this->setText($this->buildQuery($this->_query));
  154. return $this->_text;
  155. }
  156. /**
  157. * Specifies the SQL statement to be executed.
  158. * Any previous execution will be terminated or cancel.
  159. * @param string $value the SQL statement to be executed
  160. * @return CDbCommand this command instance
  161. */
  162. public function setText($value)
  163. {
  164. if($this->_connection->tablePrefix!==null && $value!='')
  165. $this->_text=preg_replace('/{{(.*?)}}/',$this->_connection->tablePrefix.'\1',$value);
  166. else
  167. $this->_text=$value;
  168. $this->cancel();
  169. return $this;
  170. }
  171. /**
  172. * @return CDbConnection the connection associated with this command
  173. */
  174. public function getConnection()
  175. {
  176. return $this->_connection;
  177. }
  178. /**
  179. * @return PDOStatement the underlying PDOStatement for this command
  180. * It could be null if the statement is not prepared yet.
  181. */
  182. public function getPdoStatement()
  183. {
  184. return $this->_statement;
  185. }
  186. /**
  187. * Prepares the SQL statement to be executed.
  188. * For complex SQL statement that is to be executed multiple times,
  189. * this may improve performance.
  190. * For SQL statement with binding parameters, this method is invoked
  191. * automatically.
  192. * @throws CDbException if CDbCommand failed to prepare the SQL statement
  193. */
  194. public function prepare()
  195. {
  196. if($this->_statement==null)
  197. {
  198. try
  199. {
  200. $this->_statement=$this->getConnection()->getPdoInstance()->prepare($this->getText());
  201. $this->_paramLog=array();
  202. }
  203. catch(Exception $e)
  204. {
  205. Yii::log('Error in preparing SQL: '.$this->getText(),CLogger::LEVEL_ERROR,'system.db.CDbCommand');
  206. $errorInfo=$e instanceof PDOException ? $e->errorInfo : null;
  207. throw new CDbException(Yii::t('yii','CDbCommand failed to prepare the SQL statement: {error}',
  208. array('{error}'=>$e->getMessage())),(int)$e->getCode(),$errorInfo);
  209. }
  210. }
  211. }
  212. /**
  213. * Cancels the execution of the SQL statement.
  214. */
  215. public function cancel()
  216. {
  217. $this->_statement=null;
  218. }
  219. /**
  220. * Binds a parameter to the SQL statement to be executed.
  221. * @param mixed $name Parameter identifier. For a prepared statement
  222. * using named placeholders, this will be a parameter name of
  223. * the form :name. For a prepared statement using question mark
  224. * placeholders, this will be the 1-indexed position of the parameter.
  225. * @param mixed $value Name of the PHP variable to bind to the SQL statement parameter
  226. * @param integer $dataType SQL data type of the parameter. If null, the type is determined by the PHP type of the value.
  227. * @param integer $length length of the data type
  228. * @param mixed $driverOptions the driver-specific options (this is available since version 1.1.6)
  229. * @return CDbCommand the current command being executed
  230. * @see http://www.php.net/manual/en/function.PDOStatement-bindParam.php
  231. */
  232. public function bindParam($name, &$value, $dataType=null, $length=null, $driverOptions=null)
  233. {
  234. $this->prepare();
  235. if($dataType===null)
  236. $this->_statement->bindParam($name,$value,$this->_connection->getPdoType(gettype($value)));
  237. elseif($length===null)
  238. $this->_statement->bindParam($name,$value,$dataType);
  239. elseif($driverOptions===null)
  240. $this->_statement->bindParam($name,$value,$dataType,$length);
  241. else
  242. $this->_statement->bindParam($name,$value,$dataType,$length,$driverOptions);
  243. $this->_paramLog[$name]=&$value;
  244. return $this;
  245. }
  246. /**
  247. * Binds a value to a parameter.
  248. * @param mixed $name Parameter identifier. For a prepared statement
  249. * using named placeholders, this will be a parameter name of
  250. * the form :name. For a prepared statement using question mark
  251. * placeholders, this will be the 1-indexed position of the parameter.
  252. * @param mixed $value The value to bind to the parameter
  253. * @param integer $dataType SQL data type of the parameter. If null, the type is determined by the PHP type of the value.
  254. * @return CDbCommand the current command being executed
  255. * @see http://www.php.net/manual/en/function.PDOStatement-bindValue.php
  256. */
  257. public function bindValue($name, $value, $dataType=null)
  258. {
  259. $this->prepare();
  260. if($dataType===null)
  261. $this->_statement->bindValue($name,$value,$this->_connection->getPdoType(gettype($value)));
  262. else
  263. $this->_statement->bindValue($name,$value,$dataType);
  264. $this->_paramLog[$name]=$value;
  265. return $this;
  266. }
  267. /**
  268. * Binds a list of values to the corresponding parameters.
  269. * This is similar to {@link bindValue} except that it binds multiple values.
  270. * Note that the SQL data type of each value is determined by its PHP type.
  271. * @param array $values the values to be bound. This must be given in terms of an associative
  272. * array with array keys being the parameter names, and array values the corresponding parameter values.
  273. * For example, <code>array(':name'=>'John', ':age'=>25)</code>.
  274. * @return CDbCommand the current command being executed
  275. * @since 1.1.5
  276. */
  277. public function bindValues($values)
  278. {
  279. $this->prepare();
  280. foreach($values as $name=>$value)
  281. {
  282. $this->_statement->bindValue($name,$value,$this->_connection->getPdoType(gettype($value)));
  283. $this->_paramLog[$name]=$value;
  284. }
  285. return $this;
  286. }
  287. /**
  288. * Executes the SQL statement.
  289. * This method is meant only for executing non-query SQL statement.
  290. * No result set will be returned.
  291. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  292. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  293. * them in this way can improve the performance. Note that if you pass parameters in this way,
  294. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  295. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  296. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  297. * @return integer number of rows affected by the execution.
  298. * @throws CDbException execution failed
  299. */
  300. public function execute($params=array())
  301. {
  302. if($this->_connection->enableParamLogging && ($pars=array_merge($this->_paramLog,$params))!==array())
  303. {
  304. $p=array();
  305. foreach($pars as $name=>$value)
  306. $p[$name]=$name.'='.var_export($value,true);
  307. $par='. Bound with ' .implode(', ',$p);
  308. }
  309. else
  310. $par='';
  311. Yii::trace('Executing SQL: '.$this->getText().$par,'system.db.CDbCommand');
  312. try
  313. {
  314. if($this->_connection->enableProfiling)
  315. Yii::beginProfile('system.db.CDbCommand.execute('.$this->getText().$par.')','system.db.CDbCommand.execute');
  316. $this->prepare();
  317. if($params===array())
  318. $this->_statement->execute();
  319. else
  320. $this->_statement->execute($params);
  321. $n=$this->_statement->rowCount();
  322. if($this->_connection->enableProfiling)
  323. Yii::endProfile('system.db.CDbCommand.execute('.$this->getText().$par.')','system.db.CDbCommand.execute');
  324. return $n;
  325. }
  326. catch(Exception $e)
  327. {
  328. if($this->_connection->enableProfiling)
  329. Yii::endProfile('system.db.CDbCommand.execute('.$this->getText().$par.')','system.db.CDbCommand.execute');
  330. $errorInfo=$e instanceof PDOException ? $e->errorInfo : null;
  331. $message=$e->getMessage();
  332. Yii::log(Yii::t('yii','CDbCommand::execute() failed: {error}. The SQL statement executed was: {sql}.',
  333. array('{error}'=>$message, '{sql}'=>$this->getText().$par)),CLogger::LEVEL_ERROR,'system.db.CDbCommand');
  334. if(YII_DEBUG)
  335. $message.='. The SQL statement executed was: '.$this->getText().$par;
  336. throw new CDbException(Yii::t('yii','CDbCommand failed to execute the SQL statement: {error}',
  337. array('{error}'=>$message)),(int)$e->getCode(),$errorInfo);
  338. }
  339. }
  340. /**
  341. * Executes the SQL statement and returns query result.
  342. * This method is for executing an SQL query that returns result set.
  343. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  344. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  345. * them in this way can improve the performance. Note that if you pass parameters in this way,
  346. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  347. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  348. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  349. * @return CDbDataReader the reader object for fetching the query result
  350. * @throws CException execution failed
  351. */
  352. public function query($params=array())
  353. {
  354. return $this->queryInternal('',0,$params);
  355. }
  356. /**
  357. * Executes the SQL statement and returns all rows.
  358. * @param boolean $fetchAssociative whether each row should be returned as an associated array with
  359. * column names as the keys or the array keys are column indexes (0-based).
  360. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  361. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  362. * them in this way can improve the performance. Note that if you pass parameters in this way,
  363. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  364. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  365. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  366. * @return array all rows of the query result. Each array element is an array representing a row.
  367. * An empty array is returned if the query results in nothing.
  368. * @throws CException execution failed
  369. */
  370. public function queryAll($fetchAssociative=true,$params=array())
  371. {
  372. return $this->queryInternal('fetchAll',$fetchAssociative ? $this->_fetchMode : PDO::FETCH_NUM, $params);
  373. }
  374. /**
  375. * Executes the SQL statement and returns the first row of the result.
  376. * This is a convenient method of {@link query} when only the first row of data is needed.
  377. * @param boolean $fetchAssociative whether the row should be returned as an associated array with
  378. * column names as the keys or the array keys are column indexes (0-based).
  379. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  380. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  381. * them in this way can improve the performance. Note that if you pass parameters in this way,
  382. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  383. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  384. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  385. * @return mixed the first row (in terms of an array) of the query result, false if no result.
  386. * @throws CException execution failed
  387. */
  388. public function queryRow($fetchAssociative=true,$params=array())
  389. {
  390. return $this->queryInternal('fetch',$fetchAssociative ? $this->_fetchMode : PDO::FETCH_NUM, $params);
  391. }
  392. /**
  393. * Executes the SQL statement and returns the value of the first column in the first row of data.
  394. * This is a convenient method of {@link query} when only a single scalar
  395. * value is needed (e.g. obtaining the count of the records).
  396. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  397. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  398. * them in this way can improve the performance. Note that if you pass parameters in this way,
  399. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  400. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  401. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  402. * @return mixed the value of the first column in the first row of the query result. False is returned if there is no value.
  403. * @throws CException execution failed
  404. */
  405. public function queryScalar($params=array())
  406. {
  407. $result=$this->queryInternal('fetchColumn',0,$params);
  408. if(is_resource($result) && get_resource_type($result)==='stream')
  409. return stream_get_contents($result);
  410. else
  411. return $result;
  412. }
  413. /**
  414. * Executes the SQL statement and returns the first column of the result.
  415. * This is a convenient method of {@link query} when only the first column of data is needed.
  416. * Note, the column returned will contain the first element in each row of result.
  417. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  418. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  419. * them in this way can improve the performance. Note that if you pass parameters in this way,
  420. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  421. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  422. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  423. * @return array the first column of the query result. Empty array if no result.
  424. * @throws CException execution failed
  425. */
  426. public function queryColumn($params=array())
  427. {
  428. return $this->queryInternal('fetchAll',array(PDO::FETCH_COLUMN, 0),$params);
  429. }
  430. /**
  431. * @param string $method method of PDOStatement to be called
  432. * @param mixed $mode parameters to be passed to the method
  433. * @param array $params input parameters (name=>value) for the SQL execution. This is an alternative
  434. * to {@link bindParam} and {@link bindValue}. If you have multiple input parameters, passing
  435. * them in this way can improve the performance. Note that if you pass parameters in this way,
  436. * you cannot bind parameters or values using {@link bindParam} or {@link bindValue}, and vice versa.
  437. * Please also note that all values are treated as strings in this case, if you need them to be handled as
  438. * their real data types, you have to use {@link bindParam} or {@link bindValue} instead.
  439. * @throws CDbException if CDbCommand failed to execute the SQL statement
  440. * @return mixed the method execution result
  441. */
  442. private function queryInternal($method,$mode,$params=array())
  443. {
  444. $params=array_merge($this->params,$params);
  445. if($this->_connection->enableParamLogging && ($pars=array_merge($this->_paramLog,$params))!==array())
  446. {
  447. $p=array();
  448. foreach($pars as $name=>$value)
  449. $p[$name]=$name.'='.var_export($value,true);
  450. $par='. Bound with '.implode(', ',$p);
  451. }
  452. else
  453. $par='';
  454. Yii::trace('Querying SQL: '.$this->getText().$par,'system.db.CDbCommand');
  455. if($this->_connection->queryCachingCount>0 && $method!==''
  456. && $this->_connection->queryCachingDuration>0
  457. && $this->_connection->queryCacheID!==false
  458. && ($cache=Yii::app()->getComponent($this->_connection->queryCacheID))!==null)
  459. {
  460. $this->_connection->queryCachingCount--;
  461. $cacheKey='yii:dbquery'.$this->_connection->connectionString.':'.$this->_connection->username;
  462. $cacheKey.=':'.$this->getText().':'.serialize(array_merge($this->_paramLog,$params));
  463. if(($result=$cache->get($cacheKey))!==false)
  464. {
  465. Yii::trace('Query result found in cache','system.db.CDbCommand');
  466. return $result[0];
  467. }
  468. }
  469. try
  470. {
  471. if($this->_connection->enableProfiling)
  472. Yii::beginProfile('system.db.CDbCommand.query('.$this->getText().$par.')','system.db.CDbCommand.query');
  473. $this->prepare();
  474. if($params===array())
  475. $this->_statement->execute();
  476. else
  477. $this->_statement->execute($params);
  478. if($method==='')
  479. $result=new CDbDataReader($this);
  480. else
  481. {
  482. $mode=(array)$mode;
  483. call_user_func_array(array($this->_statement, 'setFetchMode'), $mode);
  484. $result=$this->_statement->$method();
  485. $this->_statement->closeCursor();
  486. }
  487. if($this->_connection->enableProfiling)
  488. Yii::endProfile('system.db.CDbCommand.query('.$this->getText().$par.')','system.db.CDbCommand.query');
  489. if(isset($cache,$cacheKey))
  490. $cache->set($cacheKey, array($result), $this->_connection->queryCachingDuration, $this->_connection->queryCachingDependency);
  491. return $result;
  492. }
  493. catch(Exception $e)
  494. {
  495. if($this->_connection->enableProfiling)
  496. Yii::endProfile('system.db.CDbCommand.query('.$this->getText().$par.')','system.db.CDbCommand.query');
  497. $errorInfo=$e instanceof PDOException ? $e->errorInfo : null;
  498. $message=$e->getMessage();
  499. Yii::log(Yii::t('yii','CDbCommand::{method}() failed: {error}. The SQL statement executed was: {sql}.',
  500. array('{method}'=>$method, '{error}'=>$message, '{sql}'=>$this->getText().$par)),CLogger::LEVEL_ERROR,'system.db.CDbCommand');
  501. if(YII_DEBUG)
  502. $message.='. The SQL statement executed was: '.$this->getText().$par;
  503. throw new CDbException(Yii::t('yii','CDbCommand failed to execute the SQL statement: {error}',
  504. array('{error}'=>$message)),(int)$e->getCode(),$errorInfo);
  505. }
  506. }
  507. /**
  508. * Builds a SQL SELECT statement from the given query specification.
  509. * @param array $query the query specification in name-value pairs. The following
  510. * query options are supported: {@link select}, {@link distinct}, {@link from},
  511. * {@link where}, {@link join}, {@link group}, {@link having}, {@link order},
  512. * {@link limit}, {@link offset} and {@link union}.
  513. * @throws CDbException if "from" key is not present in given query parameter
  514. * @return string the SQL statement
  515. * @since 1.1.6
  516. */
  517. public function buildQuery($query)
  518. {
  519. $sql=!empty($query['distinct']) ? 'SELECT DISTINCT' : 'SELECT';
  520. $sql.=' '.(!empty($query['select']) ? $query['select'] : '*');
  521. if(!empty($query['from']))
  522. $sql.="\nFROM ".$query['from'];
  523. else
  524. throw new CDbException(Yii::t('yii','The DB query must contain the "from" portion.'));
  525. if(!empty($query['join']))
  526. $sql.="\n".(is_array($query['join']) ? implode("\n",$query['join']) : $query['join']);
  527. if(!empty($query['where']))
  528. $sql.="\nWHERE ".$query['where'];
  529. if(!empty($query['group']))
  530. $sql.="\nGROUP BY ".$query['group'];
  531. if(!empty($query['having']))
  532. $sql.="\nHAVING ".$query['having'];
  533. if(!empty($query['union']))
  534. $sql.="\nUNION (\n".(is_array($query['union']) ? implode("\n) UNION (\n",$query['union']) : $query['union']) . ')';
  535. if(!empty($query['order']))
  536. $sql.="\nORDER BY ".$query['order'];
  537. $limit=isset($query['limit']) ? (int)$query['limit'] : -1;
  538. $offset=isset($query['offset']) ? (int)$query['offset'] : -1;
  539. if($limit>=0 || $offset>0)
  540. $sql=$this->_connection->getCommandBuilder()->applyLimit($sql,$limit,$offset);
  541. return $sql;
  542. }
  543. /**
  544. * Sets the SELECT part of the query.
  545. * @param mixed $columns the columns to be selected. Defaults to '*', meaning all columns.
  546. * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')).
  547. * Columns can contain table prefixes (e.g. "tbl_user.id") and/or column aliases (e.g. "tbl_user.id AS user_id").
  548. * The method will automatically quote the column names unless a column contains some parenthesis
  549. * (which means the column contains a DB expression).
  550. * @param string $option additional option that should be appended to the 'SELECT' keyword. For example,
  551. * in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used. This parameter is supported since version 1.1.8.
  552. * @return CDbCommand the command object itself
  553. * @since 1.1.6
  554. */
  555. public function select($columns='*', $option='')
  556. {
  557. if(is_string($columns) && strpos($columns,'(')!==false)
  558. $this->_query['select']=$columns;
  559. else
  560. {
  561. if(!is_array($columns))
  562. $columns=preg_split('/\s*,\s*/',trim($columns),-1,PREG_SPLIT_NO_EMPTY);
  563. foreach($columns as $i=>$column)
  564. {
  565. if(is_object($column))
  566. $columns[$i]=(string)$column;
  567. elseif(strpos($column,'(')===false)
  568. {
  569. if(preg_match('/^(.*?)(?i:\s+as\s+|\s+)(.*)$/',$column,$matches))
  570. $columns[$i]=$this->_connection->quoteColumnName($matches[1]).' AS '.$this->_connection->quoteColumnName($matches[2]);
  571. else
  572. $columns[$i]=$this->_connection->quoteColumnName($column);
  573. }
  574. }
  575. $this->_query['select']=implode(', ',$columns);
  576. }
  577. if($option!='')
  578. $this->_query['select']=$option.' '.$this->_query['select'];
  579. return $this;
  580. }
  581. /**
  582. * Returns the SELECT part in the query.
  583. * @return string the SELECT part (without 'SELECT') in the query.
  584. * @since 1.1.6
  585. */
  586. public function getSelect()
  587. {
  588. return isset($this->_query['select']) ? $this->_query['select'] : '';
  589. }
  590. /**
  591. * Sets the SELECT part in the query.
  592. * @param mixed $value the data to be selected. Please refer to {@link select()} for details
  593. * on how to specify this parameter.
  594. * @since 1.1.6
  595. */
  596. public function setSelect($value)
  597. {
  598. $this->select($value);
  599. }
  600. /**
  601. * Sets the SELECT part of the query with the DISTINCT flag turned on.
  602. * This is the same as {@link select} except that the DISTINCT flag is turned on.
  603. * @param mixed $columns the columns to be selected. See {@link select} for more details.
  604. * @return CDbCommand the command object itself
  605. * @since 1.1.6
  606. */
  607. public function selectDistinct($columns='*')
  608. {
  609. $this->_query['distinct']=true;
  610. return $this->select($columns);
  611. }
  612. /**
  613. * Returns a value indicating whether SELECT DISTINCT should be used.
  614. * @return boolean a value indicating whether SELECT DISTINCT should be used.
  615. * @since 1.1.6
  616. */
  617. public function getDistinct()
  618. {
  619. return isset($this->_query['distinct']) ? $this->_query['distinct'] : false;
  620. }
  621. /**
  622. * Sets a value indicating whether SELECT DISTINCT should be used.
  623. * @param boolean $value a value indicating whether SELECT DISTINCT should be used.
  624. * @since 1.1.6
  625. */
  626. public function setDistinct($value)
  627. {
  628. $this->_query['distinct']=$value;
  629. }
  630. /**
  631. * Sets the FROM part of the query.
  632. * @param mixed $tables the table(s) to be selected from. This can be either a string (e.g. 'tbl_user')
  633. * or an array (e.g. array('tbl_user', 'tbl_profile')) specifying one or several table names.
  634. * Table names can contain schema prefixes (e.g. 'public.tbl_user') and/or table aliases (e.g. 'tbl_user u').
  635. * The method will automatically quote the table names unless it contains some parenthesis
  636. * (which means the table is given as a sub-query or DB expression).
  637. * @return CDbCommand the command object itself
  638. * @since 1.1.6
  639. */
  640. public function from($tables)
  641. {
  642. if(is_string($tables) && strpos($tables,'(')!==false)
  643. $this->_query['from']=$tables;
  644. else
  645. {
  646. if(!is_array($tables))
  647. $tables=preg_split('/\s*,\s*/',trim($tables),-1,PREG_SPLIT_NO_EMPTY);
  648. foreach($tables as $i=>$table)
  649. {
  650. if(strpos($table,'(')===false)
  651. {
  652. if(preg_match('/^(.*?)(?i:\s+as\s+|\s+)(.*)$/',$table,$matches)) // with alias
  653. $tables[$i]=$this->_connection->quoteTableName($matches[1]).' '.$this->_connection->quoteTableName($matches[2]);
  654. else
  655. $tables[$i]=$this->_connection->quoteTableName($table);
  656. }
  657. }
  658. $this->_query['from']=implode(', ',$tables);
  659. }
  660. return $this;
  661. }
  662. /**
  663. * Returns the FROM part in the query.
  664. * @return string the FROM part (without 'FROM' ) in the query.
  665. * @since 1.1.6
  666. */
  667. public function getFrom()
  668. {
  669. return isset($this->_query['from']) ? $this->_query['from'] : '';
  670. }
  671. /**
  672. * Sets the FROM part in the query.
  673. * @param mixed $value the tables to be selected from. Please refer to {@link from()} for details
  674. * on how to specify this parameter.
  675. * @since 1.1.6
  676. */
  677. public function setFrom($value)
  678. {
  679. $this->from($value);
  680. }
  681. /**
  682. * Sets the WHERE part of the query.
  683. *
  684. * The method requires a $conditions parameter, and optionally a $params parameter
  685. * specifying the values to be bound to the query.
  686. *
  687. * The $conditions parameter should be either a string (e.g. 'id=1') or an array.
  688. * If the latter, it must be of the format <code>array(operator, operand1, operand2, ...)</code>,
  689. * where the operator can be one of the followings, and the possible operands depend on the corresponding
  690. * operator:
  691. * <ul>
  692. * <li><code>and</code>: the operands should be concatenated together using AND. For example,
  693. * array('and', 'id=1', 'id=2') will generate 'id=1 AND id=2'. If an operand is an array,
  694. * it will be converted into a string using the same rules described here. For example,
  695. * array('and', 'type=1', array('or', 'id=1', 'id=2')) will generate 'type=1 AND (id=1 OR id=2)'.
  696. * The method will NOT do any quoting or escaping.</li>
  697. * <li><code>or</code>: similar as the <code>and</code> operator except that the operands are concatenated using OR.</li>
  698. * <li><code>in</code>: operand 1 should be a column or DB expression, and operand 2 be an array representing
  699. * the range of the values that the column or DB expression should be in. For example,
  700. * array('in', 'id', array(1,2,3)) will generate 'id IN (1,2,3)'.
  701. * The method will properly quote the column name and escape values in the range.</li>
  702. * <li><code>not in</code>: similar as the <code>in</code> operator except that IN is replaced with NOT IN in the generated condition.</li>
  703. * <li><code>like</code>: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing
  704. * the values that the column or DB expression should be like.
  705. * For example, array('like', 'name', '%tester%') will generate "name LIKE '%tester%'".
  706. * When the value range is given as an array, multiple LIKE predicates will be generated and concatenated using AND.
  707. * For example, array('like', 'name', array('%test%', '%sample%')) will generate
  708. * "name LIKE '%test%' AND name LIKE '%sample%'".
  709. * The method will properly quote the column name and escape values in the range.</li>
  710. * <li><code>not like</code>: similar as the <code>like</code> operator except that LIKE is replaced with NOT LIKE in the generated condition.</li>
  711. * <li><code>or like</code>: similar as the <code>like</code> operator except that OR is used to concatenated the LIKE predicates.</li>
  712. * <li><code>or not like</code>: similar as the <code>not like</code> operator except that OR is used to concatenated the NOT LIKE predicates.</li>
  713. * </ul>
  714. * @param mixed $conditions the conditions that should be put in the WHERE part.
  715. * @param array $params the parameters (name=>value) to be bound to the query
  716. * @return CDbCommand the command object itself
  717. * @since 1.1.6
  718. */
  719. public function where($conditions, $params=array())
  720. {
  721. $this->_query['where']=$this->processConditions($conditions);
  722. foreach($params as $name=>$value)
  723. $this->params[$name]=$value;
  724. return $this;
  725. }
  726. /**
  727. * Appends given condition to the existing WHERE part of the query with 'AND' operator.
  728. *
  729. * This method works almost the same way as {@link where} except the fact that it appends condition
  730. * with 'AND' operator, but not replaces it with the new one. For more information on parameters
  731. * of this method refer to the {@link where} documentation.
  732. *
  733. * @param mixed $conditions the conditions that should be appended to the WHERE part.
  734. * @param array $params the parameters (name=>value) to be bound to the query.
  735. * @return CDbCommand the command object itself.
  736. * @since 1.1.13
  737. */
  738. public function andWhere($conditions,$params=array())
  739. {
  740. if(isset($this->_query['where']))
  741. $this->_query['where']=$this->processConditions(array('AND',$this->_query['where'],$conditions));
  742. else
  743. $this->_query['where']=$this->processConditions($conditions);
  744. foreach($params as $name=>$value)
  745. $this->params[$name]=$value;
  746. return $this;
  747. }
  748. /**
  749. * Appends given condition to the existing WHERE part of the query with 'OR' operator.
  750. *
  751. * This method works almost the same way as {@link where} except the fact that it appends condition
  752. * with 'OR' operator, but not replaces it with the new one. For more information on parameters
  753. * of this method refer to the {@link where} documentation.
  754. *
  755. * @param mixed $conditions the conditions that should be appended to the WHERE part.
  756. * @param array $params the parameters (name=>value) to be bound to the query.
  757. * @return CDbCommand the command object itself.
  758. * @since 1.1.13
  759. */
  760. public function orWhere($conditions,$params=array())
  761. {
  762. if(isset($this->_query['where']))
  763. $this->_query['where']=$this->processConditions(array('OR',$this->_query['where'],$conditions));
  764. else
  765. $this->_query['where']=$this->processConditions($conditions);
  766. foreach($params as $name=>$value)
  767. $this->params[$name]=$value;
  768. return $this;
  769. }
  770. /**
  771. * Returns the WHERE part in the query.
  772. * @return string the WHERE part (without 'WHERE' ) in the query.
  773. * @since 1.1.6
  774. */
  775. public function getWhere()
  776. {
  777. return isset($this->_query['where']) ? $this->_query['where'] : '';
  778. }
  779. /**
  780. * Sets the WHERE part in the query.
  781. * @param mixed $value the where part. Please refer to {@link where()} for details
  782. * on how to specify this parameter.
  783. * @since 1.1.6
  784. */
  785. public function setWhere($value)
  786. {
  787. $this->where($value);
  788. }
  789. /**
  790. * Appends an INNER JOIN part to the query.
  791. * @param string $table the table to be joined.
  792. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  793. * The method will automatically quote the table name unless it contains some parenthesis
  794. * (which means the table is given as a sub-query or DB expression).
  795. * @param mixed $conditions the join condition that should appear in the ON part.
  796. * Please refer to {@link where} on how to specify conditions.
  797. * @param array $params the parameters (name=>value) to be bound to the query
  798. * @return CDbCommand the command object itself
  799. * @since 1.1.6
  800. */
  801. public function join($table, $conditions, $params=array())
  802. {
  803. return $this->joinInternal('join', $table, $conditions, $params);
  804. }
  805. /**
  806. * Returns the join part in the query.
  807. * @return mixed the join part in the query. This can be an array representing
  808. * multiple join fragments, or a string representing a single jojin fragment.
  809. * Each join fragment will contain the proper join operator (e.g. LEFT JOIN).
  810. * @since 1.1.6
  811. */
  812. public function getJoin()
  813. {
  814. return isset($this->_query['join']) ? $this->_query['join'] : '';
  815. }
  816. /**
  817. * Sets the join part in the query.
  818. * @param mixed $value the join part in the query. This can be either a string or
  819. * an array representing multiple join parts in the query. Each part must contain
  820. * the proper join operator (e.g. 'LEFT JOIN tbl_profile ON tbl_user.id=tbl_profile.id')
  821. * @since 1.1.6
  822. */
  823. public function setJoin($value)
  824. {
  825. $this->_query['join']=$value;
  826. }
  827. /**
  828. * Appends a LEFT OUTER JOIN part to the query.
  829. * @param string $table the table to be joined.
  830. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  831. * The method will automatically quote the table name unless it contains some parenthesis
  832. * (which means the table is given as a sub-query or DB expression).
  833. * @param mixed $conditions the join condition that should appear in the ON part.
  834. * Please refer to {@link where} on how to specify conditions.
  835. * @param array $params the parameters (name=>value) to be bound to the query
  836. * @return CDbCommand the command object itself
  837. * @since 1.1.6
  838. */
  839. public function leftJoin($table, $conditions, $params=array())
  840. {
  841. return $this->joinInternal('left join', $table, $conditions, $params);
  842. }
  843. /**
  844. * Appends a RIGHT OUTER JOIN part to the query.
  845. * @param string $table the table to be joined.
  846. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  847. * The method will automatically quote the table name unless it contains some parenthesis
  848. * (which means the table is given as a sub-query or DB expression).
  849. * @param mixed $conditions the join condition that should appear in the ON part.
  850. * Please refer to {@link where} on how to specify conditions.
  851. * @param array $params the parameters (name=>value) to be bound to the query
  852. * @return CDbCommand the command object itself
  853. * @since 1.1.6
  854. */
  855. public function rightJoin($table, $conditions, $params=array())
  856. {
  857. return $this->joinInternal('right join', $table, $conditions, $params);
  858. }
  859. /**
  860. * Appends a CROSS JOIN part to the query.
  861. * Note that not all DBMS support CROSS JOIN.
  862. * @param string $table the table to be joined.
  863. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  864. * The method will automatically quote the table name unless it contains some parenthesis
  865. * (which means the table is given as a sub-query or DB expression).
  866. * @return CDbCommand the command object itself
  867. * @since 1.1.6
  868. */
  869. public function crossJoin($table)
  870. {
  871. return $this->joinInternal('cross join', $table);
  872. }
  873. /**
  874. * Appends a NATURAL JOIN part to the query.
  875. * Note that not all DBMS support NATURAL JOIN.
  876. * @param string $table the table to be joined.
  877. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  878. * The method will automatically quote the table name unless it contains some parenthesis
  879. * (which means the table is given as a sub-query or DB expression).
  880. * @return CDbCommand the command object itself
  881. * @since 1.1.6
  882. */
  883. public function naturalJoin($table)
  884. {
  885. return $this->joinInternal('natural join', $table);
  886. }
  887. /**
  888. * Sets the GROUP BY part of the query.
  889. * @param mixed $columns the columns to be grouped by.
  890. * Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')).
  891. * The method will automatically quote the column names unless a column contains some parenthesis
  892. * (which means the column contains a DB expression).
  893. * @return CDbCommand the command object itself
  894. * @since 1.1.6
  895. */
  896. public function group($columns)
  897. {
  898. if(is_string($columns) && strpos($columns,'(')!==false)
  899. $this->_query['group']=$columns;
  900. else
  901. {
  902. if(!is_array($columns))
  903. $columns=preg_split('/\s*,\s*/',trim($columns),-1,PREG_SPLIT_NO_EMPTY);
  904. foreach($columns as $i=>$column)
  905. {
  906. if(is_object($column))
  907. $columns[$i]=(string)$column;
  908. elseif(strpos($column,'(')===false)
  909. $columns[$i]=$this->_connection->quoteColumnName($column);
  910. }
  911. $this->_query['group']=implode(', ',$columns);
  912. }
  913. return $this;
  914. }
  915. /**
  916. * Returns the GROUP BY part in the query.
  917. * @return string the GROUP BY part (without 'GROUP BY' ) in the query.
  918. * @since 1.1.6
  919. */
  920. public function getGroup()
  921. {
  922. return isset($this->_query['group']) ? $this->_query['group'] : '';
  923. }
  924. /**
  925. * Sets the GROUP BY part in the query.
  926. * @param mixed $value the GROUP BY part. Please refer to {@link group()} for details
  927. * on how to specify this parameter.
  928. * @since 1.1.6
  929. */
  930. public function setGroup($value)
  931. {
  932. $this->group($value);
  933. }
  934. /**
  935. * Sets the HAVING part of the query.
  936. * @param mixed $conditions the conditions to be put after HAVING.
  937. * Please refer to {@link where} on how to specify conditions.
  938. * @param array $params the parameters (name=>value) to be bound to the query
  939. * @return CDbCommand the command object itself
  940. * @since 1.1.6
  941. */
  942. public function having($conditions, $params=array())
  943. {
  944. $this->_query['having']=$this->processConditions($conditions);
  945. foreach($params as $name=>$value)
  946. $this->params[$name]=$value;
  947. return $this;
  948. }
  949. /**
  950. * Returns the HAVING part in the query.
  951. * @return string the HAVING part (without 'HAVING' ) in the query.
  952. * @since 1.1.6
  953. */
  954. public function getHaving()
  955. {
  956. return isset($this->_query['having']) ? $this->_query['having'] : '';
  957. }
  958. /**
  959. * Sets the HAVING part in the query.
  960. * @param mixed $value the HAVING part. Please refer to {@link having()} for details
  961. * on how to specify this parameter.
  962. * @since 1.1.6
  963. */
  964. public function setHaving($value)
  965. {
  966. $this->having($value);
  967. }
  968. /**
  969. * Sets the ORDER BY part of the query.
  970. * @param mixed $columns the columns (and the directions) to be ordered by.
  971. * Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. array('id ASC', 'name DESC')).
  972. * The method will automatically quote the column names unless a column contains some parenthesis
  973. * (which means the column contains a DB expression).
  974. *
  975. * For example, to get "ORDER BY 1" you should use
  976. *
  977. * <pre>
  978. * $criteria->order('(1)');
  979. * </pre>
  980. *
  981. * @return CDbCommand the command object itself
  982. * @since 1.1.6
  983. */
  984. public function order($columns)
  985. {
  986. if(is_string($columns) && strpos($columns,'(')!==false)
  987. $this->_query['order']=$columns;
  988. else
  989. {
  990. if(!is_array($columns))
  991. $columns=preg_split('/\s*,\s*/',trim($columns),-1,PREG_SPLIT_NO_EMPTY);
  992. foreach($columns as $i=>$column)
  993. {
  994. if(is_object($column))
  995. $columns[$i]=(string)$column;
  996. elseif(strpos($column,'(')===false)
  997. {
  998. if(preg_match('/^(.*?)\s+(asc|desc)$/i',$column,$matches))
  999. $columns[$i]=$this->_connection->quoteColumnName($matches[1]).' '.strtoupper($matches[2]);
  1000. else
  1001. $columns[$i]=$this->_connection->quoteColumnName($column);
  1002. }
  1003. }
  1004. $this->_query['order']=implode(', ',$columns);
  1005. }
  1006. return $this;
  1007. }
  1008. /**
  1009. * Returns the ORDER BY part in the query.
  1010. * @return string the ORDER BY part (without 'ORDER BY' ) in the query.
  1011. * @since 1.1.6
  1012. */
  1013. public function getOrder()
  1014. {
  1015. return isset($this->_query['order']) ? $this->_query['order'] : '';
  1016. }
  1017. /**
  1018. * Sets the ORDER BY part in the query.
  1019. * @param mixed $value the ORDER BY part. Please refer to {@link order()} for details
  1020. * on how to specify this parameter.
  1021. * @since 1.1.6
  1022. */
  1023. public function setOrder($value)
  1024. {
  1025. $this->order($value);
  1026. }
  1027. /**
  1028. * Sets the LIMIT part of the query.
  1029. * @param integer $limit the limit
  1030. * @param integer $offset the offset
  1031. * @return CDbCommand the command object itself
  1032. * @since 1.1.6
  1033. */
  1034. public function limit($limit, $offset=null)
  1035. {
  1036. $this->_query['limit']=(int)$limit;
  1037. if($offset!==null)
  1038. $this->offset($offset);
  1039. return $this;
  1040. }
  1041. /**
  1042. * Returns the LIMIT part in the query.
  1043. * @return string the LIMIT part (without 'LIMIT' ) in the query.
  1044. * @since 1.1.6
  1045. */
  1046. public function getLimit()
  1047. {
  1048. return isset($this->_query['limit']) ? $this->_query['limit'] : -1;
  1049. }
  1050. /**
  1051. * Sets the LIMIT part in the query.
  1052. * @param integer $value the LIMIT part. Please refer to {@link limit()} for details
  1053. * on how to specify this parameter.
  1054. * @since 1.1.6
  1055. */
  1056. public function setLimit($value)
  1057. {
  1058. $this->limit($value);
  1059. }
  1060. /**
  1061. * Sets the OFFSET part of the query.
  1062. * @param integer $offset the offset
  1063. * @return CDbCommand the command object itself
  1064. * @since 1.1.6
  1065. */
  1066. public function offset($offset)
  1067. {
  1068. $this->_query['offset']=(int)$offset;
  1069. return $this;
  1070. }
  1071. /**
  1072. * Returns the OFFSET part in the query.
  1073. * @return string the OFFSET part (without 'OFFSET' ) in the query.
  1074. * @since 1.1.6
  1075. */
  1076. public function getOffset()
  1077. {
  1078. return isset($this->_query['offset']) ? $this->_query['offset'] : -1;
  1079. }
  1080. /**
  1081. * Sets the OFFSET part in the query.
  1082. * @param integer $value the OFFSET part. Please refer to {@link offset()} for details
  1083. * on how to specify this parameter.
  1084. * @since 1.1.6
  1085. */
  1086. public function setOffset($value)
  1087. {
  1088. $this->offset($value);
  1089. }
  1090. /**
  1091. * Appends a SQL statement using UNION operator.
  1092. * @param string $sql the SQL statement to be appended using UNION
  1093. * @return CDbCommand the command object itself
  1094. * @since 1.1.6
  1095. */
  1096. public function union($sql)
  1097. {
  1098. if(isset($this->_query['union']) && is_string($this->_query['union']))
  1099. $this->_query['union']=array($this->_query['union']);
  1100. $this->_query['union'][]=$sql;
  1101. return $this;
  1102. }
  1103. /**
  1104. * Returns the UNION part in the query.
  1105. * @return mixed the UNION part (without 'UNION' ) in the query.
  1106. * This can be either a string or an array representing multiple union parts.
  1107. * @since 1.1.6
  1108. */
  1109. public function getUnion()
  1110. {
  1111. return isset($this->_query['union']) ? $this->_query['union'] : '';
  1112. }
  1113. /**
  1114. * Sets the UNION part in the query.
  1115. * @param mixed $value the UNION part. This can be either a string or an array
  1116. * representing multiple SQL statements to be unioned together.
  1117. * @since 1.1.6
  1118. */
  1119. public function setUnion($value)
  1120. {
  1121. $this->_query['union']=$value;
  1122. }
  1123. /**
  1124. * Creates and executes an INSERT SQL statement.
  1125. * The method will properly escape the column names, and bind the values to be inserted.
  1126. * @param string $table the table that new rows will be inserted into.
  1127. * @param array $columns the column data (name=>value) to be inserted into the table.
  1128. * @return integer number of rows affected by the execution.
  1129. * @since 1.1.6
  1130. */
  1131. public function insert($table, $columns)
  1132. {
  1133. $params=array();
  1134. $names=array();
  1135. $placeholders=array();
  1136. foreach($columns as $name=>$value)
  1137. {
  1138. $names[]=$this->_connection->quoteColumnName($name);
  1139. if($value instanceof CDbExpression)
  1140. {
  1141. $placeholders[] = $value->expression;
  1142. foreach($value->params as $n => $v)
  1143. $params[$n] = $v;
  1144. }
  1145. else
  1146. {
  1147. $placeholders[] = ':' . $name;
  1148. $params[':' . $name] = $value;
  1149. }
  1150. }
  1151. $sql='INSERT INTO ' . $this->_connection->quoteTableName($table)
  1152. . ' (' . implode(', ',$names) . ') VALUES ('
  1153. . implode(', ', $placeholders) . ')';
  1154. return $this->setText($sql)->execute($params);
  1155. }
  1156. /**
  1157. * Creates and executes an UPDATE SQL statement.
  1158. * The method will properly escape the column names and bind the values to be updated.
  1159. * @param string $table the table to be updated.
  1160. * @param array $columns the column data (name=>value) to be updated.
  1161. * @param mixed $conditions the conditions that will be put in the WHERE part. Please
  1162. * refer to {@link where} on how to specify conditions.
  1163. * @param array $params the parameters to be bound to the query.
  1164. * Do not use column names as parameter names here. They are reserved for <code>$columns</code> parameter.
  1165. * @return integer number of rows affected by the execution.
  1166. * @since 1.1.6
  1167. */
  1168. public function update($table, $columns, $conditions='', $params=array())
  1169. {
  1170. $lines=array();
  1171. foreach($columns as $name=>$value)
  1172. {
  1173. if($value instanceof CDbExpression)
  1174. {
  1175. $lines[]=$this->_connection->quoteColumnName($name) . '=' . $value->expression;
  1176. foreach($value->params as $n => $v)
  1177. $params[$n] = $v;
  1178. }
  1179. else
  1180. {
  1181. $lines[]=$this->_connection->quoteColumnName($name) . '=:' . $name;
  1182. $params[':' . $name]=$value;
  1183. }
  1184. }
  1185. $sql='UPDATE ' . $this->_connection->quoteTableName($table) . ' SET ' . implode(', ', $lines);
  1186. if(($where=$this->processConditions($conditions))!='')
  1187. $sql.=' WHERE '.$where;
  1188. return $this->setText($sql)->execute($params);
  1189. }
  1190. /**
  1191. * Creates and executes a DELETE SQL statement.
  1192. * @param string $table the table where the data will be deleted from.
  1193. * @param mixed $conditions the conditions that will be put in the WHERE part. Please
  1194. * refer to {@link where} on how to specify conditions.
  1195. * @param array $params the parameters to be bound to the query.
  1196. * @return integer number of rows affected by the execution.
  1197. * @since 1.1.6
  1198. */
  1199. public function delete($table, $conditions='', $params=array())
  1200. {
  1201. $sql='DELETE FROM ' . $this->_connection->quoteTableName($table);
  1202. if(($where=$this->processConditions($conditions))!='')
  1203. $sql.=' WHERE '.$where;
  1204. return $this->setText($sql)->execute($params);
  1205. }
  1206. /**
  1207. * Builds and executes a SQL statement for creating a new DB table.
  1208. *
  1209. * The columns in the new table should be specified as name-definition pairs (e.g. 'name'=>'string'),
  1210. * where name stands for a column name which will be properly quoted by the method, and definition
  1211. * stands for the column type which can contain an abstract DB type.
  1212. * The {@link getColumnType} method will be invoked to convert any abstract type into a physical one.
  1213. *
  1214. * If a column is specified with definition only (e.g. 'PRIMARY KEY (name, type)'), it will be directly
  1215. * inserted into the generated SQL.
  1216. *
  1217. * @param string $table the name of the table to be created. The name will be properly quoted by the method.
  1218. * @param array $columns the columns (name=>definition) in the new table.
  1219. * @param string $options additional SQL fragment that will be appended to the generated SQL.
  1220. * @return integer 0 is always returned. See {@link http://php.net/manual/en/pdostatement.rowcount.php} for more information.
  1221. * @since 1.1.6
  1222. */
  1223. public function createTable($table, $columns, $options=null)
  1224. {
  1225. return $this->setText($this->getConnection()->getSchema()->createTable($table, $columns, $options))->execute();
  1226. }
  1227. /**
  1228. * Builds and executes a SQL statement for renaming a DB table.
  1229. * @param string $table the table to be renamed. The name will be properly quoted by the method.
  1230. * @param string $newName the new table name. The name will be properly quoted by the method.
  1231. * @return integer 0 is always returned. See {@link http://php.net/manual/en/pdostatement.rowcount.php} for more information.
  1232. * @since 1.1.6
  1233. */
  1234. public function renameTable($table, $newName)
  1235. {
  1236. return $this->setText($this->getConnection()->getSchema()->renameTable($table, $newName))->execute();
  1237. }
  1238. /**
  1239. * Builds and executes a SQL statement for dropping a DB table.
  1240. * @param string $table the table to be dropped. The name will be properly quoted by the method.
  1241. * @return integer 0 is always returned. See {@link http://php.net/manual/en/pdostatement.rowcount.php} for more information.
  1242. * @since 1.1.6
  1243. */
  1244. public function dropTable($table)
  1245. {
  1246. return $this->setText($this->getConnection()->getSchema()->dropTable($table))->execute();
  1247. }
  1248. /**
  1249. * Builds and executes a SQL statement for truncating a DB table.
  1250. * @param string $table the table to be truncated. The name will be properly quoted by the method.
  1251. * @return integer number of rows affected by the execution.
  1252. * @since 1.1.6
  1253. */
  1254. public function truncateTable($table)
  1255. {
  1256. $schema=$this->getConnection()->getSchema();
  1257. $n=$this->setText($schema->truncateTable($table))->execute();
  1258. if(strncasecmp($this->getConnection()->getDriverName(),'sqlite',6)===0)
  1259. $schema->resetSequence($schema->getTable($table));
  1260. return $n;
  1261. }
  1262. /**
  1263. * Builds and executes a SQL statement for adding a new DB column.
  1264. * @param string $table the table that the new column will be added to. The table name will be properly quoted by the method.
  1265. * @param string $column the name of the new column. The name will be properly quoted by the method.
  1266. * @param string $type the column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any)
  1267. * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
  1268. * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
  1269. * @return integer number of rows affected by the execution.
  1270. * @since 1.1.6
  1271. */
  1272. public function addColumn($table, $column, $type)
  1273. {
  1274. return $this->setText($this->getConnection()->getSchema()->addColumn($table, $column, $type))->execute();
  1275. }
  1276. /**
  1277. * Builds and executes a SQL statement for dropping a DB column.
  1278. * @param string $table the table whose column is to be dropped. The name will be properly quoted by the method.
  1279. * @param string $column the name of the column to be dropped. The name will be properly quoted by the method.
  1280. * @return integer number of rows affected by the execution.
  1281. * @since 1.1.6
  1282. */
  1283. public function dropColumn($table, $column)
  1284. {
  1285. return $this->setText($this->getConnection()->getSchema()->dropColumn($table, $column))->execute();
  1286. }
  1287. /**
  1288. * Builds and executes a SQL statement for renaming a column.
  1289. * @param string $table the table whose column is to be renamed. The name will be properly quoted by the method.
  1290. * @param string $name the old name of the column. The name will be properly quoted by the method.
  1291. * @param string $newName the new name of the column. The name will be properly quoted by the method.
  1292. * @return integer number of rows affected by the execution.
  1293. * @since 1.1.6
  1294. */
  1295. public function renameColumn($table, $name, $newName)
  1296. {
  1297. return $this->setText($this->getConnection()->getSchema()->renameColumn($table, $name, $newName))->execute();
  1298. }
  1299. /**
  1300. * Builds and executes a SQL statement for changing the definition of a column.
  1301. * @param string $table the table whose column is to be changed. The table name will be properly quoted by the method.
  1302. * @param string $column the name of the column to be changed. The name will be properly quoted by the method.
  1303. * @param string $type the new column type. The {@link getColumnType} method will be invoked to convert abstract column type (if any)
  1304. * into the physical one. Anything that is not recognized as abstract type will be kept in the generated SQL.
  1305. * For example, 'string' will be turned into 'varchar(255)', while 'string not null' will become 'varchar(255) not null'.
  1306. * @return integer number of rows affected by the execution.
  1307. * @since 1.1.6
  1308. */
  1309. public function alterColumn($table, $column, $type)
  1310. {
  1311. return $this->setText($this->getConnection()->getSchema()->alterColumn($table, $column, $type))->execute();
  1312. }
  1313. /**
  1314. * Builds a SQL statement for adding a foreign key constraint to an existing table.
  1315. * The method will properly quote the table and column names.
  1316. * @param string $name the name of the foreign key constraint.
  1317. * @param string $table the table that the foreign key constraint will be added to.
  1318. * @param string $columns the name of the column to that the constraint will be added on. If there are multiple columns, separate them with commas.
  1319. * @param string $refTable the table that the foreign key references to.
  1320. * @param string $refColumns the name of the column that the foreign key references to. If there are multiple columns, separate them with commas.
  1321. * @param string $delete the ON DELETE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
  1322. * @param string $update the ON UPDATE option. Most DBMS support these options: RESTRICT, CASCADE, NO ACTION, SET DEFAULT, SET NULL
  1323. * @return integer number of rows affected by the execution.
  1324. * @since 1.1.6
  1325. */
  1326. public function addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete=null, $update=null)
  1327. {
  1328. return $this->setText($this->getConnection()->getSchema()->addForeignKey($name, $table, $columns, $refTable, $refColumns, $delete, $update))->execute();
  1329. }
  1330. /**
  1331. * Builds a SQL statement for dropping a foreign key constraint.
  1332. * @param string $name the name of the foreign key constraint to be dropped. The name will be properly quoted by the method.
  1333. * @param string $table the table whose foreign is to be dropped. The name will be properly quoted by the method.
  1334. * @return integer number of rows affected by the execution.
  1335. * @since 1.1.6
  1336. */
  1337. public function dropForeignKey($name, $table)
  1338. {
  1339. return $this->setText($this->getConnection()->getSchema()->dropForeignKey($name, $table))->execute();
  1340. }
  1341. /**
  1342. * Builds and executes a SQL statement for creating a new index.
  1343. * @param string $name the name of the index. The name will be properly quoted by the method.
  1344. * @param string $table the table that the new index will be created for. The table name will be properly quoted by the method.
  1345. * @param string $column the column(s) that should be included in the index. If there are multiple columns, please separate them
  1346. * by commas. The column names will be properly quoted by the method.
  1347. * @param boolean $unique whether to add UNIQUE constraint on the created index.
  1348. * @return integer number of rows affected by the execution.
  1349. * @since 1.1.6
  1350. */
  1351. public function createIndex($name, $table, $column, $unique=false)
  1352. {
  1353. return $this->setText($this->getConnection()->getSchema()->createIndex($name, $table, $column, $unique))->execute();
  1354. }
  1355. /**
  1356. * Builds and executes a SQL statement for dropping an index.
  1357. * @param string $name the name of the index to be dropped. The name will be properly quoted by the method.
  1358. * @param string $table the table whose index is to be dropped. The name will be properly quoted by the method.
  1359. * @return integer number of rows affected by the execution.
  1360. * @since 1.1.6
  1361. */
  1362. public function dropIndex($name, $table)
  1363. {
  1364. return $this->setText($this->getConnection()->getSchema()->dropIndex($name, $table))->execute();
  1365. }
  1366. /**
  1367. * Generates the condition string that will be put in the WHERE part
  1368. * @param mixed $conditions the conditions that will be put in the WHERE part.
  1369. * @throws CDbException if unknown operator is used
  1370. * @return string the condition string to put in the WHERE part
  1371. */
  1372. private function processConditions($conditions)
  1373. {
  1374. if(!is_array($conditions))
  1375. return $conditions;
  1376. elseif($conditions===array())
  1377. return '';
  1378. $n=count($conditions);
  1379. $operator=strtoupper($conditions[0]);
  1380. if($operator==='OR' || $operator==='AND')
  1381. {
  1382. $parts=array();
  1383. for($i=1;$i<$n;++$i)
  1384. {
  1385. $condition=$this->processConditions($conditions[$i]);
  1386. if($condition!=='')
  1387. $parts[]='('.$condition.')';
  1388. }
  1389. return $parts===array() ? '' : implode(' '.$operator.' ', $parts);
  1390. }
  1391. if(!isset($conditions[1],$conditions[2]))
  1392. return '';
  1393. $column=$conditions[1];
  1394. if(strpos($column,'(')===false)
  1395. $column=$this->_connection->quoteColumnName($column);
  1396. $values=$conditions[2];
  1397. if(!is_array($values))
  1398. $values=array($values);
  1399. if($operator==='IN' || $operator==='NOT IN')
  1400. {
  1401. if($values===array())
  1402. return $operator==='IN' ? '0=1' : '';
  1403. foreach($values as $i=>$value)
  1404. {
  1405. if(is_string($value))
  1406. $values[$i]=$this->_connection->quoteValue($value);
  1407. else
  1408. $values[$i]=(string)$value;
  1409. }
  1410. return $column.' '.$operator.' ('.implode(', ',$values).')';
  1411. }
  1412. if($operator==='LIKE' || $operator==='NOT LIKE' || $operator==='OR LIKE' || $operator==='OR NOT LIKE')
  1413. {
  1414. if($values===array())
  1415. return $operator==='LIKE' || $operator==='OR LIKE' ? '0=1' : '';
  1416. if($operator==='LIKE' || $operator==='NOT LIKE')
  1417. $andor=' AND ';
  1418. else
  1419. {
  1420. $andor=' OR ';
  1421. $operator=$operator==='OR LIKE' ? 'LIKE' : 'NOT LIKE';
  1422. }
  1423. $expressions=array();
  1424. foreach($values as $value)
  1425. $expressions[]=$column.' '.$operator.' '.$this->_connection->quoteValue($value);
  1426. return implode($andor,$expressions);
  1427. }
  1428. throw new CDbException(Yii::t('yii', 'Unknown operator "{operator}".', array('{operator}'=>$operator)));
  1429. }
  1430. /**
  1431. * Appends an JOIN part to the query.
  1432. * @param string $type the join type ('join', 'left join', 'right join', 'cross join', 'natural join')
  1433. * @param string $table the table to be joined.
  1434. * Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u').
  1435. * The method will automatically quote the table name unless it contains some parenthesis
  1436. * (which means the table is given as a sub-query or DB expression).
  1437. * @param mixed $conditions the join condition that should appear in the ON part.
  1438. * Please refer to {@link where} on how to specify conditions.
  1439. * @param array $params the parameters (name=>value) to be bound to the query
  1440. * @return CDbCommand the command object itself
  1441. * @since 1.1.6
  1442. */
  1443. private function joinInternal($type, $table, $conditions='', $params=array())
  1444. {
  1445. if(strpos($table,'(')===false)
  1446. {
  1447. if(preg_match('/^(.*?)(?i:\s+as\s+|\s+)(.*)$/',$table,$matches)) // with alias
  1448. $table=$this->_connection->quoteTableName($matches[1]).' '.$this->_connection->quoteTableName($matches[2]);
  1449. else
  1450. $table=$this->_connection->quoteTableName($table);
  1451. }
  1452. $conditions=$this->processConditions($conditions);
  1453. if($conditions!='')
  1454. $conditions=' ON '.$conditions;
  1455. if(isset($this->_query['join']) && is_string($this->_query['join']))
  1456. $this->_query['join']=array($this->_query['join']);
  1457. $this->_query['join'][]=strtoupper($type) . ' ' . $table . $conditions;
  1458. foreach($params as $name=>$value)
  1459. $this->params[$name]=$value;
  1460. return $this;
  1461. }
  1462. /**
  1463. * Builds a SQL statement for creating a primary key constraint.
  1464. * @param string $name the name of the primary key constraint to be created. The name will be properly quoted by the method.
  1465. * @param string $table the table who will be inheriting the primary key. The name will be properly quoted by the method.
  1466. * @param string $columns the column/s where the primary key will be effected. The name will be properly quoted by the method.
  1467. * @return integer number of rows affected by the execution.
  1468. * @since 1.1.13
  1469. */
  1470. public function addPrimaryKey($name,$table,$columns)
  1471. {
  1472. return $this->setText($this->getConnection()->getSchema()->addPrimaryKey($name,$table,$columns))->execute();
  1473. }
  1474. /**
  1475. * Builds a SQL statement for dropping a primary key constraint.
  1476. * @param string $name the name of the primary key constraint to be dropped. The name will be properly quoted by the method.
  1477. * @param string $table the table that owns the primary key. The name will be properly quoted by the method.
  1478. * @return integer number of rows affected by the execution.
  1479. * @since 1.1.13
  1480. */
  1481. public function dropPrimaryKey($name,$table)
  1482. {
  1483. return $this->setText($this->getConnection()->getSchema()->dropPrimaryKey($name,$table))->execute();
  1484. }
  1485. }