# Class yii\elasticsearch\ActiveQuery

Inheritance | yii\elasticsearch\ActiveQuery » yii\elasticsearch\Query » yii\base\Component » yii\base\BaseObject
Implements | yii\base\Configurable, yii\db\ActiveQueryInterface, yii\db\QueryInterface
Uses Traits | yii\db\ActiveQueryTrait, yii\db\ActiveRelationTrait, yii\db\QueryTrait
Available since version | 2.0
Source Code | https://github.com/yiisoft/yii2-elasticsearch/blob/master/ActiveQuery.php

ActiveQuery represents a yii\elasticsearch\Query associated with an yii\elasticsearch\ActiveRecord class.

An ActiveQuery can be a normal query or be used in a relational context.

ActiveQuery instances are usually created by yii\elasticsearch\ActiveRecord::find(). Relational queries are created by yii\elasticsearch\ActiveRecord::hasOne() and yii\elasticsearch\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.
- scalar(): returns the value of the first column in the first row of the query result.
- column(): returns the value of the first column in the query result.
- exists(): returns a value indicating whether the query result has data or not.

Because ActiveQuery extends from yii\elasticsearch\Query, one can use query methods, such as where(), 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();

> Note: Elasticsearch limits the number of records returned to 10 records by default. If you expect to get more records you should specify limit explicitly.

## Relational query ¶

In relational context ActiveQuery represents a relation between two Active Record classes.

Relational ActiveQuery instances are usually created by calling yii\elasticsearch\ActiveRecord::hasOne() and yii\elasticsearch\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.

> Note: Elasticsearch limits the number of records returned by any query to 10 records by default. If you expect to get more records you should specify limit explicitly in relation definition. This is also important for relations that use via() so that if via records are limited to 10 the relations records can also not be more than 10.

> Note: Currently with() is not supported in combination with asArray().

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$aggregations | array | List of aggregations to add to this query. | yii\elasticsearch\Query
$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
$collapse | array | List of collapse to add to this query. | yii\elasticsearch\Query
$emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\db\QueryTrait
$explain | boolean | Enables explanation for each hit on how its score was computed. | yii\elasticsearch\Query
$fields | array | Use the fields parameter to retrieve the values of runtime fields. | yii\elasticsearch\Query
$filter | array|string | The filter part of this search query. | yii\elasticsearch\Query
$highlight | array | The highlight part of this search query. | yii\elasticsearch\Query
$index | string|array | The index to retrieve data from. | yii\elasticsearch\Query
$indexBy | string|callable|null | 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|null | 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
$minScore | float | Exclude documents which have a _score less than the minimum specified in min_score | yii\elasticsearch\Query
$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|null | Zero-based offset from where the records are to be returned. | yii\db\QueryTrait
$options | array | List of options that will passed to commands created by this query. | yii\elasticsearch\Query
$orderBy | array|null | How to sort the query results. | yii\db\QueryTrait
$postFilter | string|array | The `post_filter` part of the search query for differentially filter search results and aggregations. | yii\elasticsearch\Query
$primaryModel | yii\db\ActiveRecord | The primary model of a relational query. | yii\db\ActiveRelationTrait
$query | array|string | The query part of this search query. | yii\elasticsearch\Query
$runtimeMappings | array | An array of runtime fields evaluated at query time Example: ```php $query->$runtimeMappings = [ 'value_times_two' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * 2)", ], 'value_times_factor' => [ 'type' => 'double', 'script' => "emit(doc['my_field_name'].value * factor)", 'params' => [ 'factor' => 2.0 ], ], ] ``` | yii\elasticsearch\Query
$scriptFields | array | The scripted fields being retrieved from the documents. | yii\elasticsearch\Query
$source | array | This option controls how the `_source` field is returned from the documents. | yii\elasticsearch\Query
$stats | array | The 'stats' part of the query. | yii\elasticsearch\Query
$storedFields | array | The fields being retrieved from the documents. | yii\elasticsearch\Query
$suggest | array | List of suggesters to add to this query. | yii\elasticsearch\Query
$timeout | integer | A search timeout, bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. | yii\elasticsearch\Query
$type | string|array | The type to retrieve data from. | yii\elasticsearch\Query
$via | array|object | The query associated with the junction table. | yii\db\ActiveRelationTrait
$where | string|array|yii\db\ExpressionInterface|null | Query condition. | yii\db\QueryTrait
$with | array | A list of relations that this query should be performed with | yii\db\ActiveQueryTrait

## Public Methods

Hide inherited 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\elasticsearch\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
addAgg() |  | yii\elasticsearch\Query
addAggregate() | Adds an aggregation to this query. Supports nested aggregations. | yii\elasticsearch\Query
addAggregation() |  | yii\elasticsearch\Query
addCollapse() | Adds a collapse to this query. | yii\elasticsearch\Query
addOptions() | Adds more options, overwriting existing options. | yii\elasticsearch\Query
addOrderBy() | Adds additional ORDER BY columns to the query. | yii\db\QueryTrait
addSuggester() | Adds a suggester to this query. | yii\elasticsearch\Query
all() | Executes query and returns all results as an array. | yii\elasticsearch\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
batch() | Starts a batch query. | yii\elasticsearch\Query
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\elasticsearch\ActiveQuery
count() | Returns the number of records. | yii\elasticsearch\Query
createCommand() | Creates a DB command that can be used to execute this query. | yii\elasticsearch\ActiveQuery
delete() | Executes the query and deletes all matching documents. | yii\elasticsearch\Query
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
each() | Starts a batch query and retrieves data row by row. | yii\elasticsearch\Query
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\elasticsearch\Query
explain() | Explain for how the score of each document was computer | yii\elasticsearch\Query
fields() | Sets the runtime fields to retrieve from the documents. | yii\elasticsearch\Query
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
from() | Sets the index and type to retrieve documents from. | yii\elasticsearch\Query
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
highlight() | Sets a highlight parameters to retrieve from the documents. | yii\elasticsearch\Query
indexBy() | Sets the indexBy() property. | yii\db\QueryTrait
init() | Initializes the object. | yii\elasticsearch\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
minScore() |  | yii\elasticsearch\Query
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 query and returns a single row of result. | yii\elasticsearch\ActiveQuery
options() | Sets the options to be passed to the command created by this query. | yii\elasticsearch\Query
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
populate() | Converts the raw query results into the format as specified by this query. This method is internally used to convert the data fetched from database into the format as required by this query. | yii\elasticsearch\ActiveQuery
populateRelation() | Finds the related records and populates them into the primary models. | yii\db\ActiveRelationTrait
postFilter() | Set the `post_filter` part of the search query. | yii\elasticsearch\Query
query() | Sets the query part of this search query. | yii\elasticsearch\Query
runtimeMappings() | Sets the runtime mappings for this query | yii\elasticsearch\Query
scalar() | Returns the query result as a scalar value. The value returned will be the specified field in the first document of the query results. | yii\elasticsearch\Query
scriptFields() | Sets the script fields to retrieve from the documents. | yii\elasticsearch\Query
search() | Executes the query and returns the complete search result including e.g. | yii\elasticsearch\ActiveQuery
source() | Sets the source filtering, specifying how the `_source` field of the document should be returned. | yii\elasticsearch\Query
stats() | Adds a 'stats' part to the query. | yii\elasticsearch\Query
storedFields() | Sets the fields to retrieve from the documents. | yii\elasticsearch\Query
timeout() | Sets the search timeout. | yii\elasticsearch\Query
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

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
createModels() | Converts found rows into model instances. | yii\db\ActiveQueryTrait
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

