PHP Класс yii\redis\ActiveQuery

An ActiveQuery can be a normal query or be used in a relational context. ActiveQuery instances are usually created by [[ActiveRecord::find()]]. Relational queries are created by [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]]. Normal Query ------------ ActiveQuery mainly provides the following methods to retrieve the query results: - ActiveQuery::one: returns a single record populated with the first row of data. - ActiveQuery::all: returns all records based on the query results. - ActiveQuery::count: returns the number of records. - ActiveQuery::sum: returns the sum over the specified column. - ActiveQuery::average: returns the average over the specified column. - ActiveQuery::min: returns the min over the specified column. - ActiveQuery::max: returns the max over the specified column. - ActiveQuery::scalar: returns the value of the first column in the first row of the query result. - ActiveQuery::exists: returns a value indicating whether the query result has data or not. You can use query methods, such as [[where()]], [[limit()]] and [[orderBy()]] to customize the query options. ActiveQuery also provides the following additional query options: - [[with()]]: list of relations that this query should be performed with. - [[indexBy()]]: the name of the column by which the query result should be indexed. - [[asArray()]]: whether to return each record as an array. These options can be configured using methods of the same name. For example: php $customers = Customer::find()->with('orders')->asArray()->all(); Relational query ---------------- In relational context ActiveQuery represents a relation between two Active Record classes. Relational ActiveQuery instances are usually created by calling [[ActiveRecord::hasOne()]] and [[ActiveRecord::hasMany()]]. An Active Record class declares a relation by defining a getter method which calls one of the above methods and returns the created ActiveQuery object. A relation is specified by [[link]] which represents the association between columns of different tables; and the multiplicity of the relation is indicated by [[multiple]]. If a relation involves a junction table, it may be specified by [[via()]]. This methods may only be called in a relational context. Same is true for [[inverseOf()]], which marks a relation as inverse of another relation.
С версии: 2.0
Автор: Carsten Brandt ([email protected])
Наследование: extends yii\base\Component, implements yii\db\ActiveQueryInterface, use trait yii\db\QueryTrait, use trait yii\db\ActiveQueryTrait, use trait yii\db\ActiveRelationTrait
Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод Описание
__construct ( array $modelClass, array $config = [] ) Constructor.
all ( Connection $db = null ) : array | yii\redis\ActiveRecord[] Executes the query and returns all results as an array.
average ( string $column, Connection $db = null ) : integer Returns the average of the specified column values.
column ( string $column, Connection $db = null ) : array Executes the query and returns the first column of the result.
count ( string $q = '*', Connection $db = null ) : integer Returns the number of records.
exists ( Connection $db = null ) : boolean Returns a value indicating whether the query result contains any row of data.
init ( ) Initializes the object.
max ( string $column, Connection $db = null ) : integer Returns the maximum of the specified column values.
min ( string $column, Connection $db = null ) : integer Returns the minimum of the specified column values.
one ( Connection $db = null ) : yii\redis\ActiveRecord | array | null Executes the query and returns a single row of result.
scalar ( string $attribute, Connection $db = null ) : string Returns the query result as a scalar value.
sum ( string $column, Connection $db = null ) : integer Returns the number of records.

Защищенные методы

Метод Описание
executeScript ( Connection | null $db, string $type, string $columnName = null ) : array | boolean | null | string Executes a script created by [[LuaScriptBuilder]]

Приватные методы

Метод Описание
findByPk ( Connection $db, string $type, string $columnName = null ) : array | boolean | null | string Fetch by pk if possible as this is much faster

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( array $modelClass, array $config = [] )
$modelClass array the model class associated with this query
$config array configurations to be applied to the newly created query object

all() публичный Метод

Executes the query and returns all results as an array.
public all ( Connection $db = null ) : array | yii\redis\ActiveRecord[]
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат array | yii\redis\ActiveRecord[] the query results. If the query results in nothing, an empty array will be returned.

average() публичный Метод

Returns the average of the specified column values.
public average ( string $column, Connection $db = null ) : integer
$column string the column name or expression. Make sure you properly quote column names in the expression.
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат integer the average of the specified column values.

column() публичный Метод

Executes the query and returns the first column of the result.
public column ( string $column, Connection $db = null ) : array
$column string name of the column to select
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат array the first column of the query result. An empty array is returned if the query results in nothing.

count() публичный Метод

Returns the number of records.
public count ( string $q = '*', Connection $db = null ) : integer
$q string the COUNT expression. This parameter is ignored by this implementation.
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат integer number of records

executeScript() защищенный Метод

Executes a script created by [[LuaScriptBuilder]]
protected executeScript ( Connection | null $db, string $type, string $columnName = null ) : array | boolean | null | string
$db Connection | null the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
$type string the type of the script to generate
$columnName string
Результат array | boolean | null | string

exists() публичный Метод

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.
Результат boolean whether the query result contains any row of data.

init() публичный Метод

This method is called at the end of the constructor. The default implementation will trigger an [[EVENT_INIT]] event. If you override this method, make sure you call the parent implementation at the end to ensure triggering of the event.
public init ( )

max() публичный Метод

Returns the maximum of the specified column values.
public max ( string $column, Connection $db = null ) : integer
$column string the column name or expression. Make sure you properly quote column names in the expression.
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат integer the maximum of the specified column values.

min() публичный Метод

Returns the minimum of the specified column values.
public min ( string $column, Connection $db = null ) : integer
$column string the column name or expression. Make sure you properly quote column names in the expression.
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат integer the minimum of the specified column values.

one() публичный Метод

Executes the query and returns a single row of result.
public one ( Connection $db = null ) : yii\redis\ActiveRecord | array | null
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат yii\redis\ActiveRecord | array | null a 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.

scalar() публичный Метод

The value returned will be the specified attribute in the first record of the query results.
public scalar ( string $attribute, Connection $db = null ) : string
$attribute string name of the attribute to select
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат string the value of the specified attribute in the first record of the query result. Null is returned if the query result is empty.

sum() публичный Метод

Returns the number of records.
public sum ( string $column, Connection $db = null ) : integer
$column string the column to sum up
$db Connection the database connection used to execute the query. If this parameter is not given, the `db` application component will be used.
Результат integer number of records