PHP Interface yii\db\QueryInterface

addOrderBy() public method

Adds additional ORDER BY columns to the query.

public addOrderBy ( string | array $columns )
$columns	string | array	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. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

all() public method

Executes the query and returns all results as an array.

public all ( Connection $db = null ) : array
$db	Connection	the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
return	array	the query results. If the query results in nothing, an empty array will be returned.

andFilterWhere() public method

The new condition and the existing one will be joined using the 'AND' operator.

public andFilterWhere ( array $condition )
$condition	array	the new WHERE condition. Please refer to [[where()]] on how to specify this parameter.

andWhere() public method

The new condition and the existing one will be joined using the 'AND' operator.

public andWhere ( string | array $condition )
$condition	string | array	the new WHERE condition. Please refer to [[where()]] on how to specify this parameter.

count() public method

Returns the number of records.

public count ( string $q = '*', Connection $db = null ) : integer
$q	string	the COUNT expression. Defaults to '*'.
$db	Connection	the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
return	integer	number of records.

emulateExecution() public method

After this mode is enabled, methods, returning query results like QueryInterface::one, QueryInterface::all, QueryInterface::exists and so on, will return empty or false values. You should use this method in case your program logic indicates query should not return any results, like in case you set false where condition like 0=1.

public emulateExecution ( boolean $value = true )
$value	boolean	whether to prevent query execution.

exists() public method

Returns a value indicating whether the query result contains any row of data.

public exists ( Connection $db = null ) : boolean
$db	Connection	the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
return	boolean	whether the query result contains any row of data.

filterWhere() public method

Sets the WHERE part of the query ignoring empty parameters.

public filterWhere ( array $condition )
$condition	array	the conditions that should be put in the WHERE part. Please refer to [[where()]] on how to specify this parameter.

indexBy() public method

Sets the [[indexBy]] property.

public indexBy ( string | callable $column )
$column	string | callable	the name of the column by which the query results should be indexed by. This can also be a callable (e.g. anonymous function) that returns the index value based on the given row data. The signature of the callable should be: ```php function ($row) { // return the index value corresponding to $row } ```

limit() public method

Sets the LIMIT part of the query.

public limit ( integer $limit )
$limit	integer	the limit. Use null or negative value to disable limit.

offset() public method

Sets the OFFSET part of the query.

public offset ( integer $offset )
$offset	integer	the offset. Use null or negative value to disable offset.

one() public method

Executes the query and returns a single row of result.

public one ( Connection $db = null ) : array | boolean
$db	Connection	the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
return	array | boolean	the first row (in terms of an array) of the query result. False is returned if the query results in nothing.

orFilterWhere() public method

The new condition and the existing one will be joined using the 'OR' operator.

public orFilterWhere ( array $condition )
$condition	array	the new WHERE condition. Please refer to [[where()]] on how to specify this parameter.

orWhere() public method

The new condition and the existing one will be joined using the 'OR' operator.

public orWhere ( string | array $condition )
$condition	string | array	the new WHERE condition. Please refer to [[where()]] on how to specify this parameter.

orderBy() public method

Sets the ORDER BY part of the query.

public orderBy ( string | array $columns )
$columns	string | array	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. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).

where() public method

The $condition specified as an array can be in one of the following two formats: - hash format: ['column1' => value1, 'column2' => value2, ...] - operator format: [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: - ['type' => 1, 'status' => 2] generates (type = 1) AND (status = 2). - ['id' => [1, 2, 3], 'status' => 2] generates (id IN (1, 2, 3)) AND (status = 2). - ['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 following: - **and**: the operands should be concatenated together using AND. For example, ['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, ['and', 'type=1', ['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. For example, ['or', ['type' => [7, 8, 9]], ['id' => [1, 2, 3]]] will generate (type IN (7, 8, 9) OR (id IN (1, 2, 3))). - **not**: this will take only one operand and build the negation of it by prefixing the query string with NOT. For example ['not', ['attribute' => null]] will result in the condition NOT (attribute IS NULL). - **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, ['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, ['in', 'id', [1, 2, 3]] will generate id IN (1, 2, 3). The method will properly quote the column name and escape values in the range. To create a composite IN condition you can use and array for the column name and value, where the values are indexed by the column name: ['in', ['id', 'name'], [['id' => 1, 'name' => 'foo'], ['id' => 2, 'name' => 'bar']] ]. You may also specify a sub-query that is used to get the values for the IN-condition: ['in', 'user_id', (new Query())->select('id')->from('users')->where(['active' => 1])] - **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, ['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, ['like', 'name', ['test', 'sample']] will generate name LIKE '%test%' AND name LIKE '%sample%'. The method will properly quote the column name and escape special characters in the values. Sometimes, you may want to add the percentage characters to the matching value by yourself, you may supply a third operand false to do so. For example, ['like', 'name', '%tester', false] will generate name LIKE '%tester'. - **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. - **exists**: operand 1 is a query object that used to build an EXISTS condition. For example ['exists', (new Query())->select('id')->from('users')->where(['active' => 1])] will result in the following SQL expression: EXISTS (SELECT "id" FROM "users" WHERE "active"=1). - **not exists**: similar to the exists operator except that EXISTS is replaced with NOT EXISTS in the generated condition. - Additionally you can specify arbitrary operators as follows: A condition of ['>=', 'id', 10] will result in the following SQL expression: id >= 10.

public where ( string | array $condition )
$condition	string | array	the conditions that should be put in the WHERE part.