Hide inherited events

Event | Type | Description | Defined By
--- | --- | --- | ---
EVENT_INIT | yii\elasticsearch\Event | An event that is triggered when the query is initialized via init(). | yii\elasticsearch\ActiveQuery

## Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name | string | The method name
$params | array | Method parameters
return | mixed | The method return value
throws | yii\base\UnknownMethodException | when calling unknown method

Source code

                    public function __call($name, $params)
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $object) {
            if ($object->hasMethod($name)) {
                return call_user_func_array([$object, $name], $params);
            }
        }
        throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
    }

__clone() public method

Defined in: yii\db\ActiveRelationTrait::__clone()

Clones internal objects.

public void __clone ( )

Source code

                    public function __clone()
    {
        parent::__clone();
        // make a clone of "via" object so that the same query object can be reused multiple times
        if (is_object($this->via)) {
            $this->via = clone $this->via;
        } elseif (is_array($this->via)) {
            $this->via = [$this->via[0], clone $this->via[1], $this->via[2]];
        }
    }

__construct() public method

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

Source code

                    public function __construct($modelClass, $config = [])
    {
        $this->modelClass = $modelClass;
        parent::__construct($config);
    }

__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a getter: return the getter result
- a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$value = $component->property;`.

See also __set().

public mixed __get ( $name )
$name | string | The property name
return | mixed | The property value or the value of a behavior's property
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is write-only.

Source code

                    public function __get($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            // read property, e.g. getName()
            return $this->$getter();
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name;
            }
        }
        if (method_exists($this, 'set' . $name)) {
            throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
    }

__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

- a property defined by a setter: return whether the property is set
- a property of a behavior: return whether the property is set
- return `false` for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `isset($component->property)`.

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name | string | The property name or the event name
return | boolean | Whether the named property is set

Source code

                    public function __isset($name)
    {
        $getter = 'get' . $name;
        if (method_exists($this, $getter)) {
            return $this->$getter() !== null;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name)) {
                return $behavior->$name !== null;
            }
        }
        return false;
    }

__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value
- an event in the format of "on xyz": attach the handler to the event "xyz"
- a behavior in the format of "as xyz": attach the behavior named as "xyz"
- a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `$component->property = $value;`.

See also __get().

public void __set ( $name, $value )
$name | string | The property name or the event name
$value | mixed | The property value
throws | yii\base\UnknownPropertyException | if the property is not defined
throws | yii\base\InvalidCallException | if the property is read-only.

Source code

                    public function __set($name, $value)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            // set property
            $this->$setter($value);
            return;
        } elseif (strncmp($name, 'on ', 3) === 0) {
            // on event: attach event handler
            $this->on(trim(substr($name, 3)), $value);
            return;
        } elseif (strncmp($name, 'as ', 3) === 0) {
            // as behavior: attach behavior
            $name = trim(substr($name, 3));
            $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = $value;
                return;
            }
        }
        if (method_exists($this, 'get' . $name)) {
            throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
        }
        throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
    }

__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

- a property defined by a setter: set the property value to be null
- a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing `unset($component->property)`.

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name | string | The property name
throws | yii\base\InvalidCallException | if the property is read only.

Source code

                    public function __unset($name)
    {
        $setter = 'set' . $name;
        if (method_exists($this, $setter)) {
            $this->$setter(null);
            return;
        }
        // behavior property
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name)) {
                $behavior->$name = null;
                return;
            }
        }
        throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
    }

addAgg() public method
Deprecated since 2.0.5 use addAggregate() instead Adds an aggregation to this query. This is an alias for addAggregation().

Defined in: yii\elasticsearch\Query::addAgg()

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html.

public $this addAgg ( $name, $type, $options )
$name | string | The name of the aggregation
$type | string | The aggregation type. e.g. `terms`, `range`, `histogram`...
$options | string|array | The configuration options for this aggregation. Can be an array or a json string.
return | $this | The query object itself

Source code

                    public function addAgg($name, $type, $options)
    {
        return $this->addAggregate($name, [$type => $options]);
    }

addAggregate() public method

Defined in: yii\elasticsearch\Query::addAggregate()

Adds an aggregation to this query. Supports nested aggregations.

See also https://www.elastic.co/guide/en/elasticsearch/reference/2.3/search-aggregations.html.

public $this addAggregate ( $name, $options )
$name | string | The name of the aggregation
$options | string|array | The configuration options for this aggregation. Can be an array or a json string.
return | $this | The query object itself

Source code

                    public function addAggregate($name, $options)
    {
        $this->aggregations[$name] = $options;
        return $this;
    }

addAggregation() public method
Deprecated since 2.0.5 use addAggragate() instead Adds an aggregation to this query.

Defined in: yii\elasticsearch\Query::addAggregation()

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html.

public $this addAggregation ( $name, $type, $options )
$name | string | The name of the aggregation
$type | string | The aggregation type. e.g. `terms`, `range`, `histogram`, ...
$options | string|array | The configuration options for this aggregation. Can be an array or a json string.
return | $this | The query object itself

Source code

                    public function addAggregation($name, $type, $options)
    {
        return $this->addAggregate($name, [$type => $options]);
    }

addCollapse() public method (available since version 2.1.0)

Defined in: yii\elasticsearch\Query::addCollapse()

Adds a collapse to this query.

See also https://www.elastic.co/guide/en/elasticsearch/reference/5.3/search-request-collapse.html#search-request-collapse.

public $this addCollapse ( $collapse )
$collapse | array | The configuration options for collapse.
return | $this | The query object itself

Source code

                    public function addCollapse($collapse)
    {
        $this->collapse = $collapse;
        return $this;
    }

addOptions() public method (available since version 2.0.4)

Defined in: yii\elasticsearch\Query::addOptions()

Adds more options, overwriting existing options.

See also options().

public $this addOptions ( $options )
$options | array | The options to be added.
return | $this | The query object itself
throws | yii\base\InvalidArgumentException | if $options is not an array

Source code

                    public function addOptions($options)
    {
        if (!is_array($options)) {
            throw new InvalidArgumentException('Array parameter expected, ' . gettype($options) . ' received.');
        }
        $this->options = array_merge($this->options, $options);
        return $this;
    }

addOrderBy() public method

Defined in: yii\db\QueryTrait::addOrderBy()

Adds additional ORDER BY columns to the query.

See also orderBy().

public $this addOrderBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface

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).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL.

return | $this | The query object itself

Source code

                    public function addOrderBy($columns)
    {
        $columns = $this->normalizeOrderBy($columns);
        if ($this->orderBy === null) {
            $this->orderBy = $columns;
        } else {
            $this->orderBy = array_merge($this->orderBy, $columns);
        }
        return $this;
    }

addSuggester() public method

Defined in: yii\elasticsearch\Query::addSuggester()

Adds a suggester to this query.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-suggesters.html.

public $this addSuggester ( $name, $definition )
$name | string | The name of the suggester
$definition | string|array | The configuration options for this suggester. Can be an array or a json string.
return | $this | The query object itself

Source code

                    public function addSuggester($name, $definition)
    {
        $this->suggest[$name] = $definition;
        return $this;
    }

all() public method

Executes query and returns all results as an array.

public array all ( $db = null )
$db | yii\elasticsearch\Connection | The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.
return | array | The query results. If the query results in nothing, an empty array will be returned.

Source code

                    public function all($db = null)
    {
        return parent::all($db);
    }

andFilterWhere() public method

Defined in: yii\db\QueryTrait::andFilterWhere()

Adds an additional WHERE condition to the existing one but ignores empty operands.

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

This method is similar to andWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterWhere()
- orFilterWhere()

public $this andFilterWhere ( array $condition )
$condition | array | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function andFilterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->andWhere($condition);
        }
        return $this;
    }

andWhere() public method

Defined in: yii\db\QueryTrait::andWhere()

Adds an additional WHERE condition to the existing one.

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

See also:

- where()
- orWhere()

public $this andWhere ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function andWhere($condition)
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['and', $this->where, $condition];
        }
        return $this;
    }

asArray() public method

Defined in: yii\db\ActiveQueryTrait::asArray()

Sets the asArray() property.

public $this asArray ( $value = true )
$value | boolean | Whether to return the query results in terms of arrays instead of Active Records.
return | $this | The query object itself

Source code

                    public function asArray($value = true)
    {
        $this->asArray = $value;
        return $this;
    }

attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name | string | The name of the behavior.

$behavior

string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

- a yii\base\Behavior object
- a string specifying the behavior class
- an object configuration array that will be passed to Yii::createObject() to create the behavior object.

return | yii\base\Behavior | The behavior object

Source code

                    public function attachBehavior($name, $behavior)
    {
        $this->ensureBehaviors();
        return $this->attachBehaviorInternal($name, $behavior);
    }

attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors | array | List of behaviors to be attached to the component

Source code

                    public function attachBehaviors($behaviors)
    {
        $this->ensureBehaviors();
        foreach ($behaviors as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }

batch() public method (available since version 2.0.4)

Defined in: yii\elasticsearch\Query::batch()

Starts a batch query.

A batch query supports fetching data in batches, which can keep the memory usage under a limit. This method will return a yii\elasticsearch\BatchQueryResult object which implements the Iterator interface and can be traversed to retrieve the data in batches.

For example,

    $query = (new Query)->from('user');
    foreach ($query->batch() as $rows) {
        // $rows is an array of 10 or fewer rows from user table
    }

Batch size is determined by the `limit` setting (note that in scan mode batch limit is per shard).

public yii\elasticsearch\BatchQueryResult batch ( $scrollWindow = '1m', $db = null )
$scrollWindow | string | How long Elasticsearch should keep the search context alive, in time units
$db | yii\elasticsearch\Connection | The database connection. If not set, the `elasticsearch` application component will be used.
return | yii\elasticsearch\BatchQueryResult | The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

Source code

                    public function batch($scrollWindow = '1m', $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'scrollWindow' => $scrollWindow,
            'db' => $db,
            'each' => false,
        ]);
    }

behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

    'behaviorName' => [
        'class' => 'BehaviorClass',
        'property1' => 'value1',
        'property2' => 'value2',
    ]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return | array | The behavior configurations.

Source code

                    public function behaviors()
    {
        return [];
    }

canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

- the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a readable property of the given name (when `$checkBehaviors` is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be read

Source code

                    public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canGetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

- the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a writable property of the given name (when `$checkBehaviors` is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property can be written

Source code

                    public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->canSetProperty($name, $checkVars)) {
                    return true;
                }
            }
        }
        return false;
    }

className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use `::class` instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return | string | The fully qualified name of this class.

Source code

                    public static function className()
    {
        return get_called_class();
    }

column() public method

Executes the query and returns the first column of the result.

public array column ( $field, $db = null )
$field | string | The field to query over
$db | yii\elasticsearch\Connection | The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return | array | The first column of the query result. An empty array is returned if the query results in nothing.

Source code

                    public function column($field, $db = null)
    {
        if ($field === '_id') {
            $command = $this->createCommand($db);
            $command->queryParts['_source'] = false;
            $result = $command->search();
            if ($result === false) {
                throw new Exception('Elasticsearch search query failed.');
            }
            if (empty($result['hits']['hits'])) {
                return [];
            }
            $column = [];
            foreach ($result['hits']['hits'] as $row) {
                $column[] = $row['_id'];
            }
            return $column;
        }
        return parent::column($field, $db);
    }

count() public method

Defined in: yii\elasticsearch\Query::count()

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\elasticsearch\Connection | The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
return | integer | Number of records

Source code

                    public function count($q = '*', $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        $command = $this->createCommand($db);
        // performing a query with return size of 0, is equal to getting result stats such as count
        // https://www.elastic.co/guide/en/elasticsearch/reference/5.6/breaking_50_search_changes.html#_literal_search_type_literal
        $searchOptions = ['size' => 0];
        // Set track_total_hits to 'true' for ElasticSearch version 6 and up
        // https://www.elastic.co/guide/en/elasticsearch/reference/master/search-your-data.html#track-total-hits
        if ($command->db->dslVersion >= 6) {
            $searchOptions['track_total_hits'] = 'true';
        }
        $result = $command->search($searchOptions);
        // since ES7 totals are returned as array (with count and precision values)
        if (isset($result['hits']['total'])) {
            return is_array($result['hits']['total']) ? (int)$result['hits']['total']['value'] : (int)$result['hits']['total'];
        }
        return 0;
    }

createCommand() public method

Creates a DB command that can be used to execute this query.

public yii\elasticsearch\Command createCommand ( $db = null )
$db | yii\elasticsearch\Connection | The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.
return | yii\elasticsearch\Command | The created DB command instance.

Source code

                    public function createCommand($db = null)
    {
        if ($this->primaryModel !== null) {
            // lazy loading
            if (is_array($this->via)) {
                // via relation
                /* @var $viaQuery ActiveQuery */
                list($viaName, $viaQuery) = $this->via;
                if ($viaQuery->multiple) {
                    $viaModels = $viaQuery->all();
                    $this->primaryModel->populateRelation($viaName, $viaModels);
                } else {
                    $model = $viaQuery->one();
                    $this->primaryModel->populateRelation($viaName, $model);
                    $viaModels = $model === null ? [] : [$model];
                }
                $this->filterByModels($viaModels);
            } else {
                $this->filterByModels([$this->primaryModel]);
            }
        }
        /* @var $modelClass ActiveRecord */
        $modelClass = $this->modelClass;
        if ($db === null) {
            $db = $modelClass::getDb();
        }
        if ($this->type === null) {
            $this->type = $modelClass::type();
        }
        if ($this->index === null) {
            $this->index = $modelClass::index();
            $this->type = $modelClass::type();
        }
        $commandConfig = $db->getQueryBuilder()->build($this);
        return $db->createCommand($commandConfig);
    }

createModels() protected method (available since version 2.0.11)

Defined in: yii\db\ActiveQueryTrait::createModels()

Converts found rows into model instances.

protected array|yii\db\ActiveRecord[] createModels ( $rows )
$rows | array |

Source code

                    protected function createModels($rows)
    {
        if ($this->asArray) {
            return $rows;
        } else {
            $models = [];
            /* @var $class ActiveRecord */
            $class = $this->modelClass;
            foreach ($rows as $row) {
                $model = $class::instantiate($row);
                $modelClass = get_class($model);
                $modelClass::populateRecord($model, $row);
                $models[] = $model;
            }
            return $models;
        }
    }

delete() public method

Defined in: yii\elasticsearch\Query::delete()

Executes the query and deletes all matching documents.

Everything except query and filter will be ignored.

public array delete ( $db = null, $options = [] )
$db | yii\elasticsearch\Connection | The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
$options | array | The options given with this query.
return | array | The query results.

Source code

                    public function delete($db = null, $options = [])
    {
        if ($this->emulateExecution) {
            return [];
        }
        return $this->createCommand($db)->deleteByQuery($options);
    }

detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name | string | The behavior's name.
return | yii\base\Behavior|null | The detached behavior. Null if the behavior does not exist.

Source code

                    public function detachBehavior($name)
    {
        $this->ensureBehaviors();
        if (isset($this->_behaviors[$name])) {
            $behavior = $this->_behaviors[$name];
            unset($this->_behaviors[$name]);
            $behavior->detach();
            return $behavior;
        }
        return null;
    }

detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

Source code

                    public function detachBehaviors()
    {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $name => $behavior) {
            $this->detachBehavior($name);
        }
    }

each() public method (available since version 2.0.4)

Defined in: yii\elasticsearch\Query::each()

Starts a batch query and retrieves data row by row.

This method is similar to batch() except that in each iteration of the result, only one row of data is returned. For example,

    $query = (new Query)->from('user');
    foreach ($query->each() as $row) {
    }

public yii\elasticsearch\BatchQueryResult each ( $scrollWindow = '1m', $db = null )
$scrollWindow | string | How long Elasticsearch should keep the search context alive, in time units
$db | yii\elasticsearch\Connection | The database connection. If not set, the `elasticsearch` application component will be used.
return | yii\elasticsearch\BatchQueryResult | The batch query result. It implements the Iterator interface and can be traversed to retrieve the data in batches.

Source code

                    public function each($scrollWindow = '1m', $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'scrollWindow' => $scrollWindow,
            'db' => $db,
            'each' => true,
        ]);
    }

emulateExecution() public method (available since version 2.0.11)

Defined in: yii\db\QueryTrait::emulateExecution()

Sets whether to emulate query execution, preventing any interaction with data storage.

After this mode is enabled, methods, returning query results like yii\db\QueryInterface::one(), yii\db\QueryInterface::all(), yii\db\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 $this emulateExecution ( $value = true )
$value | boolean | Whether to prevent query execution.
return | $this | The query object itself.

Source code

                    public function emulateExecution($value = true)
    {
        $this->emulateExecution = $value;
        return $this;
    }

ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

Source code

                    public function ensureBehaviors()
    {
        if ($this->_behaviors === null) {
            $this->_behaviors = [];
            foreach ($this->behaviors() as $name => $behavior) {
                $this->attachBehaviorInternal($name, $behavior);
            }
        }
    }

exists() public method

Defined in: yii\elasticsearch\Query::exists()

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

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

Source code

                    public function exists($db = null)
    {
        return self::one($db) !== false;
    }

explain() public method (available since version 2.0.5)

Defined in: yii\elasticsearch\Query::explain()

Explain for how the score of each document was computer

public $this explain ( $explain )
$explain |  |

Source code

                    public function explain($explain)
    {
        $this->explain = $explain;
        return $this;
    }

fields() public method

Defined in: yii\elasticsearch\Query::fields()

Sets the runtime fields to retrieve from the documents.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime-retrieving-fields.html.

public $this fields ( $fields )
$fields | array | The fields to be selected.
return | $this | The query object itself

Source code

                    public function fields($fields)
    {
        if (is_array($fields) || $fields === null) {
            $this->fields = $fields;
        } else {
            $this->fields = func_get_args();
        }
        return $this;
    }

filterCondition() protected method

Defined in: yii\db\QueryTrait::filterCondition()

Removes empty operands from the given query condition.

protected array filterCondition ( $condition )
$condition | array | The original condition
return | array | The condition with empty operands removed.
throws | yii\base\NotSupportedException | if the condition operator is not supported

Source code

                    protected function filterCondition($condition)
    {
        if (!is_array($condition)) {
            return $condition;
        }
        if (!isset($condition[0])) {
            // hash format: 'column1' => 'value1', 'column2' => 'value2', ...
            foreach ($condition as $name => $value) {
                if ($this->isEmpty($value)) {
                    unset($condition[$name]);
                }
            }
            return $condition;
        }
        // operator format: operator, operand 1, operand 2, ...
        $operator = array_shift($condition);
        switch (strtoupper($operator)) {
            case 'NOT':
            case 'AND':
            case 'OR':
                foreach ($condition as $i => $operand) {
                    $subCondition = $this->filterCondition($operand);
                    if ($this->isEmpty($subCondition)) {
                        unset($condition[$i]);
                    } else {
                        $condition[$i] = $subCondition;
                    }
                }
                if (empty($condition)) {
                    return [];
                }
                break;
            case 'BETWEEN':
            case 'NOT BETWEEN':
                if (array_key_exists(1, $condition) && array_key_exists(2, $condition)) {
                    if ($this->isEmpty($condition[1]) || $this->isEmpty($condition[2])) {
                        return [];
                    }
                }
                break;
            default:
                if (array_key_exists(1, $condition) && $this->isEmpty($condition[1])) {
                    return [];
                }
        }
        array_unshift($condition, $operator);
        return $condition;
    }

filterWhere() public method

Defined in: yii\db\QueryTrait::filterWhere()

Sets the WHERE part of the query but ignores empty operands.

This method is similar to where(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

The following code shows the difference between this method and where():

    // WHERE `age`=:age
    $query->filterWhere(['name' => null, 'age' => 20]);
    // WHERE `age`=:age
    $query->where(['age' => 20]);
    // WHERE `name` IS NULL AND `age`=:age
    $query->where(['name' => null, 'age' => 20]);

Note that unlike where(), you cannot pass binding parameters to this method.

See also:

- where()
- andFilterWhere()
- orFilterWhere()

public $this filterWhere ( array $condition )
$condition | array | The conditions that should be put in the WHERE part. See where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function filterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->where($condition);
        }
        return $this;
    }

findFor() public method

Defined in: yii\db\ActiveRelationTrait::findFor()

Finds the related records for the specified primary record.

This method is invoked when a relation of an ActiveRecord is being accessed lazily.

public mixed findFor ( $name, $model )
$name | string | The relation name
$model | yii\db\ActiveRecordInterface|yii\db\BaseActiveRecord | The primary model
return | mixed | The related record(s)
throws | yii\base\InvalidArgumentException | if the relation is invalid

Source code

                    public function findFor($name, $model)
    {
        if (method_exists($model, 'get' . $name)) {
            $method = new \ReflectionMethod($model, 'get' . $name);
            $realName = lcfirst(substr($method->getName(), 3));
            if ($realName !== $name) {
                throw new InvalidArgumentException('Relation names are case sensitive. ' . get_class($model) . " has a relation named \"$realName\" instead of \"$name\".");
            }
        }
        return $this->multiple ? $this->all() : $this->one();
    }

findWith() public method

Defined in: yii\db\ActiveQueryTrait::findWith()

Finds records corresponding to one or multiple relations and populates them into the primary models.

public void findWith ( $with, &$models )
$with | array | A list of relations that this query should be performed with. Please refer to with() for details about specifying this parameter.
$models | array|yii\db\ActiveRecord[] | The primary models (can be either AR instances or arrays)

Source code

                    public function findWith($with, &$models)
    {
        if (empty($models)) {
            return;
        }
        $primaryModel = reset($models);
        if (!$primaryModel instanceof ActiveRecordInterface) {
            /* @var $modelClass ActiveRecordInterface */
            $modelClass = $this->modelClass;
            $primaryModel = $modelClass::instance();
        }
        $relations = $this->normalizeRelations($primaryModel, $with);
        /* @var $relation ActiveQuery */
        foreach ($relations as $name => $relation) {
            if ($relation->asArray === null) {
                // inherit asArray from primary query
                $relation->asArray($this->asArray);
            }
            $relation->populateRelation($name, $models);
        }
    }

from() public method

Defined in: yii\elasticsearch\Query::from()

Sets the index and type to retrieve documents from.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-search.html#search-multi-index-type.

public $this from ( $index, $type = null )
$index | string|array | The index to retrieve data from. This can be a string representing a single index or a an array of multiple indexes. If this is `null` it means that all indexes are being queried.
$type | string|array | The type to retrieve data from. This can be a string representing a single type or a an array of multiple types. If this is `null` it means that all types are being queried.
return | $this | The query object itself

Source code

                    public function from($index, $type = null)
    {
        $this->index = $index;
        $this->type = $type;
        return $this;
    }

getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name | string | The behavior name
return | yii\base\Behavior|null | The behavior object, or null if the behavior does not exist

Source code

                    public function getBehavior($name)
    {
        $this->ensureBehaviors();
        return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
    }

getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return | yii\base\Behavior[] | List of behaviors attached to this component

Source code

                    public function getBehaviors()
    {
        $this->ensureBehaviors();
        return $this->_behaviors;
    }

hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name | string | The event name
return | boolean | Whether there is any handler attached to the event.

Source code

                    public function hasEventHandlers($name)
    {
        $this->ensureBehaviors();
        if (!empty($this->_events[$name])) {
            return true;
        }
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
                return true;
            }
        }
        return Event::hasHandlers($this, $name);
    }

hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

- the class has a method with the specified name
- an attached behavior has a method with the given name (when `$checkBehaviors` is true).

public boolean hasMethod ( $name, $checkBehaviors = true )
$name | string | The property name
$checkBehaviors | boolean | Whether to treat behaviors' methods as methods of this component
return | boolean | Whether the method is defined

Source code

                    public function hasMethod($name, $checkBehaviors = true)
    {
        if (method_exists($this, $name)) {
            return true;
        } elseif ($checkBehaviors) {
            $this->ensureBehaviors();
            foreach ($this->_behaviors as $behavior) {
                if ($behavior->hasMethod($name)) {
                    return true;
                }
            }
        }
        return false;
    }

hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

- the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
- the class has a member variable with the specified name (when `$checkVars` is true);
- an attached behavior has a property of the given name (when `$checkBehaviors` is true).

See also:

- canGetProperty()
- canSetProperty()

public boolean hasProperty ( $name, $checkVars = true, $checkBehaviors = true )
$name | string | The property name
$checkVars | boolean | Whether to treat member variables as properties
$checkBehaviors | boolean | Whether to treat behaviors' properties as properties of this component
return | boolean | Whether the property is defined

Source code

                    public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
    {
        return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
    }

highlight() public method

Defined in: yii\elasticsearch\Query::highlight()

Sets a highlight parameters to retrieve from the documents.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-highlighting.html.

public $this highlight ( $highlight )
$highlight | array | Array of parameters to highlight results.
return | $this | The query object itself

Source code

                    public function highlight($highlight)
    {
        $this->highlight = $highlight;
        return $this;
    }

indexBy() public method

Defined in: yii\db\QueryTrait::indexBy()

Sets the indexBy() property.

public $this indexBy ( $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:

    function ($row)
    {
        // return the index value corresponding to $row
    }

return | $this | The query object itself

Source code

                    public function indexBy($column)
    {
        $this->indexBy = $column;
        return $this;
    }

init() public method

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 ( )

Source code

                    public function init()
    {
        parent::init();
        $this->trigger(self::EVENT_INIT);
    }

inverseOf() public method

Defined in: yii\db\ActiveRelationTrait::inverseOf()

Sets the name of the relation that is the inverse of this relation.

For example, a customer has orders, which means the inverse of the "orders" relation is the "customer". If this property is set, the primary record(s) will be referenced through the specified relation. For example, `$customer->orders[0]->customer` and `$customer` will be the same object, and accessing the customer of an order will not trigger a new DB query.

Use this method when declaring a relation in the yii\db\ActiveRecord class, e.g. in Customer model:

    public function getOrders()
    {
        return $this->hasMany(Order::class, ['customer_id' => 'id'])->inverseOf('customer');
    }

This also may be used for Order model, but with caution:

    public function getCustomer()
    {
        return $this->hasOne(Customer::class, ['id' => 'customer_id'])->inverseOf('orders');
    }

in this case result will depend on how order(s) was loaded. Let's suppose customer has several orders. If only one order was loaded:

    $orders = Order::find()->where(['id' => 1])->all();
    $customerOrders = $orders[0]->customer->orders;

variable `$customerOrders` will contain only one order. If orders was loaded like this:

    $orders = Order::find()->with('customer')->where(['customer_id' => 1])->all();
    $customerOrders = $orders[0]->customer->orders;

variable `$customerOrders` will contain all orders of the customer.

public $this inverseOf ( $relationName )
$relationName | string | The name of the relation that is the inverse of this relation.
return | $this | The relation object itself.

Source code

                    public function inverseOf($relationName)
    {
        $this->inverseOf = $relationName;
        return $this;
    }

isEmpty() protected method

Defined in: yii\db\QueryTrait::isEmpty()

Returns a value indicating whether the give value is "empty".

The value is considered "empty", if one of the following conditions is satisfied:

- it is `null`,
- an empty string (`''`),
- a string containing only whitespace characters,
- or an empty array.

protected boolean isEmpty ( $value )
$value | mixed |
return | boolean | If the value is empty

Source code

                    protected function isEmpty($value)
    {
        return $value === '' || $value === [] || $value === null || is_string($value) && trim($value) === '';
    }

limit() public method

Defined in: yii\db\QueryTrait::limit()

Sets the LIMIT part of the query.

public $this limit ( $limit )
$limit | integer|yii\db\ExpressionInterface|null | The limit. Use null or negative value to disable limit.
return | $this | The query object itself

Source code

                    public function limit($limit)
    {
        $this->limit = $limit;
        return $this;
    }

minScore() public method (available since version 2.0.4)

Defined in: yii\elasticsearch\Query::minScore()

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-min-score.html.

public $this minScore ( $minScore )
$minScore | float | Exclude documents which have a `_score` less than the minimum specified minScore
return | $this | The query object itself

Source code

                    public function minScore($minScore)
    {
        $this->minScore = $minScore;
        return $this;
    }

normalizeOrderBy() protected method

Defined in: yii\db\QueryTrait::normalizeOrderBy()

Normalizes format of ORDER BY data.

protected array normalizeOrderBy ( $columns )
$columns | array|string|yii\db\ExpressionInterface|null | The columns value to normalize. See orderBy() and addOrderBy().

Source code

                    protected function normalizeOrderBy($columns)
    {
        if (empty($columns)) {
            return [];
        } elseif ($columns instanceof ExpressionInterface) {
            return [$columns];
        } elseif (is_array($columns)) {
            return $columns;
        }
        $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        $result = [];
        foreach ($columns as $column) {
            if (preg_match('/^(.*?)\s+(asc|desc)$/i', $column, $matches)) {
                $result[$matches[1]] = strcasecmp($matches[2], 'desc') ? SORT_ASC : SORT_DESC;
            } else {
                $result[$column] = SORT_ASC;
            }
        }
        return $result;
    }

off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler = null )
$name | string | Event name
$handler | callable|null | The event handler to be removed. If it is null, all handlers attached to the named event will be removed.
return | boolean | If a handler is found and detached

Source code

                    public function off($name, $handler = null)
    {
        $this->ensureBehaviors();
        if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
            return false;
        }
        if ($handler === null) {
            unset($this->_events[$name], $this->_eventWildcards[$name]);
            return true;
        }
        $removed = false;
        // plain event names
        if (isset($this->_events[$name])) {
            foreach ($this->_events[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_events[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_events[$name] = array_values($this->_events[$name]);
                return true;
            }
        }
        // wildcard event names
        if (isset($this->_eventWildcards[$name])) {
            foreach ($this->_eventWildcards[$name] as $i => $event) {
                if ($event[0] === $handler) {
                    unset($this->_eventWildcards[$name][$i]);
                    $removed = true;
                }
            }
            if ($removed) {
                $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
                // remove empty wildcards to save future redundant regex checks:
                if (empty($this->_eventWildcards[$name])) {
                    unset($this->_eventWildcards[$name]);
                }
            }
        }
        return $removed;
    }

offset() public method

Defined in: yii\db\QueryTrait::offset()

Sets the OFFSET part of the query.

public $this offset ( $offset )
$offset | integer|yii\db\ExpressionInterface|null | The offset. Use null or negative value to disable offset.
return | $this | The query object itself

Source code

                    public function offset($offset)
    {
        $this->offset = $offset;
        return $this;
    }

on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

    function ($event) { ... }         // anonymous function
    [$object, 'handleClick']          // $object->handleClick()
    ['Page', 'handleClick']           // Page::handleClick()
    'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

    function ($event)

where `$event` is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

    $component->on('event.group.*', function ($event) {
        Yii::trace($event->name . ' is triggered.');
    });

See also off().

public void on ( $name, $handler, $data = null, $append = true )
$name | string | The event name
$handler | callable | The event handler
$data | mixed | The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.
$append | boolean | Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Source code

                    public function on($name, $handler, $data = null, $append = true)
    {
        $this->ensureBehaviors();
        if (strpos($name, '*') !== false) {
            if ($append || empty($this->_eventWildcards[$name])) {
                $this->_eventWildcards[$name][] = [$handler, $data];
            } else {
                array_unshift($this->_eventWildcards[$name], [$handler, $data]);
            }
            return;
        }
        if ($append || empty($this->_events[$name])) {
            $this->_events[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_events[$name], [$handler, $data]);
        }
    }

one() public method

Executes query and returns a single row of result.

public yii\elasticsearch\ActiveRecord|array|null one ( $db = null )
$db | yii\elasticsearch\Connection | The DB connection used to create the DB command. If null, the DB connection returned by $modelClass will be used.
return | yii\elasticsearch\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.

Source code

                    public function one($db = null)
    {
        if (($result = parent::one($db)) === false) {
            return null;
        }
        if ($this->asArray) {
            // TODO implement with()
              /* @var $modelClass ActiveRecord */
              $modelClass = $this->modelClass;
              $model = $result['_source'];
              $pk = $modelClass::primaryKey()[0];
              if ($pk === '_id') {
                  $model['_id'] = $result['_id'];
              }
              $model['_score'] = $result['_score'];
              if (!empty($this->with)) {
                  $models = [$model];
                  $this->findWith($this->with, $models);
                  $model = $models[0];
              }
            return $result;
        } else {
            /* @var $class ActiveRecord */
            $class = $this->modelClass;
            $model = $class::instantiate($result);
            $class = get_class($model);
            $class::populateRecord($model, $result);
            if (!empty($this->with)) {
                $models = [$model];
                $this->findWith($this->with, $models);
                $model = $models[0];
            }
            $model->afterFind();
            return $model;
        }
    }

options() public method (available since version 2.0.4)

Defined in: yii\elasticsearch\Query::options()

Sets the options to be passed to the command created by this query.

See also yii\elasticsearch\Command::$options.

public $this options ( $options )
$options | array | The options to be set.
return | $this | The query object itself
throws | yii\base\InvalidArgumentException | if $options is not an array

Source code

                    public function options($options)
    {
        if (!is_array($options)) {
            throw new InvalidArgumentException('Array parameter expected, ' . gettype($options) . ' received.');
        }
        $this->options = $options;
        return $this;
    }

orFilterWhere() public method

Defined in: yii\db\QueryTrait::orFilterWhere()

Adds an additional WHERE condition to the existing one but ignores empty operands.

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

This method is similar to orWhere(). The main difference is that this method will remove empty query operands. As a result, this method is best suited for building query conditions based on filter values entered by users.

See also:

- filterWhere()
- andFilterWhere()

public $this orFilterWhere ( array $condition )
$condition | array | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orFilterWhere(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->orWhere($condition);
        }
        return $this;
    }

orWhere() public method

Defined in: yii\db\QueryTrait::orWhere()

Adds an additional WHERE condition to the existing one.

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

See also:

- where()
- andWhere()

public $this orWhere ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The new WHERE condition. Please refer to where() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orWhere($condition)
    {
        if ($this->where === null) {
            $this->where = $condition;
        } else {
            $this->where = ['or', $this->where, $condition];
        }
        return $this;
    }

orderBy() public method

Defined in: yii\db\QueryTrait::orderBy()

Sets the ORDER BY part of the query.

See also addOrderBy().

public $this orderBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface|null

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).

Note that if your order-by is an expression containing commas, you should always use an array to represent the order-by information. Otherwise, the method will not be able to correctly determine the order-by columns.

Since version 2.0.7, an yii\db\ExpressionInterface object can be passed to specify the ORDER BY part explicitly in plain SQL.

return | $this | The query object itself

Source code

                    public function orderBy($columns)
    {
        $this->orderBy = $this->normalizeOrderBy($columns);
        return $this;
    }

populate() public method (available since version 2.0.4)

Converts the raw query results into the format as specified by this query. This method is internally used to convert the data fetched from database into the format as required by this query.

public array populate ( $rows )
$rows | array | The raw query result from database
return | array | The converted query result

Source code

                    public function populate($rows)
    {
        if (empty($rows)) {
            return [];
        }
        $models = $this->createModels($rows);
        if (!empty($this->with)) {
            $this->findWith($this->with, $models);
        }
        if (!$this->asArray) {
            foreach ($models as $model) {
                $model->afterFind();
            }
        }
        return $models;
    }

populateRelation() public method

Defined in: yii\db\ActiveRelationTrait::populateRelation()

Finds the related records and populates them into the primary models.

public array populateRelation ( $name, &$primaryModels )
$name | string | The relation name
$primaryModels | array | Primary models
return | array | The related models
throws | yii\base\InvalidConfigException | if $link is invalid

Source code

                    public function populateRelation($name, &$primaryModels)
    {
        if (!is_array($this->link)) {
            throw new InvalidConfigException('Invalid link: it must be an array of key-value pairs.');
        }
        if ($this->via instanceof self) {
            // via junction table
            /* @var $viaQuery ActiveRelationTrait */
            $viaQuery = $this->via;
            $viaModels = $viaQuery->findJunctionRows($primaryModels);
            $this->filterByModels($viaModels);
        } elseif (is_array($this->via)) {
            // via relation
            /* @var $viaQuery ActiveRelationTrait|ActiveQueryTrait */
            list($viaName, $viaQuery) = $this->via;
            if ($viaQuery->asArray === null) {
                // inherit asArray from primary query
                $viaQuery->asArray($this->asArray);
            }
            $viaQuery->primaryModel = null;
            $viaModels = array_filter($viaQuery->populateRelation($viaName, $primaryModels));
            $this->filterByModels($viaModels);
        } else {
            $this->filterByModels($primaryModels);
        }
        if (!$this->multiple && count($primaryModels) === 1) {
            $model = $this->one();
            $primaryModel = reset($primaryModels);
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $model);
            } else {
                $primaryModels[key($primaryModels)][$name] = $model;
            }
            if ($this->inverseOf !== null) {
                $this->populateInverseRelation($primaryModels, [$model], $name, $this->inverseOf);
            }
            return [$model];
        }
        // https://github.com/yiisoft/yii2/issues/3197
        // delay indexing related models after buckets are built
        $indexBy = $this->indexBy;
        $this->indexBy = null;
        $models = $this->all();
        if (isset($viaModels, $viaQuery)) {
            $buckets = $this->buildBuckets($models, $this->link, $viaModels, $viaQuery);
        } else {
            $buckets = $this->buildBuckets($models, $this->link);
        }
        $this->indexBy = $indexBy;
        if ($this->indexBy !== null && $this->multiple) {
            $buckets = $this->indexBuckets($buckets, $this->indexBy);
        }
        $link = array_values($this->link);
        if (isset($viaQuery)) {
            $deepViaQuery = $viaQuery;
            while ($deepViaQuery->via) {
                $deepViaQuery = is_array($deepViaQuery->via) ? $deepViaQuery->via[1] : $deepViaQuery->via;
            };
            $link = array_values($deepViaQuery->link);
        }
        foreach ($primaryModels as $i => $primaryModel) {
            $keys = null;
            if ($this->multiple && count($link) === 1) {
                $primaryModelKey = reset($link);
                $keys = isset($primaryModel[$primaryModelKey]) ? $primaryModel[$primaryModelKey] : null;
            }
            if (is_array($keys)) {
                $value = [];
                foreach ($keys as $key) {
                    $key = $this->normalizeModelKey($key);
                    if (isset($buckets[$key])) {
                        if ($this->indexBy !== null) {
                            // if indexBy is set, array_merge will cause renumbering of numeric array
                            foreach ($buckets[$key] as $bucketKey => $bucketValue) {
                                $value[$bucketKey] = $bucketValue;
                            }
                        } else {
                            $value = array_merge($value, $buckets[$key]);
                        }
                    }
                }
            } else {
                $key = $this->getModelKey($primaryModel, $link);
                $value = isset($buckets[$key]) ? $buckets[$key] : ($this->multiple ? [] : null);
            }
            if ($primaryModel instanceof ActiveRecordInterface) {
                $primaryModel->populateRelation($name, $value);
            } else {
                $primaryModels[$i][$name] = $value;
            }
        }
        if ($this->inverseOf !== null) {
            $this->populateInverseRelation($primaryModels, $models, $name, $this->inverseOf);
        }
        return $models;
    }

postFilter() public method (available since version 2.0.5)

Defined in: yii\elasticsearch\Query::postFilter()

Set the `post_filter` part of the search query.

public $this postFilter ( $filter )
$filter | string|array |
return | $this | The query object itself

Source code

                    public function postFilter($filter)
    {
        $this->postFilter = $filter;
        return $this;
    }

query() public method

Defined in: yii\elasticsearch\Query::query()

Sets the query part of this search query.

public $this query ( $query )
$query | string|array |
return | $this | The query object itself

Source code

                    public function query($query)
    {
        $this->query = $query;
        return $this;
    }

runtimeMappings() public method

Defined in: yii\elasticsearch\Query::runtimeMappings()

Sets the runtime mappings for this query

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/runtime.html.

public $this runtimeMappings ( $mappings )
$mappings |  |
return | $this | The query object itself

Source code

                    public function runtimeMappings($mappings)
    {
        if (is_array($mappings) || $mappings === null) {
            $this->runtimeMappings = $mappings;
        } else {
            $this->runtimeMappings = func_get_args();
        }
        return $this;
    }

scalar() public method

Defined in: yii\elasticsearch\Query::scalar()

Returns the query result as a scalar value. The value returned will be the specified field in the first document of the query results.

public string scalar ( $field, $db = null )
$field | string | Name of the attribute to select
$db | yii\elasticsearch\Connection | The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.
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 or the field does not exist.

Source code

                    public function scalar($field, $db = null)
    {
        if ($this->emulateExecution) {
            return null;
        }
        $record = self::one($db);
        if ($record !== false) {
            if ($field === '_id') {
                return $record['_id'];
            } elseif (isset($record['_source'][$field])) {
                return $record['_source'][$field];
            } elseif (isset($record['fields'][$field])) {
                return count($record['fields'][$field]) == 1 ? reset($record['fields'][$field]) : $record['fields'][$field];
            }
        }
        return null;
    }

scriptFields() public method

Defined in: yii\elasticsearch\Query::scriptFields()

Sets the script fields to retrieve from the documents.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-script-fields.html.

public $this scriptFields ( $fields )
$fields | array | The fields to be selected.
return | $this | The query object itself

Source code

                    public function scriptFields($fields)
    {
        if (is_array($fields) || $fields === null) {
            $this->scriptFields = $fields;
        } else {
            $this->scriptFields = func_get_args();
        }
        return $this;
    }

search() public method

Executes the query and returns the complete search result including e.g.

hits, aggregations, suggesters, totalCount.

public array search ( $db = null, $options = [] )
$db | yii\elasticsearch\Connection | The database connection used to execute the query. If this parameter is not given, the `elasticsearch` application component will be used.

$options

array

The options given with this query. Possible options are:

- routing

return | array | The query results.

Source code

                    public function search($db = null, $options = [])
    {
        if ($this->emulateExecution) {
            return [
                'hits' => [
                    'total' => 0,
                    'hits' => [],
                ],
            ];
        }
        $command = $this->createCommand($db);
        $result = $command->search($options);
        if ($result === false) {
            throw new Exception('Elasticsearch search query failed.', [
                'index' => $command->index,
                'type' => $command->type,
                'query' => $command->queryParts,
                'options' => $command->options,
            ]);
        }
        // TODO implement with() for asArray
        if (!empty($result['hits']['hits']) && !$this->asArray) {
            $models = $this->createModels($result['hits']['hits']);
            if (!empty($this->with)) {
                $this->findWith($this->with, $models);
            }
            foreach ($models as $model) {
                $model->afterFind();
            }
            $result['hits']['hits'] = $models;
        }
        return $result;
    }

source() public method

Defined in: yii\elasticsearch\Query::source()

Sets the source filtering, specifying how the `_source` field of the document should be returned.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-source-filtering.html.

public $this source ( $source )
$source | array|string|null|false | The source patterns to be selected.
return | $this | The query object itself

Source code

                    public function source($source)
    {
        if (is_array($source) || $source === null  || $source === false) {
            $this->source = $source;
        } else {
            $this->source = func_get_args();
        }
        return $this;
    }

stats() public method

Defined in: yii\elasticsearch\Query::stats()

Adds a 'stats' part to the query.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search.html#stats-groups.

public $this stats ( $groups )
$groups | array | An array of groups to maintain a statistics aggregation for.
return | $this | The query object itself

Source code

                    public function stats($groups)
    {
        $this->stats = $groups;
        return $this;
    }

storedFields() public method

Defined in: yii\elasticsearch\Query::storedFields()

Sets the fields to retrieve from the documents.

Quote from the Elasticsearch doc: > The stored_fields parameter is about fields that are explicitly marked > as stored in the mapping, which is off by default and generally not > recommended. Use source filtering instead to select subsets of the > original source document to be returned.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-stored-fields.html.

public $this storedFields ( $fields )
$fields | array | The fields to be selected.
return | $this | The query object itself

Source code

                    public function storedFields($fields)
    {
        if (is_array($fields) || $fields === null) {
            $this->storedFields = $fields;
        } else {
            $this->storedFields = func_get_args();
        }
        return $this;
    }

timeout() public method

Defined in: yii\elasticsearch\Query::timeout()

Sets the search timeout.

See also https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_5.

public $this timeout ( $timeout )
$timeout | integer | A search timeout, bounding the search request to be executed within the specified time value and bail with the hits accumulated up to that point when expired. Defaults to no timeout.
return | $this | The query object itself

Source code

                    public function timeout($timeout)
    {
        $this->timeout = $timeout;
        return $this;
    }

trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event = null )
$name | string | The event name
$event | yii\base\Event|null | The event instance. If not set, a default yii\base\Event object will be created.

Source code

                    public function trigger($name, Event $event = null)
    {
        $this->ensureBehaviors();
        $eventHandlers = [];
        foreach ($this->_eventWildcards as $wildcard => $handlers) {
            if (StringHelper::matchWildcard($wildcard, $name)) {
                $eventHandlers[] = $handlers;
            }
        }
        if (!empty($this->_events[$name])) {
            $eventHandlers[] = $this->_events[$name];
        }
        if (!empty($eventHandlers)) {
            $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
            if ($event === null) {
                $event = new Event();
            }
            if ($event->sender === null) {
                $event->sender = $this;
            }
            $event->handled = false;
            $event->name = $name;
            foreach ($eventHandlers as $handler) {
                $event->data = $handler[1];
                call_user_func($handler[0], $event);
                // stop further handling if the event is handled
                if ($event->handled) {
                    return;
                }
            }
        }
        // invoke class-level attached handlers
        Event::trigger($this, $name, $event);
    }

via() public method

Defined in: yii\db\ActiveRelationTrait::via()

Specifies the relation associated with the junction table.

Use this method to specify a pivot record/table when declaring a relation in the yii\db\ActiveRecord class:

    class Order extends ActiveRecord
    {
       public function getOrderItems() {
           return $this->hasMany(OrderItem::class, ['order_id' => 'id']);
       }

       public function getItems() {
           return $this->hasMany(Item::class, ['id' => 'item_id'])
                       ->via('orderItems');
       }
    }

public $this via ( $relationName, callable $callable = null )
$relationName | string | The relation name. This refers to a relation declared in $primaryModel.
$callable | callable|null | A PHP callback for customizing the relation associated with the junction table. Its signature should be `function($query)`, where `$query` is the query to be customized.
return | $this | The relation object itself.

Source code

                    public function via($relationName, callable $callable = null)
    {
        $relation = $this->primaryModel->getRelation($relationName);
        $callableUsed = $callable !== null;
        $this->via = [$relationName, $relation, $callableUsed];
        if ($callable !== null) {
            call_user_func($callable, $relation);
        }
        return $this;
    }

where() public method

Defined in: yii\db\QueryTrait::where()

Sets the WHERE part of the query.

See yii\db\QueryInterface::where() for detailed documentation.

See also:

- andWhere()
- orWhere()

public $this where ( $condition )
$condition | string|array|yii\db\ExpressionInterface | The conditions that should be put in the WHERE part.
return | $this | The query object itself

Source code

                    public function where($condition)
    {
        $this->where = $condition;
        return $this;
    }

with() public method

Defined in: yii\db\ActiveQueryTrait::with()

Specifies the relations with which this query should be performed.

The parameters to this method can be either one or multiple strings, or a single array of relation names and the optional callbacks to customize the relations.

A relation name can refer to a relation defined in $modelClass or a sub-relation that stands for a relation of a related record. For example, `orders.address` means the `address` relation defined in the model class corresponding to the `orders` relation.

The following are some usage examples:

    // find customers together with their orders and country
    Customer::find()->with('orders', 'country')->all();
    // find customers together with their orders and the orders' shipping address
    Customer::find()->with('orders.address')->all();
    // find customers together with their country and orders of status 1
    Customer::find()->with([
        'orders' => function (\yii\db\ActiveQuery $query) {
            $query->andWhere('status = 1');
        },
        'country',
    ])->all();

You can call `with()` multiple times. Each call will add relations to the existing ones. For example, the following two statements are equivalent:

    Customer::find()->with('orders', 'country')->all();
    Customer::find()->with('orders')->with('country')->all();

public $this with ( )
return | $this | The query object itself

Source code

                    public function with()
    {
        $with = func_get_args();
        if (isset($with[0]) && is_array($with[0])) {
            // the parameter is given as an array
            $with = $with[0];
        }
        if (empty($this->with)) {
            $this->with = $with;
        } elseif (!empty($with)) {
            foreach ($with as $name => $value) {
                if (is_int($name)) {
                    // repeating relation is fine as normalizeRelations() handle it well
                    $this->with[] = $value;
                } else {
                    $this->with[$name] = $value;
                }
            }
        }
        return $this;
    }

## Event Details

Hide inherited properties

EVENT_INIT event of type yii\elasticsearch\Event

An event that is triggered when the query is initialized via init().