Qiang Xue
13 years ago
9 changed files with 1544 additions and 999 deletions
@ -0,0 +1,453 @@
|
||||
<?php |
||||
/** |
||||
* ActiveFinder class file. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright © 2008-2012 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\db\ar; |
||||
|
||||
use yii\base\VectorIterator; |
||||
use yii\db\dao\BaseQuery; |
||||
use yii\db\Exception; |
||||
|
||||
/** |
||||
* ActiveFinder.php is ... |
||||
* todo: add SQL monitor |
||||
* todo: better handling on join() support in QueryBuilder: use regexp to detect table name and quote it |
||||
* todo: do not support anonymous parameter binding |
||||
* todo: add ActiveFinderBuilder |
||||
* todo: quote join/on part of the relational query |
||||
* todo: modify QueryBuilder about join() methods |
||||
* todo: unify ActiveFinder and ActiveRelation in query building process |
||||
* todo: intelligent table aliasing (first table name, then relation name, finally t?) |
||||
* todo: allow using tokens in primary query fragments |
||||
* todo: findBySql |
||||
* todo: base limited |
||||
* todo: lazy loading |
||||
* todo: scope |
||||
* todo: test via option |
||||
* todo: count, sum, exists |
||||
* |
||||
* @property integer $count |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @since 2.0 |
||||
*/ |
||||
class ActiveQuery extends BaseQuery implements \IteratorAggregate, \ArrayAccess, \Countable |
||||
{ |
||||
/** |
||||
* @var string the name of the ActiveRecord class. |
||||
*/ |
||||
public $modelClass; |
||||
/** |
||||
* @var array list of relations that this query should be performed with |
||||
*/ |
||||
public $with; |
||||
/** |
||||
* @var string the table alias to be used for query |
||||
*/ |
||||
public $tableAlias; |
||||
/** |
||||
* @var string the name of the column that the result should be indexed by. |
||||
* This is only useful when the query result is returned as an array. |
||||
*/ |
||||
public $indexBy; |
||||
/** |
||||
* @var boolean whether to return each record as an array. If false (default), an object |
||||
* of [[modelClass]] will be created to represent each record. |
||||
*/ |
||||
public $asArray; |
||||
/** |
||||
* @var array list of scopes that should be applied to this query |
||||
*/ |
||||
public $scopes; |
||||
/** |
||||
* @var array list of query results |
||||
*/ |
||||
public $records; |
||||
public $sql; |
||||
|
||||
/** |
||||
* @param string $modelClass the name of the ActiveRecord class. |
||||
*/ |
||||
public function __construct($modelClass) |
||||
{ |
||||
$this->modelClass = $modelClass; |
||||
} |
||||
|
||||
public function asArray($value = true) |
||||
{ |
||||
$this->asArray = $value; |
||||
return $this; |
||||
} |
||||
|
||||
public function with() |
||||
{ |
||||
$this->with = func_get_args(); |
||||
if (isset($this->with[0]) && is_array($this->with[0])) { |
||||
// the parameter is given as an array |
||||
$this->with = $this->with[0]; |
||||
} |
||||
return $this; |
||||
} |
||||
|
||||
public function indexBy($column) |
||||
{ |
||||
$this->indexBy = $column; |
||||
return $this; |
||||
} |
||||
|
||||
public function tableAlias($value) |
||||
{ |
||||
$this->tableAlias = $value; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Executes query and returns all results as an array. |
||||
* @return array the query results. If the query results in nothing, an empty array will be returned. |
||||
*/ |
||||
public function all() |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return $this->records; |
||||
} |
||||
|
||||
/** |
||||
* Executes query and returns a single row of result. |
||||
* @return null|array|ActiveRecord the single row of query result. Depending on the setting of [[asArray]], |
||||
* the query result may be either an array or an ActiveRecord object. Null will be returned |
||||
* if the query results in nothing. |
||||
*/ |
||||
public function one() |
||||
{ |
||||
if ($this->records === null) { |
||||
// todo: load only one record |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return isset($this->records[0]) ? $this->records[0] : null; |
||||
} |
||||
|
||||
public function value() |
||||
{ |
||||
return 0; |
||||
} |
||||
|
||||
public function exists() |
||||
{ |
||||
return $this->select(array('1'))->asArray(true)->one() !== null; |
||||
} |
||||
|
||||
/** |
||||
* Returns the database connection used by this query. |
||||
* This method returns the connection used by the [[modelClass]]. |
||||
* @return \yii\db\dao\Connection the database connection used by this query |
||||
*/ |
||||
public function getDbConnection() |
||||
{ |
||||
$class = $this->modelClass; |
||||
return $class::getDbConnection(); |
||||
} |
||||
|
||||
/** |
||||
* Returns the number of items in the vector. |
||||
* @return integer the number of items in the vector |
||||
*/ |
||||
public function getCount() |
||||
{ |
||||
return $this->count(); |
||||
} |
||||
|
||||
/** |
||||
* Sets the parameters about query caching. |
||||
* This is a shortcut method to {@link CDbConnection::cache()}. |
||||
* It changes the query caching parameter of the {@link dbConnection} instance. |
||||
* @param integer $duration the number of seconds that query results may remain valid in cache. |
||||
* If this is 0, the caching will be disabled. |
||||
* @param CCacheDependency $dependency the dependency that will be used when saving the query results into cache. |
||||
* @param integer $queryCount number of SQL queries that need to be cached after calling this method. Defaults to 1, |
||||
* meaning that the next SQL query will be cached. |
||||
* @return ActiveRecord the active record instance itself. |
||||
*/ |
||||
public function cache($duration, $dependency = null, $queryCount = 1) |
||||
{ |
||||
$this->getDbConnection()->cache($duration, $dependency, $queryCount); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Returns an iterator for traversing the items in the vector. |
||||
* This method is required by the SPL interface `IteratorAggregate`. |
||||
* It will be implicitly called when you use `foreach` to traverse the vector. |
||||
* @return VectorIterator an iterator for traversing the items in the vector. |
||||
*/ |
||||
public function getIterator() |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return new VectorIterator($this->records); |
||||
} |
||||
|
||||
/** |
||||
* Returns the number of items in the vector. |
||||
* This method is required by the SPL `Countable` interface. |
||||
* It will be implicitly called when you use `count($vector)`. |
||||
* @return integer number of items in the vector. |
||||
*/ |
||||
public function count() |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return count($this->records); |
||||
} |
||||
|
||||
/** |
||||
* Returns a value indicating whether there is an item at the specified offset. |
||||
* This method is required by the SPL interface `ArrayAccess`. |
||||
* It is implicitly called when you use something like `isset($vector[$offset])`. |
||||
* @param integer $offset the offset to be checked |
||||
* @return boolean whether there is an item at the specified offset. |
||||
*/ |
||||
public function offsetExists($offset) |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return isset($this->records[$offset]); |
||||
} |
||||
|
||||
/** |
||||
* Returns the item at the specified offset. |
||||
* This method is required by the SPL interface `ArrayAccess`. |
||||
* It is implicitly called when you use something like `$value = $vector[$offset];`. |
||||
* This is equivalent to [[itemAt]]. |
||||
* @param integer $offset the offset to retrieve item. |
||||
* @return ActiveRecord the item at the offset |
||||
* @throws Exception if the offset is out of range |
||||
*/ |
||||
public function offsetGet($offset) |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
return isset($this->records[$offset]) ? $this->records[$offset] : null; |
||||
} |
||||
|
||||
/** |
||||
* Sets the item at the specified offset. |
||||
* This method is required by the SPL interface `ArrayAccess`. |
||||
* It is implicitly called when you use something like `$vector[$offset] = $item;`. |
||||
* If the offset is null or equal to the number of the existing items, |
||||
* the new item will be appended to the vector. |
||||
* Otherwise, the existing item at the offset will be replaced with the new item. |
||||
* @param integer $offset the offset to set item |
||||
* @param ActiveRecord $item the item value |
||||
* @throws Exception if the offset is out of range, or the vector is read only. |
||||
*/ |
||||
public function offsetSet($offset, $item) |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
$this->records[$offset] = $item; |
||||
} |
||||
|
||||
/** |
||||
* Unsets the item at the specified offset. |
||||
* This method is required by the SPL interface `ArrayAccess`. |
||||
* It is implicitly called when you use something like `unset($vector[$offset])`. |
||||
* This is equivalent to [[removeAt]]. |
||||
* @param integer $offset the offset to unset item |
||||
* @throws Exception if the offset is out of range, or the vector is read only. |
||||
*/ |
||||
public function offsetUnset($offset) |
||||
{ |
||||
if ($this->records === null) { |
||||
$this->records = $this->findRecords(); |
||||
} |
||||
unset($this->records[$offset]); |
||||
} |
||||
|
||||
public function joinWith() |
||||
{ |
||||
// todo: inner join with one or multiple relations as filters |
||||
} |
||||
|
||||
protected function findRecords() |
||||
{ |
||||
if (!empty($this->with)) { |
||||
// todo: handle findBySql() and limit cases |
||||
$joinTree = $this->buildRelationalQuery(); |
||||
} |
||||
|
||||
if ($this->sql === null) { |
||||
$this->initFrom($this->query); |
||||
$command = $this->query->createCommand($this->getDbConnection()); |
||||
$this->sql = $command->getSql(); |
||||
} else { |
||||
$command = $this->getDbConnection()->createCommand($this->sql); |
||||
$command->bindValues($this->query->params); |
||||
} |
||||
|
||||
$rows = $command->queryAll(); |
||||
|
||||
if (isset($joinTree)) { |
||||
foreach ($rows as $row) { |
||||
$joinTree->populateData($row); |
||||
} |
||||
return array_values($joinTree->records); |
||||
} |
||||
|
||||
if ($this->asArray) { |
||||
if ($this->indexBy === null) { |
||||
return $rows; |
||||
} |
||||
$records = array(); |
||||
foreach ($rows as $row) { |
||||
$records[$row[$this->indexBy]] = $row; |
||||
} |
||||
return $records; |
||||
} else { |
||||
$records = array(); |
||||
$class = $this->modelClass; |
||||
if ($this->indexBy === null) { |
||||
foreach ($rows as $row) { |
||||
$records[] = $class::populateData($row); |
||||
} |
||||
} else { |
||||
$attribute = $this->indexBy; |
||||
foreach ($rows as $row) { |
||||
$record = $class::populateData($row); |
||||
$records[$record->$attribute] = $record; |
||||
} |
||||
} |
||||
return $records; |
||||
} |
||||
} |
||||
|
||||
protected function initFrom($query) |
||||
{ |
||||
if ($query->from === null) { |
||||
$modelClass = $this->modelClass; |
||||
$tableName = $modelClass::tableName(); |
||||
if ($this->tableAlias !== null) { |
||||
$tableName .= ' ' . $this->tableAlias; |
||||
} |
||||
$query->from = array($tableName); |
||||
} |
||||
} |
||||
|
||||
protected function buildRelationalQuery() |
||||
{ |
||||
$joinTree = new JoinElement($this, null, null); |
||||
$this->buildJoinTree($joinTree, $this->with); |
||||
$this->buildTableAlias($joinTree); |
||||
$query = new Query; |
||||
foreach ($joinTree->children as $child) { |
||||
$child->buildQuery($query); |
||||
} |
||||
|
||||
$select = $joinTree->buildSelect($this->query->select); |
||||
if (!empty($query->select)) { |
||||
$this->query->select = array_merge($select, $query->select); |
||||
} else { |
||||
$this->query->select = $select; |
||||
} |
||||
if (!empty($query->where)) { |
||||
$this->query->andWhere('(' . implode(') AND (', $query->where) . ')'); |
||||
} |
||||
if (!empty($query->having)) { |
||||
$this->query->andHaving('(' . implode(') AND (', $query->having) . ')'); |
||||
} |
||||
if (!empty($query->join)) { |
||||
if ($this->query->join === null) { |
||||
$this->query->join = $query->join; |
||||
} else { |
||||
$this->query->join = array_merge($this->query->join, $query->join); |
||||
} |
||||
} |
||||
if (!empty($query->orderBy)) { |
||||
$this->query->addOrderBy($query->orderBy); |
||||
} |
||||
if (!empty($query->groupBy)) { |
||||
$this->query->addGroupBy($query->groupBy); |
||||
} |
||||
if (!empty($query->params)) { |
||||
$this->query->addParams($query->params); |
||||
} |
||||
|
||||
return $joinTree; |
||||
} |
||||
|
||||
/** |
||||
* @param JoinElement $parent |
||||
* @param array|string $with |
||||
* @param array $config |
||||
* @return null|JoinElement |
||||
* @throws \yii\db\Exception |
||||
*/ |
||||
protected function buildJoinTree($parent, $with, $config = array()) |
||||
{ |
||||
if (is_array($with)) { |
||||
foreach ($with as $name => $value) { |
||||
if (is_string($value)) { |
||||
$this->buildJoinTree($parent, $value); |
||||
} elseif (is_string($name) && is_array($value)) { |
||||
$this->buildJoinTree($parent, $name, $value); |
||||
} |
||||
} |
||||
return null; |
||||
} |
||||
|
||||
if (($pos = strrpos($with, '.')) !== false) { |
||||
$parent = $this->buildJoinTree($parent, substr($with, 0, $pos)); |
||||
$with = substr($with, $pos + 1); |
||||
} |
||||
|
||||
if (isset($parent->children[$with])) { |
||||
$child = $parent->children[$with]; |
||||
$child->joinOnly = false; |
||||
} else { |
||||
$modelClass = $parent->relation->modelClass; |
||||
$relations = $modelClass::getMetaData()->relations; |
||||
if (!isset($relations[$with])) { |
||||
throw new Exception("$modelClass has no relation named '$with'."); |
||||
} |
||||
$relation = clone $relations[$with]; |
||||
if ($relation->via !== null && isset($relations[$relation->via])) { |
||||
$relation->via = null; |
||||
$parent2 = $this->buildJoinTree($parent, $relation->via); |
||||
if ($parent2->joinOnly === null) { |
||||
$parent2->joinOnly = true; |
||||
} |
||||
$child = new JoinElement($relation, $parent2, $parent); |
||||
} else { |
||||
$child = new JoinElement($relation, $parent, $parent); |
||||
} |
||||
} |
||||
|
||||
foreach ($config as $name => $value) { |
||||
$child->relation->$name = $value; |
||||
} |
||||
|
||||
return $child; |
||||
} |
||||
|
||||
protected function buildTableAlias($element, &$count = 0) |
||||
{ |
||||
if ($element->relation->tableAlias === null) { |
||||
$element->relation->tableAlias = 't' . ($count++); |
||||
} |
||||
foreach ($element->children as $child) { |
||||
$this->buildTableAlias($child, $count); |
||||
} |
||||
} |
||||
} |
||||
@ -1,67 +1,64 @@
|
||||
<?php |
||||
/** |
||||
* ActiveRelation class file. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright © 2008-2012 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\db\ar; |
||||
|
||||
class ActiveRelation extends \yii\base\Object |
||||
use yii\db\dao\BaseQuery; |
||||
|
||||
/** |
||||
* ActiveRelation represents the specification of a relation declared in [[ActiveRecord::relations()]]. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @since 2.0 |
||||
*/ |
||||
class ActiveRelation extends BaseQuery |
||||
{ |
||||
/** |
||||
* @var string the name of this relation |
||||
*/ |
||||
public $name; |
||||
public $modelClass; |
||||
public $hasMany; |
||||
|
||||
public $joinType; |
||||
public $tableAlias; |
||||
public $on; |
||||
public $via; |
||||
public $with; |
||||
public $scopes; |
||||
|
||||
/** |
||||
* @var string|array the columns being selected. This refers to the SELECT clause in a SQL |
||||
* statement. It can be either a string (e.g. `'id, name'`) or an array (e.g. `array('id', 'name')`). |
||||
* If not set, if means all columns. |
||||
* @see select() |
||||
* @var string the name of the model class that this relation represents |
||||
*/ |
||||
public $select; |
||||
public $modelClass; |
||||
/** |
||||
* @var string|array query condition. This refers to the WHERE clause in a SQL statement. |
||||
* For example, `age > 31 AND team = 1`. |
||||
* @see where() |
||||
* @var boolean whether this relation is a one-many relation |
||||
*/ |
||||
public $where; |
||||
public $hasMany; |
||||
/** |
||||
* @var integer maximum number of records to be returned. If not set or less than 0, it means no limit. |
||||
* @var string the join type (e.g. INNER JOIN, LEFT JOIN). Defaults to 'LEFT JOIN'. |
||||
*/ |
||||
public $limit; |
||||
public $joinType = 'LEFT JOIN'; |
||||
/** |
||||
* @var integer zero-based offset from where the records are to be returned. If not set or |
||||
* less than 0, it means starting from the beginning. |
||||
* @var string the table alias used for the corresponding table during query |
||||
*/ |
||||
public $offset; |
||||
public $tableAlias; |
||||
/** |
||||
* @var string|array how to sort the query results. This refers to the ORDER BY clause in a SQL statement. |
||||
* It can be either a string (e.g. `'id ASC, name DESC'`) or an array (e.g. `array('id ASC', 'name DESC')`). |
||||
* @var string the name of the column that the result should be indexed by. |
||||
* This is only useful when [[hasMany]] is true. |
||||
*/ |
||||
public $orderBy; |
||||
public $indexBy; |
||||
/** |
||||
* @var string|array how to group the query results. This refers to the GROUP BY clause in a SQL statement. |
||||
* It can be either a string (e.g. `'company, department'`) or an array (e.g. `array('company', 'department')`). |
||||
* @var string the ON clause of the join query |
||||
*/ |
||||
public $groupBy; |
||||
public $on; |
||||
/** |
||||
* @var string|array how to join with other tables. This refers to the JOIN clause in a SQL statement. |
||||
* It can either a string (e.g. `'LEFT JOIN tbl_user ON tbl_user.id=author_id'`) or an array (e.g. |
||||
* `array('LEFT JOIN tbl_user ON tbl_user.id=author_id', 'LEFT JOIN tbl_team ON tbl_team.id=team_id')`). |
||||
* @see join() |
||||
* @var string |
||||
*/ |
||||
public $join; |
||||
public $via; |
||||
/** |
||||
* @var string|array the condition to be applied in the GROUP BY clause. |
||||
* It can be either a string or an array. Please refer to [[where()]] on how to specify the condition. |
||||
* @var array the relations that should be queried together (eager loading) |
||||
*/ |
||||
public $having; |
||||
public $with; |
||||
/** |
||||
* @var array list of query parameter values indexed by parameter placeholders. |
||||
* For example, `array(':name'=>'Dan', ':age'=>31)`. |
||||
* @var array the scopes that should be applied during query |
||||
*/ |
||||
public $params; |
||||
public $scopes; |
||||
} |
||||
|
||||
@ -0,0 +1,635 @@
|
||||
<?php |
||||
/** |
||||
* BaseQuery class file. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @link http://www.yiiframework.com/ |
||||
* @copyright Copyright © 2008-2012 Yii Software LLC |
||||
* @license http://www.yiiframework.com/license/ |
||||
*/ |
||||
|
||||
namespace yii\db\dao; |
||||
|
||||
/** |
||||
* BaseQuery is the base class that represents a SQL SELECT statement in a DBMS-independent way. |
||||
* |
||||
* @author Qiang Xue <qiang.xue@gmail.com> |
||||
* @since 2.0 |
||||
*/ |
||||
class BaseQuery extends \yii\base\Object |
||||
{ |
||||
/** |
||||
* @var string|array the columns being selected. This refers to the SELECT clause in a SQL |
||||
* statement. It can be either a string (e.g. `'id, name'`) or an array (e.g. `array('id', 'name')`). |
||||
* If not set, if means all columns. |
||||
* @see select() |
||||
*/ |
||||
public $select; |
||||
/** |
||||
* @var string additional option that should be appended to the 'SELECT' keyword. For example, |
||||
* in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used. |
||||
*/ |
||||
public $selectOption; |
||||
/** |
||||
* @var boolean whether to select distinct rows of data only. If this is set true, |
||||
* the SELECT clause would be changed to SELECT DISTINCT. |
||||
*/ |
||||
public $distinct; |
||||
/** |
||||
* @var string|array the table(s) to be selected from. This refers to the FROM clause in a SQL statement. |
||||
* It can be either a string (e.g. `'tbl_user, tbl_post'`) or an array (e.g. `array('tbl_user', 'tbl_post')`). |
||||
* @see from() |
||||
*/ |
||||
public $from; |
||||
/** |
||||
* @var string|array query condition. This refers to the WHERE clause in a SQL statement. |
||||
* For example, `age > 31 AND team = 1`. |
||||
* @see where() |
||||
*/ |
||||
public $where; |
||||
/** |
||||
* @var integer maximum number of records to be returned. If not set or less than 0, it means no limit. |
||||
*/ |
||||
public $limit; |
||||
/** |
||||
* @var integer zero-based offset from where the records are to be returned. If not set or |
||||
* less than 0, it means starting from the beginning. |
||||
*/ |
||||
public $offset; |
||||
/** |
||||
* @var string|array how to sort the query results. This refers to the ORDER BY clause in a SQL statement. |
||||
* It can be either a string (e.g. `'id ASC, name DESC'`) or an array (e.g. `array('id ASC', 'name DESC')`). |
||||
*/ |
||||
public $orderBy; |
||||
/** |
||||
* @var string|array how to group the query results. This refers to the GROUP BY clause in a SQL statement. |
||||
* It can be either a string (e.g. `'company, department'`) or an array (e.g. `array('company', 'department')`). |
||||
*/ |
||||
public $groupBy; |
||||
/** |
||||
* @var string|array how to join with other tables. This refers to the JOIN clause in a SQL statement. |
||||
* It can either a string (e.g. `'LEFT JOIN tbl_user ON tbl_user.id=author_id'`) or an array (e.g. |
||||
* `array('LEFT JOIN tbl_user ON tbl_user.id=author_id', 'LEFT JOIN tbl_team ON tbl_team.id=team_id')`). |
||||
* @see join() |
||||
*/ |
||||
public $join; |
||||
/** |
||||
* @var string|array the condition to be applied in the GROUP BY clause. |
||||
* It can be either a string or an array. Please refer to [[where()]] on how to specify the condition. |
||||
*/ |
||||
public $having; |
||||
/** |
||||
* @var array list of query parameter values indexed by parameter placeholders. |
||||
* For example, `array(':name'=>'Dan', ':age'=>31)`. |
||||
*/ |
||||
public $params; |
||||
/** |
||||
* @var string|BaseQuery[] the UNION clause(s) in a SQL statement. This can be either a string |
||||
* representing a single UNION clause or an array representing multiple UNION clauses. |
||||
* Each union clause can be a string or a `BaseQuery` object which refers to the SQL statement. |
||||
*/ |
||||
public $union; |
||||
|
||||
/** |
||||
* Sets the SELECT part of the query. |
||||
* @param string|array $columns the columns to be selected. |
||||
* Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')). |
||||
* Columns can contain table prefixes (e.g. "tbl_user.id") and/or column aliases (e.g. "tbl_user.id AS user_id"). |
||||
* The method will automatically quote the column names unless a column contains some parenthesis |
||||
* (which means the column contains a DB expression). |
||||
* @param string $option additional option that should be appended to the 'SELECT' keyword. For example, |
||||
* in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used. |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function select($columns, $option = null) |
||||
{ |
||||
$this->select = $columns; |
||||
$this->selectOption = $option; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the value indicating whether to SELECT DISTINCT or not. |
||||
* @param bool $value whether to SELECT DISTINCT or not. |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function distinct($value = true) |
||||
{ |
||||
$this->distinct = $value; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the FROM part of the query. |
||||
* @param string|array $tables the table(s) to be selected from. This can be either a string (e.g. `'tbl_user'`) |
||||
* or an array (e.g. `array('tbl_user', 'tbl_profile')`) specifying one or several table names. |
||||
* Table names can contain schema prefixes (e.g. `'public.tbl_user'`) and/or table aliases (e.g. `'tbl_user u'`). |
||||
* The method will automatically quote the table names unless it contains some parenthesis |
||||
* (which means the table is given as a sub-query or DB expression). |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function from($tables) |
||||
{ |
||||
$this->from = $tables; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the WHERE part of the query. |
||||
* |
||||
* The method requires a $condition parameter, and optionally a $params parameter |
||||
* specifying the values to be bound to the query. |
||||
* |
||||
* The $condition parameter should be either a string (e.g. 'id=1') or an array. |
||||
* If the latter, it must be in one of the following two formats: |
||||
* |
||||
* - hash format: `array('column1' => value1, 'column2' => value2, ...)` |
||||
* - operator format: `array(operator, operand1, operand2, ...)` |
||||
* |
||||
* A condition in hash format represents the following SQL expression in general: |
||||
* `column1=value1 AND column2=value2 AND ...`. In case when a value is an array, |
||||
* an `IN` expression will be generated. And if a value is null, `IS NULL` will be used |
||||
* in the generated expression. Below are some examples: |
||||
* |
||||
* - `array('type'=>1, 'status'=>2)` generates `(type=1) AND (status=2)`. |
||||
* - `array('id'=>array(1,2,3), 'status'=>2)` generates `(id IN (1,2,3)) AND (status=2)`. |
||||
* - `array('status'=>null) generates `status IS NULL`. |
||||
* |
||||
* A condition in operator format generates the SQL expression according to the specified operator, which |
||||
* can be one of the followings: |
||||
* |
||||
* - `and`: the operands should be concatenated together using `AND`. For example, |
||||
* `array('and', 'id=1', 'id=2')` will generate `id=1 AND id=2`. If an operand is an array, |
||||
* it will be converted into a string using the rules described here. For example, |
||||
* `array('and', 'type=1', array('or', 'id=1', 'id=2'))` will generate `type=1 AND (id=1 OR id=2)`. |
||||
* The method will NOT do any quoting or escaping. |
||||
* |
||||
* - `or`: similar to the `and` operator except that the operands are concatenated using `OR`. |
||||
* |
||||
* - `between`: operand 1 should be the column name, and operand 2 and 3 should be the |
||||
* starting and ending values of the range that the column is in. |
||||
* For example, `array('between', 'id', 1, 10)` will generate `id BETWEEN 1 AND 10`. |
||||
* |
||||
* - `not between`: similar to `between` except the `BETWEEN` is replaced with `NOT BETWEEN` |
||||
* in the generated condition. |
||||
* |
||||
* - `in`: operand 1 should be a column or DB expression, and operand 2 be an array representing |
||||
* the range of the values that the column or DB expression should be in. For example, |
||||
* `array('in', 'id', array(1,2,3))` will generate `id IN (1,2,3)`. |
||||
* The method will properly quote the column name and escape values in the range. |
||||
* |
||||
* - `not in`: similar to the `in` operator except that `IN` is replaced with `NOT IN` in the generated condition. |
||||
* |
||||
* - `like`: operand 1 should be a column or DB expression, and operand 2 be a string or an array representing |
||||
* the values that the column or DB expression should be like. |
||||
* For example, `array('like', 'name', '%tester%')` will generate `name LIKE '%tester%'`. |
||||
* When the value range is given as an array, multiple `LIKE` predicates will be generated and concatenated |
||||
* using `AND`. For example, `array('like', 'name', array('%test%', '%sample%'))` will generate |
||||
* `name LIKE '%test%' AND name LIKE '%sample%'`. |
||||
* The method will properly quote the column name and escape values in the range. |
||||
* |
||||
* - `or like`: similar to the `like` operator except that `OR` is used to concatenate the `LIKE` |
||||
* predicates when operand 2 is an array. |
||||
* |
||||
* - `not like`: similar to the `like` operator except that `LIKE` is replaced with `NOT LIKE` |
||||
* in the generated condition. |
||||
* |
||||
* - `or not like`: similar to the `not like` operator except that `OR` is used to concatenate |
||||
* the `NOT LIKE` predicates. |
||||
* |
||||
* @param string|array $condition the conditions that should be put in the WHERE part. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see andWhere() |
||||
* @see orWhere() |
||||
*/ |
||||
public function where($condition, $params = array()) |
||||
{ |
||||
$this->where = $condition; |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds an additional WHERE condition to the existing one. |
||||
* The new condition and the existing one will be joined using the 'AND' operator. |
||||
* @param string|array $condition the new WHERE condition. Please refer to [[where()]] |
||||
* on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see where() |
||||
* @see orWhere() |
||||
*/ |
||||
public function andWhere($condition, $params = array()) |
||||
{ |
||||
if ($this->where === null) { |
||||
$this->where = $condition; |
||||
} else { |
||||
$this->where = array('and', $this->where, $condition); |
||||
} |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds an additional WHERE condition to the existing one. |
||||
* The new condition and the existing one will be joined using the 'OR' operator. |
||||
* @param string|array $condition the new WHERE condition. Please refer to [[where()]] |
||||
* on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see where() |
||||
* @see andWhere() |
||||
*/ |
||||
public function orWhere($condition, $params = array()) |
||||
{ |
||||
if ($this->where === null) { |
||||
$this->where = $condition; |
||||
} else { |
||||
$this->where = array('or', $this->where, $condition); |
||||
} |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Appends a JOIN part to the query. |
||||
* The first parameter specifies what type of join it is. |
||||
* @param string $type the type of join, such as INNER JOIN, LEFT JOIN. |
||||
* @param string $table the table to be joined. |
||||
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
||||
* The method will automatically quote the table name unless it contains some parenthesis |
||||
* (which means the table is given as a sub-query or DB expression). |
||||
* @param string|array $on the join condition that should appear in the ON part. |
||||
* Please refer to [[where()]] on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function join($type, $table, $on = '', $params = array()) |
||||
{ |
||||
$this->join[] = array($type, $table, $on); |
||||
return $this->addParams($params); |
||||
} |
||||
|
||||
/** |
||||
* Appends an INNER JOIN part to the query. |
||||
* @param string $table the table to be joined. |
||||
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
||||
* The method will automatically quote the table name unless it contains some parenthesis |
||||
* (which means the table is given as a sub-query or DB expression). |
||||
* @param string|array $on the join condition that should appear in the ON part. |
||||
* Please refer to [[where()]] on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function innerJoin($table, $on = '', $params = array()) |
||||
{ |
||||
$this->join[] = array('INNER JOIN', $table, $on); |
||||
return $this->addParams($params); |
||||
} |
||||
|
||||
/** |
||||
* Appends a LEFT OUTER JOIN part to the query. |
||||
* @param string $table the table to be joined. |
||||
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
||||
* The method will automatically quote the table name unless it contains some parenthesis |
||||
* (which means the table is given as a sub-query or DB expression). |
||||
* @param string|array $on the join condition that should appear in the ON part. |
||||
* Please refer to [[where()]] on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function leftJoin($table, $on = '', $params = array()) |
||||
{ |
||||
$this->join[] = array('LEFT JOIN', $table, $on); |
||||
return $this->addParams($params); |
||||
} |
||||
|
||||
/** |
||||
* Appends a RIGHT OUTER JOIN part to the query. |
||||
* @param string $table the table to be joined. |
||||
* Table name can contain schema prefix (e.g. 'public.tbl_user') and/or table alias (e.g. 'tbl_user u'). |
||||
* The method will automatically quote the table name unless it contains some parenthesis |
||||
* (which means the table is given as a sub-query or DB expression). |
||||
* @param string|array $on the join condition that should appear in the ON part. |
||||
* Please refer to [[where()]] on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function rightJoin($table, $on = '', $params = array()) |
||||
{ |
||||
$this->join[] = array('RIGHT JOIN', $table, $on); |
||||
return $this->addParams($params); |
||||
} |
||||
|
||||
/** |
||||
* Sets the GROUP BY part of the query. |
||||
* @param string|array $columns the columns to be grouped by. |
||||
* Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')). |
||||
* The method will automatically quote the column names unless a column contains some parenthesis |
||||
* (which means the column contains a DB expression). |
||||
* @return BaseQuery the query object itself |
||||
* @see addGroupBy() |
||||
*/ |
||||
public function groupBy($columns) |
||||
{ |
||||
$this->groupBy = $columns; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds additional group-by columns to the existing ones. |
||||
* @param string|array $columns additional columns to be grouped by. |
||||
* Columns can be specified in either a string (e.g. "id, name") or an array (e.g. array('id', 'name')). |
||||
* The method will automatically quote the column names unless a column contains some parenthesis |
||||
* (which means the column contains a DB expression). |
||||
* @return BaseQuery the query object itself |
||||
* @see groupBy() |
||||
*/ |
||||
public function addGroupBy($columns) |
||||
{ |
||||
if (empty($this->groupBy)) { |
||||
$this->groupBy = $columns; |
||||
} else { |
||||
if (!is_array($this->groupBy)) { |
||||
$this->groupBy = preg_split('/\s*,\s*/', trim($this->groupBy), -1, PREG_SPLIT_NO_EMPTY); |
||||
} |
||||
if (!is_array($columns)) { |
||||
$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY); |
||||
} |
||||
$this->groupBy = array_merge($this->groupBy, $columns); |
||||
} |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the HAVING part of the query. |
||||
* @param string|array $condition the conditions to be put after HAVING. |
||||
* Please refer to [[where()]] on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see andHaving() |
||||
* @see orHaving() |
||||
*/ |
||||
public function having($condition, $params = array()) |
||||
{ |
||||
$this->having = $condition; |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds an additional HAVING condition to the existing one. |
||||
* The new condition and the existing one will be joined using the 'AND' operator. |
||||
* @param string|array $condition the new HAVING condition. Please refer to [[where()]] |
||||
* on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see having() |
||||
* @see orHaving() |
||||
*/ |
||||
public function andHaving($condition, $params = array()) |
||||
{ |
||||
if ($this->having === null) { |
||||
$this->having = $condition; |
||||
} else { |
||||
$this->having = array('and', $this->having, $condition); |
||||
} |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds an additional HAVING condition to the existing one. |
||||
* The new condition and the existing one will be joined using the 'OR' operator. |
||||
* @param string|array $condition the new HAVING condition. Please refer to [[where()]] |
||||
* on how to specify this parameter. |
||||
* @param array $params the parameters (name=>value) to be bound to the query. |
||||
* @return BaseQuery the query object itself |
||||
* @see having() |
||||
* @see andHaving() |
||||
*/ |
||||
public function orHaving($condition, $params = array()) |
||||
{ |
||||
if ($this->having === null) { |
||||
$this->having = $condition; |
||||
} else { |
||||
$this->having = array('or', $this->having, $condition); |
||||
} |
||||
$this->addParams($params); |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the ORDER BY part of the query. |
||||
* @param string|array $columns the columns (and the directions) to be ordered by. |
||||
* Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. array('id ASC', 'name DESC')). |
||||
* The method will automatically quote the column names unless a column contains some parenthesis |
||||
* (which means the column contains a DB expression). |
||||
* @return BaseQuery the query object itself |
||||
* @see addOrderBy() |
||||
*/ |
||||
public function orderBy($columns) |
||||
{ |
||||
$this->orderBy = $columns; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds additional ORDER BY columns to the query. |
||||
* @param string|array $columns the columns (and the directions) to be ordered by. |
||||
* Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. array('id ASC', 'name DESC')). |
||||
* The method will automatically quote the column names unless a column contains some parenthesis |
||||
* (which means the column contains a DB expression). |
||||
* @return BaseQuery the query object itself |
||||
* @see orderBy() |
||||
*/ |
||||
public function addOrderBy($columns) |
||||
{ |
||||
if (empty($this->orderBy)) { |
||||
$this->orderBy = $columns; |
||||
} else { |
||||
if (!is_array($this->orderBy)) { |
||||
$this->orderBy = preg_split('/\s*,\s*/', trim($this->orderBy), -1, PREG_SPLIT_NO_EMPTY); |
||||
} |
||||
if (!is_array($columns)) { |
||||
$columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY); |
||||
} |
||||
$this->orderBy = array_merge($this->orderBy, $columns); |
||||
} |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the LIMIT part of the query. |
||||
* @param integer $limit the limit |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function limit($limit) |
||||
{ |
||||
$this->limit = $limit; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the OFFSET part of the query. |
||||
* @param integer $offset the offset |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function offset($offset) |
||||
{ |
||||
$this->offset = $offset; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Appends a SQL statement using UNION operator. |
||||
* @param string|BaseQuery $sql the SQL statement to be appended using UNION |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function union($sql) |
||||
{ |
||||
$this->union[] = $sql; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Sets the parameters to be bound to the query. |
||||
* @param array $params list of query parameter values indexed by parameter placeholders. |
||||
* For example, `array(':name'=>'Dan', ':age'=>31)`. |
||||
* @return BaseQuery the query object itself |
||||
* @see addParams() |
||||
*/ |
||||
public function params($params) |
||||
{ |
||||
$this->params = $params; |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Adds additional parameters to be bound to the query. |
||||
* @param array $params list of query parameter values indexed by parameter placeholders. |
||||
* For example, `array(':name'=>'Dan', ':age'=>31)`. |
||||
* @return BaseQuery the query object itself |
||||
* @see params() |
||||
*/ |
||||
public function addParams($params) |
||||
{ |
||||
if ($params !== array()) { |
||||
if ($this->params === null) { |
||||
$this->params = $params; |
||||
} else { |
||||
foreach ($params as $name => $value) { |
||||
if (is_integer($name)) { |
||||
$this->params[] = $value; |
||||
} else { |
||||
$this->params[$name] = $value; |
||||
} |
||||
} |
||||
} |
||||
} |
||||
return $this; |
||||
} |
||||
|
||||
/** |
||||
* Merges this query with another one. |
||||
* |
||||
* The merging is done according to the following rules: |
||||
* |
||||
* - [[select]]: the union of both queries' [[select]] property values. |
||||
* - [[selectOption]], [[distinct]], [[from]], [[limit]], [[offset]]: the new query |
||||
* takes precedence over this query. |
||||
* - [[where]], [[having]]: the new query's corresponding property value |
||||
* will be 'AND' together with the existing one. |
||||
* - [[params]], [[orderBy]], [[groupBy]], [[join]], [[union]]: the new query's |
||||
* corresponding property value will be appended to the existing one. |
||||
* |
||||
* In general, the merging makes the resulting query more restrictive and specific. |
||||
* @param BaseQuery $query the new query to be merged with this query. |
||||
* @return BaseQuery the query object itself |
||||
*/ |
||||
public function mergeWith($query) |
||||
{ |
||||
if ($this->select !== $query->select) { |
||||
if (empty($this->select)) { |
||||
$this->select = $query->select; |
||||
} elseif (!empty($query->select)) { |
||||
$select1 = is_string($this->select) ? preg_split('/\s*,\s*/', trim($this->select), -1, PREG_SPLIT_NO_EMPTY) : $this->select; |
||||
$select2 = is_string($query->select) ? preg_split('/\s*,\s*/', trim($query->select), -1, PREG_SPLIT_NO_EMPTY) : $query->select; |
||||
$this->select = array_merge($select1, array_diff($select2, $select1)); |
||||
} |
||||
} |
||||
|
||||
if ($query->selectOption !== null) { |
||||
$this->selectOption = $query->selectOption; |
||||
} |
||||
|
||||
if ($query->distinct !== null) { |
||||
$this->distinct = $query->distinct; |
||||
} |
||||
|
||||
if ($query->from !== null) { |
||||
$this->from = $query->from; |
||||
} |
||||
|
||||
if ($query->limit !== null) { |
||||
$this->limit = $query->limit; |
||||
} |
||||
|
||||
if ($query->offset !== null) { |
||||
$this->offset = $query->offset; |
||||
} |
||||
|
||||
if ($query->where !== null) { |
||||
$this->andWhere($query->where); |
||||
} |
||||
|
||||
if ($query->having !== null) { |
||||
$this->andHaving($query->having); |
||||
} |
||||
|
||||
if ($query->params !== null) { |
||||
$this->addParams($query->params); |
||||
} |
||||
|
||||
if ($query->orderBy !== null) { |
||||
$this->addOrderBy($query->orderBy); |
||||
} |
||||
|
||||
if ($query->groupBy !== null) { |
||||
$this->addGroupBy($query->groupBy); |
||||
} |
||||
|
||||
if ($query->join !== null) { |
||||
if (empty($this->join)) { |
||||
$this->join = $query->join; |
||||
} else { |
||||
if (!is_array($this->join)) { |
||||
$this->join = array($this->join); |
||||
} |
||||
if (is_array($query->join)) { |
||||
$this->join = array_merge($this->join, $query->join); |
||||
} else { |
||||
$this->join[] = $query->join; |
||||
} |
||||
} |
||||
} |
||||
|
||||
if ($query->union !== null) { |
||||
if (empty($this->union)) { |
||||
$this->union = $query->union; |
||||
} else { |
||||
if (!is_array($this->union)) { |
||||
$this->union = array($this->union); |
||||
} |
||||
if (is_array($query->union)) { |
||||
$this->union = array_merge($this->union, $query->union); |
||||
} else { |
||||
$this->union[] = $query->union; |
||||
} |
||||
} |
||||
} |
||||
|
||||
return $this; |
||||
} |
||||
} |
||||
Loading…
Reference in new issue