123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876 |
- <?php
- /**
- * CDbCommandBuilder class file.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @link http://www.yiiframework.com/
- * @copyright 2008-2013 Yii Software LLC
- * @license http://www.yiiframework.com/license/
- */
- /**
- * CDbCommandBuilder provides basic methods to create query commands for tables.
- *
- * @property CDbConnection $dbConnection Database connection.
- * @property CDbSchema $schema The schema for this command builder.
- *
- * @author Qiang Xue <qiang.xue@gmail.com>
- * @package system.db.schema
- * @since 1.0
- */
- class CDbCommandBuilder extends CComponent
- {
- const PARAM_PREFIX=':yp';
- private $_schema;
- private $_connection;
- /**
- * @param CDbSchema $schema the schema for this command builder
- */
- public function __construct($schema)
- {
- $this->_schema=$schema;
- $this->_connection=$schema->getDbConnection();
- }
- /**
- * @return CDbConnection database connection.
- */
- public function getDbConnection()
- {
- return $this->_connection;
- }
- /**
- * @return CDbSchema the schema for this command builder.
- */
- public function getSchema()
- {
- return $this->_schema;
- }
- /**
- * Returns the last insertion ID for the specified table.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @return mixed last insertion id. Null is returned if no sequence name.
- */
- public function getLastInsertID($table)
- {
- $this->ensureTable($table);
- if($table->sequenceName!==null)
- return $this->_connection->getLastInsertID($table->sequenceName);
- else
- return null;
- }
- /**
- * Creates a SELECT command for a single table.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param CDbCriteria $criteria the query criteria
- * @param string $alias the alias name of the primary table. Defaults to 't'.
- * @return CDbCommand query command.
- */
- public function createFindCommand($table,$criteria,$alias='t')
- {
- $this->ensureTable($table);
- $select=is_array($criteria->select) ? implode(', ',$criteria->select) : $criteria->select;
- if($criteria->alias!='')
- $alias=$criteria->alias;
- $alias=$this->_schema->quoteTableName($alias);
- // issue 1432: need to expand * when SQL has JOIN
- if($select==='*' && !empty($criteria->join))
- {
- $prefix=$alias.'.';
- $select=array();
- foreach($table->getColumnNames() as $name)
- $select[]=$prefix.$this->_schema->quoteColumnName($name);
- $select=implode(', ',$select);
- }
- $sql=($criteria->distinct ? 'SELECT DISTINCT':'SELECT')." {$select} FROM {$table->rawName} $alias";
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- $sql=$this->applyGroup($sql,$criteria->group);
- $sql=$this->applyHaving($sql,$criteria->having);
- $sql=$this->applyOrder($sql,$criteria->order);
- $sql=$this->applyLimit($sql,$criteria->limit,$criteria->offset);
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,$criteria->params);
- return $command;
- }
- /**
- * Creates a COUNT(*) command for a single table.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param CDbCriteria $criteria the query criteria
- * @param string $alias the alias name of the primary table. Defaults to 't'.
- * @return CDbCommand query command.
- */
- public function createCountCommand($table,$criteria,$alias='t')
- {
- $this->ensureTable($table);
- if($criteria->alias!='')
- $alias=$criteria->alias;
- $alias=$this->_schema->quoteTableName($alias);
- if(!empty($criteria->group) || !empty($criteria->having))
- {
- $select=is_array($criteria->select) ? implode(', ',$criteria->select) : $criteria->select;
- if($criteria->alias!='')
- $alias=$criteria->alias;
- $sql=($criteria->distinct ? 'SELECT DISTINCT':'SELECT')." {$select} FROM {$table->rawName} $alias";
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- $sql=$this->applyGroup($sql,$criteria->group);
- $sql=$this->applyHaving($sql,$criteria->having);
- $sql="SELECT COUNT(*) FROM ($sql) sq";
- }
- else
- {
- if(is_string($criteria->select) && stripos($criteria->select,'count')===0)
- $sql="SELECT ".$criteria->select;
- elseif($criteria->distinct)
- {
- if(is_array($table->primaryKey))
- {
- $pk=array();
- foreach($table->primaryKey as $key)
- $pk[]=$alias.'.'.$key;
- $pk=implode(', ',$pk);
- }
- else
- $pk=$alias.'.'.$table->primaryKey;
- $sql="SELECT COUNT(DISTINCT $pk)";
- }
- else
- $sql="SELECT COUNT(*)";
- $sql.=" FROM {$table->rawName} $alias";
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- }
- // Suppress binding of parameters belonging to the ORDER clause. Issue #1407.
- if($criteria->order && $criteria->params)
- {
- $params1=array();
- preg_match_all('/(:\w+)/',$sql,$params1);
- $params2=array();
- preg_match_all('/(:\w+)/',$this->applyOrder($sql,$criteria->order),$params2);
- foreach(array_diff($params2[0],$params1[0]) as $param)
- unset($criteria->params[$param]);
- }
- // Do the same for SELECT part.
- if($criteria->select && $criteria->params)
- {
- $params1=array();
- preg_match_all('/(:\w+)/',$sql,$params1);
- $params2=array();
- preg_match_all('/(:\w+)/',$sql.' '.(is_array($criteria->select) ? implode(', ',$criteria->select) : $criteria->select),$params2);
- foreach(array_diff($params2[0],$params1[0]) as $param)
- unset($criteria->params[$param]);
- }
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,$criteria->params);
- return $command;
- }
- /**
- * Creates a DELETE command.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param CDbCriteria $criteria the query criteria
- * @return CDbCommand delete command.
- */
- public function createDeleteCommand($table,$criteria)
- {
- $this->ensureTable($table);
- $sql="DELETE FROM {$table->rawName}";
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- $sql=$this->applyGroup($sql,$criteria->group);
- $sql=$this->applyHaving($sql,$criteria->having);
- $sql=$this->applyOrder($sql,$criteria->order);
- $sql=$this->applyLimit($sql,$criteria->limit,$criteria->offset);
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,$criteria->params);
- return $command;
- }
- /**
- * Creates an INSERT command.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $data data to be inserted (column name=>column value). If a key is not a valid column name, the corresponding value will be ignored.
- * @return CDbCommand insert command
- */
- public function createInsertCommand($table,$data)
- {
- $this->ensureTable($table);
- $fields=array();
- $values=array();
- $placeholders=array();
- $i=0;
- foreach($data as $name=>$value)
- {
- if(($column=$table->getColumn($name))!==null && ($value!==null || $column->allowNull))
- {
- $fields[]=$column->rawName;
- if($value instanceof CDbExpression)
- {
- $placeholders[]=$value->expression;
- foreach($value->params as $n=>$v)
- $values[$n]=$v;
- }
- else
- {
- $placeholders[]=self::PARAM_PREFIX.$i;
- $values[self::PARAM_PREFIX.$i]=$column->typecast($value);
- $i++;
- }
- }
- }
- if($fields===array())
- {
- $pks=is_array($table->primaryKey) ? $table->primaryKey : array($table->primaryKey);
- foreach($pks as $pk)
- {
- $fields[]=$table->getColumn($pk)->rawName;
- $placeholders[]=$this->getIntegerPrimaryKeyDefaultValue();
- }
- }
- $sql="INSERT INTO {$table->rawName} (".implode(', ',$fields).') VALUES ('.implode(', ',$placeholders).')';
- $command=$this->_connection->createCommand($sql);
- foreach($values as $name=>$value)
- $command->bindValue($name,$value);
- return $command;
- }
- /**
- * Creates a multiple INSERT command.
- * This method could be used to achieve better performance during insertion of the large
- * amount of data into the database tables.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array[] $data list data to be inserted, each value should be an array in format (column name=>column value).
- * If a key is not a valid column name, the corresponding value will be ignored.
- * @return CDbCommand multiple insert command
- * @since 1.1.14
- */
- public function createMultipleInsertCommand($table,array $data)
- {
- return $this->composeMultipleInsertCommand($table,$data);
- }
- /**
- * Creates a multiple INSERT command.
- * This method compose the SQL expression via given part templates, providing ability to adjust
- * command for different SQL syntax.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array[] $data list data to be inserted, each value should be an array in format (column name=>column value).
- * If a key is not a valid column name, the corresponding value will be ignored.
- * @param array $templates templates for the SQL parts.
- * @return CDbCommand multiple insert command
- * @throws CDbException if $data is empty.
- */
- protected function composeMultipleInsertCommand($table,array $data,array $templates=array())
- {
- if (empty($data))
- throw new CDbException(Yii::t('yii','Can not generate multiple insert command with empty data set.'));
- $templates=array_merge(
- array(
- 'main'=>'INSERT INTO {{tableName}} ({{columnInsertNames}}) VALUES {{rowInsertValues}}',
- 'columnInsertValue'=>'{{value}}',
- 'columnInsertValueGlue'=>', ',
- 'rowInsertValue'=>'({{columnInsertValues}})',
- 'rowInsertValueGlue'=>', ',
- 'columnInsertNameGlue'=>', ',
- ),
- $templates
- );
- $this->ensureTable($table);
- $tableName=$table->rawName;
- $params=array();
- $columnInsertNames=array();
- $rowInsertValues=array();
- $columns=array();
- foreach($data as $rowData)
- {
- foreach($rowData as $columnName=>$columnValue)
- {
- if(!in_array($columnName,$columns,true))
- if($table->getColumn($columnName)!==null)
- $columns[]=$columnName;
- }
- }
- foreach($columns as $name)
- $columnInsertNames[$name]=$this->getDbConnection()->quoteColumnName($name);
- $columnInsertNamesSqlPart=implode($templates['columnInsertNameGlue'],$columnInsertNames);
- foreach($data as $rowKey=>$rowData)
- {
- $columnInsertValues=array();
- foreach($columns as $columnName)
- {
- $column=$table->getColumn($columnName);
- $columnValue=array_key_exists($columnName,$rowData) ? $rowData[$columnName] : new CDbExpression('NULL');
- if($columnValue instanceof CDbExpression)
- {
- $columnInsertValue=$columnValue->expression;
- foreach($columnValue->params as $columnValueParamName=>$columnValueParam)
- $params[$columnValueParamName]=$columnValueParam;
- }
- else
- {
- $columnInsertValue=':'.$columnName.'_'.$rowKey;
- $params[':'.$columnName.'_'.$rowKey]=$column->typecast($columnValue);
- }
- $columnInsertValues[]=strtr($templates['columnInsertValue'],array(
- '{{column}}'=>$columnInsertNames[$columnName],
- '{{value}}'=>$columnInsertValue,
- ));
- }
- $rowInsertValues[]=strtr($templates['rowInsertValue'],array(
- '{{tableName}}'=>$tableName,
- '{{columnInsertNames}}'=>$columnInsertNamesSqlPart,
- '{{columnInsertValues}}'=>implode($templates['columnInsertValueGlue'],$columnInsertValues)
- ));
- }
- $sql=strtr($templates['main'],array(
- '{{tableName}}'=>$tableName,
- '{{columnInsertNames}}'=>$columnInsertNamesSqlPart,
- '{{rowInsertValues}}'=>implode($templates['rowInsertValueGlue'], $rowInsertValues),
- ));
- $command=$this->getDbConnection()->createCommand($sql);
- foreach($params as $name=>$value)
- $command->bindValue($name,$value);
- return $command;
- }
- /**
- * Creates an UPDATE command.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $data list of columns to be updated (name=>value)
- * @param CDbCriteria $criteria the query criteria
- * @throws CDbException if no columns are being updated for the given table
- * @return CDbCommand update command.
- */
- public function createUpdateCommand($table,$data,$criteria)
- {
- $this->ensureTable($table);
- $fields=array();
- $values=array();
- $bindByPosition=isset($criteria->params[0]);
- $i=0;
- foreach($data as $name=>$value)
- {
- if(($column=$table->getColumn($name))!==null)
- {
- if($value instanceof CDbExpression)
- {
- $fields[]=$column->rawName.'='.$value->expression;
- foreach($value->params as $n=>$v)
- $values[$n]=$v;
- }
- elseif($bindByPosition)
- {
- $fields[]=$column->rawName.'=?';
- $values[]=$column->typecast($value);
- }
- else
- {
- $fields[]=$column->rawName.'='.self::PARAM_PREFIX.$i;
- $values[self::PARAM_PREFIX.$i]=$column->typecast($value);
- $i++;
- }
- }
- }
- if($fields===array())
- throw new CDbException(Yii::t('yii','No columns are being updated for table "{table}".',
- array('{table}'=>$table->name)));
- $sql="UPDATE {$table->rawName} SET ".implode(', ',$fields);
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- $sql=$this->applyOrder($sql,$criteria->order);
- $sql=$this->applyLimit($sql,$criteria->limit,$criteria->offset);
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,array_merge($values,$criteria->params));
- return $command;
- }
- /**
- * Creates an UPDATE command that increments/decrements certain columns.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $counters counters to be updated (counter increments/decrements indexed by column names.)
- * @param CDbCriteria $criteria the query criteria
- * @throws CDbException if no columns are being updated for the given table
- * @return CDbCommand the created command
- */
- public function createUpdateCounterCommand($table,$counters,$criteria)
- {
- $this->ensureTable($table);
- $fields=array();
- foreach($counters as $name=>$value)
- {
- if(($column=$table->getColumn($name))!==null)
- {
- $value=(float)$value;
- if($value<0)
- $fields[]="{$column->rawName}={$column->rawName}-".(-$value);
- else
- $fields[]="{$column->rawName}={$column->rawName}+".$value;
- }
- }
- if($fields!==array())
- {
- $sql="UPDATE {$table->rawName} SET ".implode(', ',$fields);
- $sql=$this->applyJoin($sql,$criteria->join);
- $sql=$this->applyCondition($sql,$criteria->condition);
- $sql=$this->applyOrder($sql,$criteria->order);
- $sql=$this->applyLimit($sql,$criteria->limit,$criteria->offset);
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,$criteria->params);
- return $command;
- }
- else
- throw new CDbException(Yii::t('yii','No counter columns are being updated for table "{table}".',
- array('{table}'=>$table->name)));
- }
- /**
- * Creates a command based on a given SQL statement.
- * @param string $sql the explicitly specified SQL statement
- * @param array $params parameters that will be bound to the SQL statement
- * @return CDbCommand the created command
- */
- public function createSqlCommand($sql,$params=array())
- {
- $command=$this->_connection->createCommand($sql);
- $this->bindValues($command,$params);
- return $command;
- }
- /**
- * Alters the SQL to apply JOIN clause.
- * @param string $sql the SQL statement to be altered
- * @param string $join the JOIN clause (starting with join type, such as INNER JOIN)
- * @return string the altered SQL statement
- */
- public function applyJoin($sql,$join)
- {
- if($join!='')
- return $sql.' '.$join;
- else
- return $sql;
- }
- /**
- * Alters the SQL to apply WHERE clause.
- * @param string $sql the SQL statement without WHERE clause
- * @param string $condition the WHERE clause (without WHERE keyword)
- * @return string the altered SQL statement
- */
- public function applyCondition($sql,$condition)
- {
- if($condition!='')
- return $sql.' WHERE '.$condition;
- else
- return $sql;
- }
- /**
- * Alters the SQL to apply ORDER BY.
- * @param string $sql SQL statement without ORDER BY.
- * @param string $orderBy column ordering
- * @return string modified SQL applied with ORDER BY.
- */
- public function applyOrder($sql,$orderBy)
- {
- if($orderBy!='')
- return $sql.' ORDER BY '.$orderBy;
- else
- return $sql;
- }
- /**
- * Alters the SQL to apply LIMIT and OFFSET.
- * Default implementation is applicable for PostgreSQL, MySQL, MariaDB and SQLite.
- * @param string $sql SQL query string without LIMIT and OFFSET.
- * @param integer $limit maximum number of rows, -1 to ignore limit.
- * @param integer $offset row offset, -1 to ignore offset.
- * @return string SQL with LIMIT and OFFSET
- */
- public function applyLimit($sql,$limit,$offset)
- {
- if($limit>=0)
- $sql.=' LIMIT '.(int)$limit;
- if($offset>0)
- $sql.=' OFFSET '.(int)$offset;
- return $sql;
- }
- /**
- * Alters the SQL to apply GROUP BY.
- * @param string $sql SQL query string without GROUP BY.
- * @param string $group GROUP BY
- * @return string SQL with GROUP BY.
- */
- public function applyGroup($sql,$group)
- {
- if($group!='')
- return $sql.' GROUP BY '.$group;
- else
- return $sql;
- }
- /**
- * Alters the SQL to apply HAVING.
- * @param string $sql SQL query string without HAVING
- * @param string $having HAVING
- * @return string SQL with HAVING
- */
- public function applyHaving($sql,$having)
- {
- if($having!='')
- return $sql.' HAVING '.$having;
- else
- return $sql;
- }
- /**
- * Binds parameter values for an SQL command.
- * @param CDbCommand $command database command
- * @param array $values values for binding (integer-indexed array for question mark placeholders, string-indexed array for named placeholders)
- */
- public function bindValues($command, $values)
- {
- if(($n=count($values))===0)
- return;
- if(isset($values[0])) // question mark placeholders
- {
- for($i=0;$i<$n;++$i)
- $command->bindValue($i+1,$values[$i]);
- }
- else // named placeholders
- {
- foreach($values as $name=>$value)
- {
- if($name[0]!==':')
- $name=':'.$name;
- $command->bindValue($name,$value);
- }
- }
- }
- /**
- * Creates a query criteria.
- * @param mixed $condition query condition or criteria.
- * If a string, it is treated as query condition (the WHERE clause);
- * If an array, it is treated as the initial values for constructing a {@link CDbCriteria} object;
- * Otherwise, it should be an instance of {@link CDbCriteria}.
- * @param array $params parameters to be bound to an SQL statement.
- * This is only used when the first parameter is a string (query condition).
- * In other cases, please use {@link CDbCriteria::params} to set parameters.
- * @return CDbCriteria the created query criteria
- * @throws CException if the condition is not string, array and CDbCriteria
- */
- public function createCriteria($condition='',$params=array())
- {
- if(is_array($condition))
- $criteria=new CDbCriteria($condition);
- elseif($condition instanceof CDbCriteria)
- $criteria=clone $condition;
- else
- {
- $criteria=new CDbCriteria;
- $criteria->condition=$condition;
- $criteria->params=$params;
- }
- return $criteria;
- }
- /**
- * Creates a query criteria with the specified primary key.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param mixed $pk primary key value(s). Use array for multiple primary keys. For composite key, each key value must be an array (column name=>column value).
- * @param mixed $condition query condition or criteria.
- * If a string, it is treated as query condition;
- * If an array, it is treated as the initial values for constructing a {@link CDbCriteria};
- * Otherwise, it should be an instance of {@link CDbCriteria}.
- * @param array $params parameters to be bound to an SQL statement.
- * This is only used when the second parameter is a string (query condition).
- * In other cases, please use {@link CDbCriteria::params} to set parameters.
- * @param string $prefix column prefix (ended with dot). If null, it will be the table name
- * @return CDbCriteria the created query criteria
- */
- public function createPkCriteria($table,$pk,$condition='',$params=array(),$prefix=null)
- {
- $this->ensureTable($table);
- $criteria=$this->createCriteria($condition,$params);
- if($criteria->alias!='')
- $prefix=$this->_schema->quoteTableName($criteria->alias).'.';
- if(!is_array($pk)) // single key
- $pk=array($pk);
- if(is_array($table->primaryKey) && !isset($pk[0]) && $pk!==array()) // single composite key
- $pk=array($pk);
- $condition=$this->createInCondition($table,$table->primaryKey,$pk,$prefix);
- if($criteria->condition!='')
- $criteria->condition=$condition.' AND ('.$criteria->condition.')';
- else
- $criteria->condition=$condition;
- return $criteria;
- }
- /**
- * Generates the expression for selecting rows of specified primary key values.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $values list of primary key values to be selected within
- * @param string $prefix column prefix (ended with dot). If null, it will be the table name
- * @return string the expression for selection
- */
- public function createPkCondition($table,$values,$prefix=null)
- {
- $this->ensureTable($table);
- return $this->createInCondition($table,$table->primaryKey,$values,$prefix);
- }
- /**
- * Creates a query criteria with the specified column values.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $columns column values that should be matched in the query (name=>value)
- * @param mixed $condition query condition or criteria.
- * If a string, it is treated as query condition;
- * If an array, it is treated as the initial values for constructing a {@link CDbCriteria};
- * Otherwise, it should be an instance of {@link CDbCriteria}.
- * @param array $params parameters to be bound to an SQL statement.
- * This is only used when the third parameter is a string (query condition).
- * In other cases, please use {@link CDbCriteria::params} to set parameters.
- * @param string $prefix column prefix (ended with dot). If null, it will be the table name
- * @throws CDbException if specified column is not found in given table
- * @return CDbCriteria the created query criteria
- */
- public function createColumnCriteria($table,$columns,$condition='',$params=array(),$prefix=null)
- {
- $this->ensureTable($table);
- $criteria=$this->createCriteria($condition,$params);
- if($criteria->alias!='')
- $prefix=$this->_schema->quoteTableName($criteria->alias).'.';
- $bindByPosition=isset($criteria->params[0]);
- $conditions=array();
- $values=array();
- $i=0;
- if($prefix===null)
- $prefix=$table->rawName.'.';
- foreach($columns as $name=>$value)
- {
- if(($column=$table->getColumn($name))!==null)
- {
- if(is_array($value))
- $conditions[]=$this->createInCondition($table,$name,$value,$prefix);
- elseif($value!==null)
- {
- if($bindByPosition)
- {
- $conditions[]=$prefix.$column->rawName.'=?';
- $values[]=$value;
- }
- else
- {
- $conditions[]=$prefix.$column->rawName.'='.self::PARAM_PREFIX.$i;
- $values[self::PARAM_PREFIX.$i]=$value;
- $i++;
- }
- }
- else
- $conditions[]=$prefix.$column->rawName.' IS NULL';
- }
- else
- throw new CDbException(Yii::t('yii','Table "{table}" does not have a column named "{column}".',
- array('{table}'=>$table->name,'{column}'=>$name)));
- }
- $criteria->params=array_merge($values,$criteria->params);
- if(isset($conditions[0]))
- {
- if($criteria->condition!='')
- $criteria->condition=implode(' AND ',$conditions).' AND ('.$criteria->condition.')';
- else
- $criteria->condition=implode(' AND ',$conditions);
- }
- return $criteria;
- }
- /**
- * Generates the expression for searching the specified keywords within a list of columns.
- * The search expression is generated using the 'LIKE' SQL syntax.
- * Every word in the keywords must be present and appear in at least one of the columns.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param array $columns list of column names for potential search condition.
- * @param mixed $keywords search keywords. This can be either a string with space-separated keywords or an array of keywords.
- * @param string $prefix optional column prefix (with dot at the end). If null, the table name will be used as the prefix.
- * @param boolean $caseSensitive whether the search is case-sensitive. Defaults to true.
- * @throws CDbException if specified column is not found in given table
- * @return string SQL search condition matching on a set of columns. An empty string is returned
- * if either the column array or the keywords are empty.
- */
- public function createSearchCondition($table,$columns,$keywords,$prefix=null,$caseSensitive=true)
- {
- $this->ensureTable($table);
- if(!is_array($keywords))
- $keywords=preg_split('/\s+/u',$keywords,-1,PREG_SPLIT_NO_EMPTY);
- if(empty($keywords))
- return '';
- if($prefix===null)
- $prefix=$table->rawName.'.';
- $conditions=array();
- foreach($columns as $name)
- {
- if(($column=$table->getColumn($name))===null)
- throw new CDbException(Yii::t('yii','Table "{table}" does not have a column named "{column}".',
- array('{table}'=>$table->name,'{column}'=>$name)));
- $condition=array();
- foreach($keywords as $keyword)
- {
- $keyword='%'.strtr($keyword,array('%'=>'\%', '_'=>'\_', '\\'=>'\\\\')).'%';
- if($caseSensitive)
- $condition[]=$prefix.$column->rawName.' LIKE '.$this->_connection->quoteValue($keyword);
- else
- $condition[]='LOWER('.$prefix.$column->rawName.') LIKE LOWER('.$this->_connection->quoteValue($keyword).')';
- }
- $conditions[]=implode(' AND ',$condition);
- }
- return '('.implode(' OR ',$conditions).')';
- }
- /**
- * Generates the expression for selecting rows of specified primary key values.
- * @param mixed $table the table schema ({@link CDbTableSchema}) or the table name (string).
- * @param mixed $columnName the column name(s). It can be either a string indicating a single column
- * or an array of column names. If the latter, it stands for a composite key.
- * @param array $values list of key values to be selected within
- * @param string $prefix column prefix (ended with dot). If null, it will be the table name
- * @throws CDbException if specified column is not found in given table
- * @return string the expression for selection
- */
- public function createInCondition($table,$columnName,$values,$prefix=null)
- {
- if(($n=count($values))<1)
- return '0=1';
- $this->ensureTable($table);
- if($prefix===null)
- $prefix=$table->rawName.'.';
- $db=$this->_connection;
- if(is_array($columnName) && count($columnName)===1)
- $columnName=reset($columnName);
- if(is_string($columnName)) // simple key
- {
- if(!isset($table->columns[$columnName]))
- throw new CDbException(Yii::t('yii','Table "{table}" does not have a column named "{column}".',
- array('{table}'=>$table->name, '{column}'=>$columnName)));
- $column=$table->columns[$columnName];
- $values=array_values($values);
- foreach($values as &$value)
- {
- $value=$column->typecast($value);
- if(is_string($value))
- $value=$db->quoteValue($value);
- }
- if($n===1)
- return $prefix.$column->rawName.($values[0]===null?' IS NULL':'='.$values[0]);
- else
- return $prefix.$column->rawName.' IN ('.implode(', ',$values).')';
- }
- elseif(is_array($columnName)) // composite key: $values=array(array('pk1'=>'v1','pk2'=>'v2'),array(...))
- {
- foreach($columnName as $name)
- {
- if(!isset($table->columns[$name]))
- throw new CDbException(Yii::t('yii','Table "{table}" does not have a column named "{column}".',
- array('{table}'=>$table->name, '{column}'=>$name)));
- for($i=0;$i<$n;++$i)
- {
- if(isset($values[$i][$name]))
- {
- $value=$table->columns[$name]->typecast($values[$i][$name]);
- if(is_string($value))
- $values[$i][$name]=$db->quoteValue($value);
- else
- $values[$i][$name]=$value;
- }
- else
- throw new CDbException(Yii::t('yii','The value for the column "{column}" is not supplied when querying the table "{table}".',
- array('{table}'=>$table->name,'{column}'=>$name)));
- }
- }
- if(count($values)===1)
- {
- $entries=array();
- foreach($values[0] as $name=>$value)
- $entries[]=$prefix.$table->columns[$name]->rawName.($value===null?' IS NULL':'='.$value);
- return implode(' AND ',$entries);
- }
- return $this->createCompositeInCondition($table,$values,$prefix);
- }
- else
- throw new CDbException(Yii::t('yii','Column name must be either a string or an array.'));
- }
- /**
- * Generates the expression for selecting rows with specified composite key values.
- * @param CDbTableSchema $table the table schema
- * @param array $values list of primary key values to be selected within
- * @param string $prefix column prefix (ended with dot)
- * @return string the expression for selection
- */
- protected function createCompositeInCondition($table,$values,$prefix)
- {
- $keyNames=array();
- foreach(array_keys($values[0]) as $name)
- $keyNames[]=$prefix.$table->columns[$name]->rawName;
- $vs=array();
- foreach($values as $value)
- $vs[]='('.implode(', ',$value).')';
- return '('.implode(', ',$keyNames).') IN ('.implode(', ',$vs).')';
- }
- /**
- * Checks if the parameter is a valid table schema.
- * If it is a string, the corresponding table schema will be retrieved.
- * @param mixed $table table schema ({@link CDbTableSchema}) or table name (string).
- * If this refers to a valid table name, this parameter will be returned with the corresponding table schema.
- * @throws CDbException if the table name is not valid
- */
- protected function ensureTable(&$table)
- {
- if(is_string($table) && ($table=$this->_schema->getTable($tableName=$table))===null)
- throw new CDbException(Yii::t('yii','Table "{table}" does not exist.',
- array('{table}'=>$tableName)));
- }
- /**
- * Returns default value of the integer/serial primary key. Default value means that the next
- * autoincrement/sequence value would be used.
- * @return string default value of the integer/serial primary key.
- * @since 1.1.14
- */
- protected function getIntegerPrimaryKeyDefaultValue()
- {
- return 'NULL';
- }
- }
|