Class yii\elasticsearch\Query

Inheritanceyii\elasticsearch\Query » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\db\QueryInterface
Uses Traitsyii\db\QueryTrait
Subclassesyii\elasticsearch\ActiveQuery
Available since version2.0
Source Code https://github.com/yiisoft/yii2-elasticsearch/blob/master/Query.php

Query represents a query to the search API of Elasticsearch.

Query provides a set of methods to facilitate the specification of different parameters of the query. These methods can be chained together.

By calling createCommand(), we can get a yii\elasticsearch\Command instance which can be further used to perform/execute the DB query against a database.

For example,

$query = new Query;
$query->storedFields('id, name')
    ->from('myindex', 'users')
    ->limit(10);
// build and execute the query
$command = $query->createCommand();
$rows = $command->search(); // this way you get the raw output of Elasticsearch.

You would normally call $query->search() instead of creating a command as this method adds the indexBy() feature and also removes some inconsistencies from the response.

Query also provides some methods to easier get some parts of the result only:

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

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.

Public Properties

Hide inherited properties

Property Type Description Defined By
$aggregations array List of aggregations to add to this query. yii\elasticsearch\Query
$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
$limit integer|yii\db\ExpressionInterface|null Maximum number of records to be returned. yii\db\QueryTrait
$minScore float Exclude documents which have a _score less than the minimum specified in min_score yii\elasticsearch\Query
$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
$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
$where string|array|yii\db\ExpressionInterface|null Query condition. yii\db\QueryTrait

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() Constructor. yii\base\BaseObject
__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 the query and returns all results as an array. yii\elasticsearch\Query
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\elasticsearch\Query
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\Query
count() Returns the number of records. yii\elasticsearch\Query
createCommand() Creates a DB command that can be used to execute this query. yii\elasticsearch\Query
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
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\Query
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 the query and returns a single row of result. yii\elasticsearch\Query
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\elasticsearch\Query
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\Query
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\Query
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
where() Sets the WHERE part of the query. yii\db\QueryTrait

Protected Methods

Hide inherited methods

Method Description Defined By
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

Property Details

Hide inherited properties

$aggregations public property
public array $aggregations = []
$collapse public property (available since version 2.1.0)
public array $collapse = []
$explain public property (available since version 2.0.5)

Enables explanation for each hit on how its score was computed.

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

public boolean $explain null
$fields public property

Use the fields parameter to retrieve the values of runtime fields. Runtime fields won’t display in _source, but the fields API works for all fields, even those that were not sent as part of the original _source.

See also:

public array $fields null
$filter public property

The filter part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.

public array|string $filter null
$highlight public property

The highlight part of this search query. This is an array that allows to highlight search results on one or more fields.

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

public array $highlight null
$index public property

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 not set, indexes are being queried.

See also from().

public string|array $index null
$minScore public property (available since version 2.0.4)

Exclude documents which have a _score less than the minimum specified in min_score

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

public float $minScore null
$options public property (available since version 2.0.4)

List of options that will passed to commands created by this query.

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

public array $options = []
$postFilter public property (available since version 2.0.5)

The post_filter part of the search query for differentially filter search results and aggregations.

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

public string|array $postFilter null
$query public property

The query part of this search query. This is an array or json string that follows the format of the elasticsearch Query DSL.

