Class yii\redis\ActiveQuery
| Inheritance | yii\redis\ActiveQuery » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable, yii\db\ActiveQueryInterface |
| Uses Traits | yii\db\ActiveQueryTrait, yii\db\ActiveRelationTrait, yii\db\QueryTrait |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-redis/blob/master/ActiveQuery.php |
ActiveQuery represents a query associated with an Active Record class.
An ActiveQuery can be a normal query or be used in a relational context.
ActiveQuery instances are usually created by yii\redis\ActiveRecord::find(). Relational queries are created by yii\redis\ActiveRecord::hasOne() and yii\redis\ActiveRecord::hasMany().
Normal Query ¶
ActiveQuery mainly provides the following methods to retrieve the query results:
- one(): returns a single record populated with the first row of data.
- all(): returns all records based on the query results.
- count(): returns the number of records.
- sum(): returns the sum over the specified column.
- average(): returns the average over the specified column.
- min(): returns the min over the specified column.
- max(): returns the max over the specified column.
- scalar(): returns the value of the first column in the first row of the query result.
- 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:
$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 yii\redis\ActiveRecord::hasOne() and yii\redis\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.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $asArray | boolean | Whether to return each record as an array. | yii\db\ActiveQueryTrait |
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component | yii\base\Component |
| $emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\db\QueryTrait |
| $indexBy | string|callable | The name of the column by which the query results should be indexed by. | yii\db\QueryTrait |
| $inverseOf | string | The name of the relation that is the inverse of this relation. | yii\db\ActiveRelationTrait |
| $limit | integer|yii\db\ExpressionInterface | Maximum number of records to be returned. | yii\db\QueryTrait |
| $link | array | The columns of the primary and foreign tables that establish a relation. | yii\db\ActiveRelationTrait |
| $modelClass | string | The name of the ActiveRecord class. | yii\db\ActiveQueryTrait |
| $multiple | boolean | Whether this query represents a relation to more than one record. | yii\db\ActiveRelationTrait |
| $offset | integer|yii\db\ExpressionInterface | Zero-based offset from where the records are to be returned. | yii\db\QueryTrait |
| $orderBy | array | How to sort the query results. | yii\db\QueryTrait |
| $primaryModel | yii\db\ActiveRecord | The primary model of a relational query. | yii\db\ActiveRelationTrait |
| $via | array|object | The query associated with the junction table. | yii\db\ActiveRelationTrait |
| $where | string|array|yii\db\ExpressionInterface | Query condition. | yii\db\QueryTrait |
| $with | array | A list of relations that this query should be performed with | yii\db\ActiveQueryTrait |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | Clones internal objects. | yii\db\ActiveRelationTrait |
| __construct() | Constructor. | yii\redis\ActiveQuery |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| addOrderBy() | Adds additional ORDER BY columns to the query. | yii\db\QueryTrait |
| all() | Executes the query and returns all results as an array. | yii\redis\ActiveQuery |
| andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait |
| andWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait |
| asArray() | Sets the asArray() property. | yii\db\ActiveQueryTrait |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| average() | Returns the average of the specified column values. | yii\redis\ActiveQuery |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| column() | Executes the query and returns the first column of the result. | yii\redis\ActiveQuery |
| count() | Returns the number of records. | yii\redis\ActiveQuery |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| emulateExecution() | Sets whether to emulate query execution, preventing any interaction with data storage. | yii\db\QueryTrait |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| exists() | Returns a value indicating whether the query result contains any row of data. | yii\redis\ActiveQuery |
| filterWhere() | Sets the WHERE part of the query but ignores empty operands. | yii\db\QueryTrait |
| findFor() | Finds the related records for the specified primary record. | yii\db\ActiveRelationTrait |
| findWith() | Finds records corresponding to one or multiple relations and populates them into the primary models. | yii\db\ActiveQueryTrait |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| indexBy() | Sets the indexBy() property. | yii\db\QueryTrait |
| init() | Initializes the object. | yii\redis\ActiveQuery |
| inverseOf() | Sets the name of the relation that is the inverse of this relation. | yii\db\ActiveRelationTrait |
| limit() | Sets the LIMIT part of the query. | yii\db\QueryTrait |
| max() | Returns the maximum of the specified column values. | yii\redis\ActiveQuery |
| min() | Returns the minimum of the specified column values. | yii\redis\ActiveQuery |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| offset() | Sets the OFFSET part of the query. | yii\db\QueryTrait |
| on() | Attaches an event handler to an event. | yii\base\Component |
| one() | Executes the query and returns a single row of result. | yii\redis\ActiveQuery |
| orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait |
| orWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait |
| orderBy() | Sets the ORDER BY part of the query. | yii\db\QueryTrait |
| populateRelation() | Finds the related records and populates them into the primary models. | yii\db\ActiveRelationTrait |
| scalar() | Returns the query result as a scalar value. | yii\redis\ActiveQuery |
| sum() | Returns the number of records. | yii\redis\ActiveQuery |
| trigger() | Triggers an event. | yii\base\Component |
| via() | Specifies the relation associated with the junction table. | yii\db\ActiveRelationTrait |
| where() | Sets the WHERE part of the query. | yii\db\QueryTrait |
| with() | Specifies the relations with which this query should be performed. | yii\db\ActiveQueryTrait |
Protected Methods
| Method | Description | Defined By |
|---|---|---|
| createModels() | Converts found rows into model instances. | yii\db\ActiveQueryTrait |
| executeScript() | Executes a script created by yii\redis\LuaScriptBuilder | yii\redis\ActiveQuery |
| filterCondition() | Removes empty operands from the given query condition. | yii\db\QueryTrait |
| isEmpty() | Returns a value indicating whether the give value is "empty". | yii\db\QueryTrait |
| normalizeOrderBy() | Normalizes format of ORDER BY data. | yii\db\QueryTrait |
Events
| Event | Type | Description | Defined By |
|---|---|---|---|
| EVENT_INIT | \yii\redis\Event | An event that is triggered when the query is initialized via init(). | yii\redis\ActiveQuery |
Method Details
Constructor.
| public void __construct ( $modelClass, $config = [] ) | ||
| $modelClass | string | The model class associated with this query |
| $config | array | Configurations to be applied to the newly created query object |
Executes the query and returns all results as an array.
| public array|yii\redis\ActiveRecord[] all ( $db = null ) | ||
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | array|yii\redis\ActiveRecord[] | The query results. If the query results in nothing, an empty array will be returned. |
|---|---|---|
Returns the average of the specified column values.
| public integer average ( $column, $db = null ) | ||
| $column | string | The column name or expression. Make sure you properly quote column names in the expression. |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | integer | The average of the specified column values. |
|---|---|---|
Executes the query and returns the first column of the result.
| public array column ( $column, $db = null ) | ||
| $column | string | Name of the column to select |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | array | The first column of the query result. An empty array is returned if the query results in nothing. |
|---|---|---|
Returns the number of records.
| public integer count ( $q = '*', $db = null ) | ||
| $q | string | The COUNT expression. This parameter is ignored by this implementation. |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | integer | Number of records |
|---|---|---|
Executes a script created by yii\redis\LuaScriptBuilder
| protected array|boolean|null|string executeScript ( $db, $type, $columnName = null ) | ||
| $db | yii\redis\Connection|null | The database connection used to execute the query.
If this parameter is not given, the |
| $type | string | The type of the script to generate |
| $columnName | string | |
| throws | yii\base\NotSupportedException | |
|---|---|---|
Returns a value indicating whether the query result contains any row of data.
| public boolean exists ( $db = null ) | ||
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | boolean | Whether the query result contains any row of data. |
|---|---|---|
Initializes the object.
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 void init ( ) |
Returns the maximum of the specified column values.
| public integer max ( $column, $db = null ) | ||
| $column | string | The column name or expression. Make sure you properly quote column names in the expression. |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | integer | The maximum of the specified column values. |
|---|---|---|
Returns the minimum of the specified column values.
| public integer min ( $column, $db = null ) | ||
| $column | string | The column name or expression. Make sure you properly quote column names in the expression. |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | integer | The minimum of the specified column values. |
|---|---|---|
Executes the query and returns a single row of result.
| public yii\redis\ActiveRecord|array|null one ( $db = null ) | ||
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | 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. |
|---|---|---|
Returns the query result as a scalar value.
The value returned will be the specified attribute in the first record of the query results.
| public string scalar ( $attribute, $db = null ) | ||
| $attribute | string | Name of the attribute to select |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | string | The value of the specified attribute in the first record of the query result. Null is returned if the query result is empty. |
|---|---|---|
Returns the number of records.
| public integer sum ( $column, $db = null ) | ||
| $column | string | The column to sum up |
| $db | yii\redis\Connection | The database connection used to execute the query.
If this parameter is not given, the |
| return | integer | Number of records |
|---|---|---|
Event Details
An event that is triggered when the query is initialized via init().