public array|string $query null
$runtimeMappings public property

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
    ],
],

] `

See also:

public array $runtimeMappings null
$scriptFields public property

The scripted fields being retrieved from the documents. Example: `php $query->scriptFields = [

'value_times_two' => [
    'script' => "doc['my_field_name'].value * 2",
],
'value_times_factor' => [
    'script' => "doc['my_field_name'].value * factor",
    'params' => [
        'factor' => 2.0
    ],
],

] `

Note: Field values are always returned as arrays even if they only have one value.

See also:

public array $scriptFields null
$source public property

This option controls how the _source field is returned from the documents. For example, ['id', 'name'] means that only the id and name field should be returned from _source. If not set, it means retrieving the full _source field unless fields() are specified. Setting this option to false will disable return of the _source field, this means that only the primaryKey of a record will be available in the result.

See also:

public array $source null
$stats public property

The 'stats' part of the query. An array of groups to maintain a statistics aggregation for.

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

public array $stats = []
$storedFields public property

The fields being retrieved from the documents. For example, ['id', 'name']. If not set, this option will not be applied to the query and no fields will be returned. In this case the _source field will be returned by default which can be configured using source(). Setting this to an empty array will result in no fields being retrieved, which means that only the primaryKey of a record will be available in the result. > Note: Field values are always returned as arrays even if they only > have one value.

See also:

public array $storedFields null
$suggest public property
public array $suggest = []
$timeout public property

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.

See also:

public integer $timeout null
$type public property

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 not set, all types are being queried.

See also from().

public string|array $type null

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

                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\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method

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

Constructor.

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call init().

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
public void __construct ( $config = [] )
$config array

Name-value pairs that will be used to initialize the object properties

                public function __construct($config = [])
{
    if (!empty($config)) {
        Yii::configure($this, $config);
    }
    $this->init();
}

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

                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

                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.

                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.

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

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

            
addAggregate() public method

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

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

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

            
addCollapse() public method (available since version 2.1.0)
public $this addCollapse ( $collapse )
$collapse array

The configuration options for collapse.

return $this

The query object itself

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

            
addOptions() public method (available since version 2.0.4)

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

                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

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

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

            
all() public method

Executes the query and returns all results as an array.

public array all ( $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 array

The query results. If the query results in nothing, an empty array will be returned.

                public function all($db = null)
{
    if ($this->emulateExecution) {
        return [];
    }
    $result = $this->createCommand($db)->search();
    if ($result === false) {
        throw new Exception('Elasticsearch search query failed.');
    }
    if (empty($result['hits']['hits'])) {
        return [];
    }
    $rows = $result['hits']['hits'];
    return $this->populate($rows);
}

            
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:

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

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

            
andWhere() public method

Adds an additional WHERE condition to the existing one.

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

public $this andWhere ( $condition )
$condition array

The new WHERE condition. Please refer to where() on how to specify this parameter.

return $this

The query object itself

                public function andWhere($condition)
{
    if ($this->where === null) {
        $this->where = $condition;
    } else if (isset($this->where[0]) && $this->where[0] === 'and') {
        $this->where[] = $condition;
    } else {
        $this->where = ['and', $this->where, $condition];
    }
    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:

return yii\base\Behavior

The behavior object

                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

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

            
batch() public method (available since version 2.0.4)

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.

                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.

                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

                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

                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.

                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.

                public function column($field, $db = null)
{
    if ($this->emulateExecution) {
        return [];
    }
    $command = $this->createCommand($db);
    $command->queryParts['_source'] = [$field];
    $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) {
        if (isset($row['fields'][$field])) {
            $column[] = $row['fields'][$field];
        } elseif (isset($row['_source'][$field])) {
            $column[] = $row['_source'][$field];
        } else {
            $column[] = null;
        }
    }
    return $column;
}

            
count() public method

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

                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 database connection used to execute the query. If this parameter is not given, the elasticsearch application component will be used.

return yii\elasticsearch\Command

The created DB command instance.

                public function createCommand($db = null)
{
    if ($db === null) {
        $db = Yii::$app->get('elasticsearch');
    }
    $commandConfig = $db->getQueryBuilder()->build($this);
    return $db->createCommand($commandConfig);
}

            
delete() public method

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.

                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.

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

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

            
each() public method (available since version 2.0.4)

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.

                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.

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

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

            
exists() public method

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.

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

            
explain() public method (available since version 2.0.5)

Explain for how the score of each document was computer

public $this explain ( $explain )
$explain

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

            
fields() public method

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

                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

                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:

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

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

            
from() public method
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

                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

                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

                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.

                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

                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:

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

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

            
highlight() public method

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

                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

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

            
init() public method

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

public void init ( )

                public function init()
{
    parent::init();
    // setting the default limit according to Elasticsearch defaults
    // https://www.elastic.co/guide/en/elasticsearch/reference/current/search-request-body.html#_parameters_5
    if ($this->limit === null) {
        $this->limit = 10;
    }
}

            
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

                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

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

            
minScore() public method (available since version 2.0.4)
public $this minScore ( $minScore )
$minScore float

Exclude documents which have a _score less than the minimum specified minScore

return $this

The query object itself

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

                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

                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

                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.

                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 the query and returns a single row of result.

public array|boolean one ( $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 array|boolean

The first row (in terms of an array) of the query result. False is returned if the query results in nothing.

                public function one($db = null)
{
    if ($this->emulateExecution) {
        return false;
    }
    $result = $this->createCommand($db)->search(['size' => 1]);
    if ($result === false) {
        throw new Exception('Elasticsearch search query failed.');
    }
    if (empty($result['hits']['hits'])) {
        return false;
    }
    $record = reset($result['hits']['hits']);
    return $record;
}

            
options() public method (available since version 2.0.4)

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

                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:

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

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

            
orWhere() public method

Adds an additional WHERE condition to the existing one.

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

public $this orWhere ( $condition )
$condition array

The new WHERE condition. Please refer to where() on how to specify this parameter.

return $this

The query object itself

                public function orWhere($condition)
{
    if ($this->where === null) {
        $this->where = $condition;
    } else if (isset($this->where[0]) && $this->where[0] === 'or') {
        $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

                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

                public function populate($rows)
{
    if ($this->indexBy === null) {
        return $rows;
    }
    $models = [];
    foreach ($rows as $key => $row) {
        if ($this->indexBy !== null) {
            if (is_string($this->indexBy)) {
                $key = isset($row['fields'][$this->indexBy]) ?
                    reset($row['fields'][$this->indexBy]) : $row['_source'][$this->indexBy];
            } else {
                $key = call_user_func($this->indexBy, $row);
            }
        }
        $models[$key] = $row;
    }
    return $models;
}

            
postFilter() public method (available since version 2.0.5)

Set the post_filter part of the search query.

public $this postFilter ( $filter )
$filter string|array
return $this

The query object itself

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

            
query() public method

Sets the query part of this search query.

public $this query ( $query )
$query string|array
return $this

The query object itself

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

            
runtimeMappings() public method

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

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

            
scalar() public method

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.

                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

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

                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:

return array

The query results.

                public function search($db = null, $options = [])
{
    if ($this->emulateExecution) {
        return [
            'hits' => [
                'total' => 0,
                'hits' => [],
            ],
        ];
    }
    $result = $this->createCommand($db)->search($options);
    if ($result === false) {
        throw new Exception('Elasticsearch search query failed.');
    }
    if (!empty($result['hits']['hits']) && $this->indexBy !== null) {
        $rows = [];
        foreach ($result['hits']['hits'] as $key => $row) {
            if (is_string($this->indexBy)) {
                $key = isset($row['fields'][$this->indexBy]) ?
                    $row['fields'][$this->indexBy] : $row['_source'][$this->indexBy];
            } else {
                $key = call_user_func($this->indexBy, $row);
            }
            $rows[$key] = $row;
        }
        $result['hits']['hits'] = $rows;
    }
    return $result;
}

            
source() public method

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

                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
public $this stats ( $groups )
$groups array

An array of groups to maintain a statistics aggregation for.

return $this

The query object itself

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

            
storedFields() public method

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

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

            
timeout() public method
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

                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.

                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);
}

            
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:

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

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