# Class yii\sphinx\Query

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

Query represents a SELECT SQL statement.

Query provides a set of methods to facilitate the specification of different clauses in a SELECT statement. These methods can be chained together.

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

For example,

    $query = new Query();
    $query->select('id, group_id')
        ->from('idx_item')
        ->limit(10);
    // build and execute the query
    $command = $query->createCommand();
    // $command->sql returns the actual SQL
    $rows = $command->queryAll();

Since Sphinx does not store the original indexed text, the snippets for the rows in query result should be build separately via another query. You can simplify this workflow using snippetCallback().

Warning: even if you do not set any query limit, implicit LIMIT 0,20 is present by default!

## Public Properties

Hide inherited properties

Property | Type | Description | Defined By
--- | --- | --- | ---
$behaviors | yii\base\Behavior[] | List of behaviors attached to this component. | yii\base\Component
$connection | yii\sphinx\Connection | Sphinx connection instance. | yii\sphinx\Query
$distinct | boolean | Whether to select distinct rows of data only. | yii\db\Query
$emulateExecution | boolean | Whether to emulate the actual query execution, returning empty or false results. | yii\db\QueryTrait
$facets | array | Facet search specifications. | yii\sphinx\Query
$from | array|null | The table(s) to be selected from. | yii\db\Query
$groupBy | array|null | How to group the query results. | yii\db\Query
$groupLimit | integer | Groups limit: to return (no more than) N top matches for each group. | yii\sphinx\Query
$having | string|array|yii\db\ExpressionInterface|null | The condition to be applied in the GROUP BY clause. | yii\db\Query
$indexBy | string|callable|null | The name of the column by which the query results should be indexed by. | yii\db\QueryTrait
$join | array|null | How to join with other tables. | yii\db\Query
$limit | integer|yii\db\ExpressionInterface|null | Maximum number of records to be returned. | yii\db\QueryTrait
$match | string|yii\db\Expression | Text, which should be searched in fulltext mode. | yii\sphinx\Query
$offset | integer|yii\db\ExpressionInterface|null | Zero-based offset from where the records are to be returned. | yii\db\QueryTrait
$options | array | Per-query options in format: optionName => optionValue They will compose OPTION clause. | yii\sphinx\Query
$orderBy | array|null | How to sort the query results. | yii\db\QueryTrait
$params | array|null | List of query parameter values indexed by parameter placeholders. | yii\db\Query
$queryCacheDependency | yii\caching\Dependency|null | The dependency to be associated with the cached query result for this query | yii\db\Query
$queryCacheDuration | integer|boolean|null | The default number of seconds that query results can remain valid in cache. | yii\db\Query
$select | array|null | The columns being selected. | yii\db\Query
$selectOption | string|null | Additional option that should be appended to the 'SELECT' keyword. | yii\db\Query
$showMeta | boolean|string|yii\db\Expression | Whether to automatically perform 'SHOW META' query against main one. | yii\sphinx\Query
$snippetCallback | callable | PHP callback, which should be used to fetch source data for the snippets. | yii\sphinx\Query
$snippetOptions | array | Query options for the call snippet. | yii\sphinx\Query
$tablesUsedInFrom | string[] | Table names indexed by aliases. | yii\db\Query
$union | array|null | This is used to construct the UNION clause(s) in a SQL statement. | yii\db\Query
$where | string|array|yii\db\ExpressionInterface|null | Query condition. | yii\db\QueryTrait
$withQueries | array|null | This is used to construct the WITH section in a SQL query. | yii\db\Query
$within | string | WITHIN GROUP ORDER BY clause. | yii\sphinx\Query

## 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
__toString() | Returns the SQL representation of Query | yii\db\Query
__unset() | Sets a component property to be null. | yii\base\Component
addFacets() | Adds additional FACET part of the query. | yii\sphinx\Query
addGroupBy() | Adds additional group-by columns to the existing ones. | yii\db\Query
addOptions() | Adds additional query options. | yii\sphinx\Query
addOrderBy() | Adds additional ORDER BY columns to the query. | yii\db\QueryTrait
addParams() | Adds additional parameters to be bound to the query. | yii\db\Query
addSelect() | Add more columns to the SELECT part of the query. | yii\db\Query
addWithin() | Adds additional WITHIN GROUP ORDER BY columns to the query. | yii\sphinx\Query
all() | Executes the query and returns all results as an array. | yii\db\Query
andFilterCompare() | Adds a filtering condition for a specific column and allow the user to choose a filter operator. | yii\db\Query
andFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. | yii\db\Query
andFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait
andHaving() | Adds an additional HAVING condition to the existing one. | yii\db\Query
andWhere() | Adds an additional WHERE condition to the existing one. | yii\db\QueryTrait
attachBehavior() | Attaches a behavior to this component. | yii\base\Component
attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component
average() | Returns the average of the specified column values. | yii\db\Query
batch() | Starts a batch query. | yii\db\Query
behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component
cache() | Enables query cache for this Query. | yii\db\Query
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\db\Query
count() | Returns the number of records. | yii\db\Query
create() | Creates a new Query object and copies its property values from an existing one. | yii\sphinx\Query
createCommand() | Creates a Sphinx command that can be used to execute this query. | yii\sphinx\Query
detachBehavior() | Detaches a behavior from the component. | yii\base\Component
detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component
distinct() | Sets the value indicating whether to SELECT DISTINCT or not. | yii\db\Query
each() | Starts a batch query and retrieves data row by row. | yii\db\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\db\Query
facets() | Sets FACET part of the query. | yii\sphinx\Query
filterHaving() | Sets the HAVING part of the query but ignores empty operands. | yii\db\Query
filterWhere() | Sets the WHERE part of the query but ignores empty operands. | yii\db\QueryTrait
from() | Sets the FROM part of the query. | yii\db\Query
getBehavior() | Returns the named behavior object. | yii\base\Component
getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component
getConnection() |  | yii\sphinx\Query
getTablesUsedInFrom() | Returns table names used in from() indexed by aliases. | yii\sphinx\Query
groupBy() | Sets the GROUP BY part of the query. | yii\db\Query
groupLimit() | Sets groups limit: to return (no more than) N top matches for each group. | yii\sphinx\Query
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
having() | Sets the HAVING part of the query. | yii\db\Query
indexBy() | Sets the indexBy() property. | yii\db\QueryTrait
init() | Initializes the object. | yii\base\BaseObject
innerJoin() | Appends an INNER JOIN part to the query. | yii\sphinx\Query
join() | Appends a JOIN part to the query. | yii\sphinx\Query
leftJoin() | Appends a LEFT OUTER JOIN part to the query. | yii\sphinx\Query
limit() | Sets the LIMIT part of the query. | yii\db\QueryTrait
match() | Sets the fulltext query text. This text will be composed into MATCH operator inside the WHERE clause. | yii\sphinx\Query
max() | Returns the maximum of the specified column values. | yii\db\Query
min() | Returns the minimum of the specified column values. | yii\db\Query
noCache() | Disables query cache for this Query. | yii\db\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\sphinx\Query
options() | Sets the query options. | yii\sphinx\Query
orFilterHaving() | Adds an additional HAVING condition to the existing one but ignores empty operands. | yii\db\Query
orFilterWhere() | Adds an additional WHERE condition to the existing one but ignores empty operands. | yii\db\QueryTrait
orHaving() | Adds an additional HAVING condition to the existing one. | yii\db\Query
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
params() | Sets the parameters to be bound to the query. | yii\db\Query
populate() | Converts the raw query results into the format as specified by this query. | yii\sphinx\Query
prepare() | Prepares for building SQL. | yii\db\Query
rightJoin() | Appends a RIGHT OUTER JOIN part to the query. | yii\sphinx\Query
scalar() | Returns the query result as a scalar value. | yii\db\Query
search() | Executes the query and returns the complete search result including e.g. hits, facets. | yii\sphinx\Query
select() | Sets the SELECT part of the query. | yii\db\Query
setConnection() |  | yii\sphinx\Query
showMeta() | Sets whether to automatically perform 'SHOW META' for the search query. | yii\sphinx\Query
snippetCallback() | Sets the PHP callback, which should be used to retrieve the source data for the snippets building. | yii\sphinx\Query
snippetOptions() | Sets the call snippets query options. | yii\sphinx\Query
sum() | Returns the sum of the specified column values. | yii\db\Query
trigger() | Triggers an event. | yii\base\Component
union() | Appends a SQL statement using UNION operator. | yii\db\Query
where() | Sets the WHERE part of the query. | yii\db\QueryTrait
withQuery() | Prepends a SQL statement using WITH syntax. | yii\db\Query
within() | Sets the WITHIN GROUP ORDER BY part of the query. | yii\sphinx\Query

## Protected Methods

Hide inherited methods

Method | Description | Defined By
--- | --- | ---
callSnippets() | Builds a snippets from provided source data. | yii\sphinx\Query
callSnippetsInternal() | Builds a snippets from provided source data by the given index. | yii\sphinx\Query
cleanUpTableNames() | Clean up table names and aliases Both aliases and names are enclosed into {{ and }}. | yii\db\Query
defaultConnection() |  | yii\sphinx\Query
fillUpSnippets() | Fills the query result rows with the snippets built from source determined by snippetCallback() result. | yii\sphinx\Query
filterCondition() | Removes empty operands from the given query condition. | yii\db\QueryTrait
getUnaliasedColumnsFromSelect() |  | yii\db\Query
getUniqueColumns() | Returns unique column names excluding duplicates. | yii\db\Query
isEmpty() | Returns a value indicating whether the give value is "empty". | yii\db\QueryTrait
normalizeOrderBy() | Normalizes format of ORDER BY data. | yii\db\QueryTrait
normalizeSelect() | Normalizes the SELECT columns passed to select() or addSelect(). | yii\db\Query
queryScalar() | Queries a scalar value by setting select() first. | yii\sphinx\Query
setCommandCache() | Sets $command cache, if this query has enabled caching. | yii\db\Query

## Property Details

Hide inherited properties

$connection public property

Sphinx connection instance.

public yii\sphinx\Connection $connection = null
$facets public property

Facet search specifications. For example:

    [
        'group_id',
        'brand_id' => [
            'order' => ['COUNT(*)' => SORT_ASC],
        ],
        'price' => [
            'select' => 'INTERVAL(price,200,400,600,800) AS price',
            'order' => ['FACET()' => SORT_ASC],
        ],
        'name_in_json' => [
            'select' => [new Expression('json_attr.name AS name_in_json')],
        ],
    ]

You need to use search() method in order to fetch facet results.

Note: if you specify custom select for the facet, ensure facet name has corresponding column inside it.

public array $facets = []
$groupLimit public property (available since version 2.0.6)

Groups limit: to return (no more than) N top matches for each group. This option will take effect only if groupBy() is set.

public integer $groupLimit = null
$match public property

Text, which should be searched in fulltext mode. This value will be composed into MATCH operator inside the WHERE clause. Note: this value will be processed by yii\sphinx\Connection::escapeMatchValue(), if you need to compose complex match condition use yii\db\Expression, see match() for details.

public string|yii\db\Expression $match = null
$options public property

Per-query options in format: optionName => optionValue They will compose OPTION clause. This is a Sphinx specific extension that lets you control a number of per-query options.

public array $options = null
$showMeta public property

Whether to automatically perform 'SHOW META' query against main one. You may set this value to be string or yii\db\Expression instance, in this case its value will be used as 'LIKE' condition for 'SHOW META' statement. You need to use search() method in order to fetch 'meta' results.

public boolean|string|yii\db\Expression $showMeta = null
$snippetCallback public property

PHP callback, which should be used to fetch source data for the snippets. Such callback will receive array of query result rows as an argument and must return the array of snippet source strings in the order, which match one of incoming rows. For example:

    $query = new Query();
    $query->from('idx_item')
        ->match('pencil')
        ->snippetCallback(function ($rows) {
            $result = [];
            foreach ($rows as $row) {
                $result[] = file_get_contents('/path/to/index/files/' . $row['id'] . '.txt');
            }
            return $result;
        })
        ->all();

public callable $snippetCallback = null
$snippetOptions public property

Query options for the call snippet.

public array $snippetOptions = null
$within public property

WITHIN GROUP ORDER BY clause. This is a Sphinx specific extension that lets you control how the best row within a group will to be selected. The possible value matches the orderBy() one.

public string $within = 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

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

Source code

                    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

Source code

                    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.

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

__toString() public method

Defined in: yii\db\Query::__toString()

Returns the SQL representation of Query

public string __toString ( )

Source code

                    public function __toString()
    {
        return serialize($this);
    }

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

addFacets() public method

Adds additional FACET part of the query.

public $this addFacets ( $facets )
$facets | array | Facet specifications.
return | $this | The query object itself

Source code

                    public function addFacets($facets)
    {
        if (is_array($this->facets)) {
            $this->facets = array_merge($this->facets, $facets);
        } else {
            $this->facets = $facets;
        }
        return $this;
    }

addGroupBy() public method

Defined in: yii\db\Query::addGroupBy()

Adds additional group-by columns to the existing ones.

See also groupBy().

public $this addGroupBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface

Additional columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). 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 group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

Since version 2.0.7, an yii\db\Expression object can be passed to specify the GROUP BY part explicitly in plain SQL. Since version 2.0.14, an yii\db\ExpressionInterface object can be passed as well.

return | $this | The query object itself

Source code

                    public function addGroupBy($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        if ($this->groupBy === null) {
            $this->groupBy = $columns;
        } else {
            $this->groupBy = array_merge($this->groupBy, $columns);
        }
        return $this;
    }

addOptions() public method

Adds additional query options.

See also options().

public $this addOptions ( $options )
$options | array | Query options in format: optionName => optionValue
return | $this | The query object itself

Source code

                    public function addOptions($options)
    {
        if (is_array($this->options)) {
            $this->options = array_merge($this->options, $options);
        } else {
            $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;
    }

addParams() public method

Defined in: yii\db\Query::addParams()

Adds additional parameters to be bound to the query.

See also params().

public $this addParams ( $params )
$params | array | List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`.
return | $this | The query object itself

Source code

                    public function addParams($params)
    {
        if (!empty($params)) {
            if (empty($this->params)) {
                $this->params = $params;
            } else {
                foreach ($params as $name => $value) {
                    if (is_int($name)) {
                        $this->params[] = $value;
                    } else {
                        $this->params[$name] = $value;
                    }
                }
            }
        }
        return $this;
    }

addSelect() public method

Defined in: yii\db\Query::addSelect()

Add more columns to the SELECT part of the query.

Note, that if select() has not been specified before, you should include `*` explicitly if you want to select all remaining columns too:

    $query->addSelect(["*", "CONCAT(first_name, ' ', last_name) AS full_name"])->one();

See also select().

public $this addSelect ( $columns )
$columns | string|array|yii\db\ExpressionInterface | The columns to add to the select. See select() for more details about the format of this parameter.
return | $this | The query object itself

Source code

                    public function addSelect($columns)
    {
        if ($this->select === null) {
            return $this->select($columns);
        }
        if (!is_array($this->select)) {
            $this->select = $this->normalizeSelect($this->select);
        }
        $this->select = array_merge($this->select, $this->normalizeSelect($columns));
        return $this;
    }

addWithin() public method

Adds additional WITHIN GROUP ORDER BY columns to the query.

See also within().

public $this addWithin ( $columns )
$columns | string|array | The columns (and the directions) to find best row within a group. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).
return | $this | The query object itself

Source code

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

all() public method

Defined in: yii\db\Query::all()

Executes the query and returns all results as an array.

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

Source code

                    public function all($db = null)
    {
        if ($this->emulateExecution) {
            return [];
        }
        $rows = $this->createCommand($db)->queryAll();
        return $this->populate($rows);
    }

andFilterCompare() public method (available since version 2.0.8)

Defined in: yii\db\Query::andFilterCompare()

Adds a filtering condition for a specific column and allow the user to choose a filter operator.

It adds an additional WHERE condition for the given field and determines the comparison operator based on the first few characters of the given value. The condition is added in the same way as in andFilterWhere() so empty values are ignored. The new condition and the existing one will be joined using the `AND` operator.

The comparison operator is intelligently determined based on the first few characters in the given value. In particular, it recognizes the following operators if they appear as the leading characters in the given value:

- `<`: the column must be less than the given value.
- `>`: the column must be greater than the given value.
- `<=`: the column must be less than or equal to the given value.
- `>=`: the column must be greater than or equal to the given value.
- `<>`: the column must not be the same as the given value.
- `=`: the column must be equal to the given value.
- If none of the above operators is detected, the `$defaultOperator` will be used.

public $this andFilterCompare ( $name, $value, $defaultOperator = '=' )
$name | string | The column name.
$value | string | The column value optionally prepended with the comparison operator.
$defaultOperator | string | The operator to use, when no operator is given in `$value`. Defaults to `=`, performing an exact match.
return | $this | The query object itself

Source code

                    public function andFilterCompare($name, $value, $defaultOperator = '=')
    {
        if (preg_match('/^(<>|>=|>|<=|<|=)/', (string)$value, $matches)) {
            $operator = $matches[1];
            $value = substr($value, strlen($operator));
        } else {
            $operator = $defaultOperator;
        }
        return $this->andFilterWhere([$operator, $name, $value]);
    }

andFilterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::andFilterHaving()

Adds an additional HAVING 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 andHaving(). 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:

- filterHaving()
- orFilterHaving()

public $this andFilterHaving ( array $condition )
$condition | array | The new HAVING condition. Please refer to having() on how to specify this parameter.
return | $this | The query object itself

Source code

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

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

andHaving() public method

Defined in: yii\db\Query::andHaving()

Adds an additional HAVING condition to the existing one.

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

See also:

- having()
- orHaving()

public $this andHaving ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The new HAVING condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function andHaving($condition, $params = [])
    {
        if ($this->having === null) {
            $this->having = $condition;
        } else {
            $this->having = ['and', $this->having, $condition];
        }
        $this->addParams($params);
        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;
    }

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

average() public method

Defined in: yii\db\Query::average()

Returns the average of the specified column values.

public mixed average ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The average of the specified column values.

Source code

                    public function average($q, $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("AVG($q)", $db);
    }

batch() public method

Defined in: yii\db\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\db\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 100 or fewer rows from user table
    }

public yii\db\BatchQueryResult batch ( $batchSize = 100, $db = null )
$batchSize | integer | The number of records to be fetched in each batch.
$db | yii\db\Connection|null | The database connection. If not set, the "db" application component will be used.
return | yii\db\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($batchSize = 100, $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'batchSize' => $batchSize,
            '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 [];
    }

cache() public method (available since version 2.0.14)

Defined in: yii\db\Query::cache()

Enables query cache for this Query.

public $this cache ( $duration = true, $dependency = null )
$duration | integer|true | The number of seconds that query results can remain valid in cache. Use 0 to indicate that the cached data will never expire. Use a negative number to indicate that query cache should not be used. Use boolean `true` to indicate that yii\db\Connection::$queryCacheDuration should be used. Defaults to `true`.
$dependency | yii\caching\Dependency|null | The cache dependency associated with the cached result.
return | $this | The Query object itself

Source code

                    public function cache($duration = true, $dependency = null)
    {
        $this->queryCacheDuration = $duration;
        $this->queryCacheDependency = $dependency;
        return $this;
    }

callSnippets() protected method

Builds a snippets from provided source data.

protected array callSnippets ( array $source )
$source | array | The source data to extract a snippet from.
return | array | Snippets list.
throws | yii\base\InvalidCallException | in case match() is not specified.

Source code

                    protected function callSnippets(array $source)
    {
        return $this->callSnippetsInternal($source, $this->from[0]);
    }

callSnippetsInternal() protected method

Builds a snippets from provided source data by the given index.

protected array callSnippetsInternal ( array $source, $from )
$source | array | The source data to extract a snippet from.
$from | string | Name of the source index.
return | array | Snippets list.
throws | yii\base\InvalidCallException | in case match() is not specified.

Source code

                    protected function callSnippetsInternal(array $source, $from)
    {
        $connection = $this->getConnection();
        $match = $this->match;
        if ($match === null) {
            throw new InvalidCallException('Unable to call snippets: "' . $this->className() . '::match" should be specified.');
        }
        return $connection->createCommand()
            ->callSnippets($from, $source, $match, $this->snippetOptions)
            ->queryColumn();
    }

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

cleanUpTableNames() protected method (available since version 2.0.14)

Defined in: yii\db\Query::cleanUpTableNames()

Clean up table names and aliases Both aliases and names are enclosed into {{ and }}.

protected string[] cleanUpTableNames ( $tableNames )
$tableNames | array | Non-empty array
return | string[] | Table names indexed by aliases

Source code

                    protected function cleanUpTableNames($tableNames)
    {
        $cleanedUpTableNames = [];
        foreach ($tableNames as $alias => $tableName) {
            if (is_string($tableName) && !is_string($alias)) {
                $pattern = <<<PATTERN
    '"`\[]|{{)
    '"`\]]|}})
    ?\)
    \s+
    (?:as)?
    \s*
    ?:['"`\[]|{{)
    .*?
    (?:['"`\]]|}})
    |
    .*?

    ERN;
                if (preg_match($pattern, $tableName, $matches)) {
                    if (isset($matches[2])) {
                        list(, $tableName, $alias) = $matches;
                    } else {
                        $tableName = $alias = $matches[1];
                    }
                }
            }
            if ($tableName instanceof Expression) {
                if (!is_string($alias)) {
                    throw new InvalidArgumentException('To use Expression in from() method, pass it in array format with alias.');
                }
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $tableName;
            } elseif ($tableName instanceof self) {
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $tableName;
            } else {
                $cleanedUpTableNames[$this->ensureNameQuoted($alias)] = $this->ensureNameQuoted($tableName);
            }
        }
        return $cleanedUpTableNames;
    }

column() public method

Defined in: yii\db\Query::column()

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

public array column ( $db = null )
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` 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($db = null)
    {
        if ($this->emulateExecution) {
            return [];
        }
        if ($this->indexBy === null) {
            return $this->createCommand($db)->queryColumn();
        }
        if (is_string($this->indexBy) && is_array($this->select) && count($this->select) === 1) {
            if (strpos($this->indexBy, '.') === false && count($tables = $this->getTablesUsedInFrom()) > 0) {
                $this->select[] = key($tables) . '.' . $this->indexBy;
            } else {
                $this->select[] = $this->indexBy;
            }
        }
        $rows = $this->createCommand($db)->queryAll();
        $results = [];
        $column = null;
        if (is_string($this->indexBy)) {
            if (($dotPos = strpos($this->indexBy, '.')) === false) {
                $column = $this->indexBy;
            } else {
                $column = substr($this->indexBy, $dotPos + 1);
            }
        }
        foreach ($rows as $row) {
            $value = reset($row);
            if ($this->indexBy instanceof \Closure) {
                $results[call_user_func($this->indexBy, $row)] = $value;
            } else {
                $results[$row[$column]] = $value;
            }
        }
        return $results;
    }

count() public method

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

Returns the number of records.

public integer|string|null count ( $q = '*', $db = null )
$q | string | The COUNT expression. Defaults to '*'. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given (or null), the `db` application component will be used.
return | integer|string|null | Number of records. The result may be a string depending on the underlying database engine and to support integer values higher than a 32bit PHP integer can handle.

Source code

                    public function count($q = '*', $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("COUNT($q)", $db);
    }

create() public static method

Creates a new Query object and copies its property values from an existing one.

The properties being copies are the ones to be used by query builders.

public static yii\sphinx\Query create ( $from )
$from | yii\sphinx\Query | The source query object
return | yii\sphinx\Query | The new Query object

Source code

                    public static function create($from)
    {
        return new self([
            'where' => $from->where,
            'limit' => $from->limit,
            'offset' => $from->offset,
            'orderBy' => $from->orderBy,
            'indexBy' => $from->indexBy,
            'select' => $from->select,
            'selectOption' => $from->selectOption,
            'distinct' => $from->distinct,
            'from' => $from->from,
            'groupBy' => $from->groupBy,
            'join' => $from->join,
            'having' => $from->having,
            'union' => $from->union,
            'params' => $from->params,
            // Sphinx specifics :
            'groupLimit' => $from->groupLimit,
            'options' => $from->options,
            'within' => $from->within,
            'match' => $from->match,
            'snippetCallback' => $from->snippetCallback,
            'snippetOptions' => $from->snippetOptions,
        ]);
    }

createCommand() public method

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

public yii\sphinx\Command createCommand ( $db = null )
$db | yii\sphinx\Connection | The Sphinx connection used to generate the SQL statement. If this parameter is not given, the `sphinx` application component will be used.
return | yii\sphinx\Command | The created Sphinx command instance.

Source code

                    public function createCommand($db = null)
    {
        $this->setConnection($db);
        $db = $this->getConnection();
        list ($sql, $params) = $db->getQueryBuilder()->build($this);
        return $db->createCommand($sql, $params);
    }

defaultConnection() protected method

protected yii\sphinx\Connection defaultConnection ( )
return | yii\sphinx\Connection | Default connection value.

Source code

                    protected function defaultConnection()
    {
        return Yii::$app->get('sphinx');
    }

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

distinct() public method

Defined in: yii\db\Query::distinct()

Sets the value indicating whether to SELECT DISTINCT or not.

public $this distinct ( $value = true )
$value | boolean | Whether to SELECT DISTINCT or not.
return | $this | The query object itself

Source code

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

each() public method

Defined in: yii\db\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\db\BatchQueryResult each ( $batchSize = 100, $db = null )
$batchSize | integer | The number of records to be fetched in each batch.
$db | yii\db\Connection|null | The database connection. If not set, the "db" application component will be used.
return | yii\db\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($batchSize = 100, $db = null)
    {
        return Yii::createObject([
            'class' => BatchQueryResult::className(),
            'query' => $this,
            'batchSize' => $batchSize,
            '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\db\Query::exists()

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

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

Source code

                    public function exists($db = null)
    {
        if ($this->emulateExecution) {
            return false;
        }
        $command = $this->createCommand($db);
        $params = $command->params;
        $command->setSql($command->db->getQueryBuilder()->selectExists($command->getSql()));
        $command->bindValues($params);
        return (bool) $command->queryScalar();
    }

facets() public method

Sets FACET part of the query.

public $this facets ( $facets )
$facets | array | Facet specifications.
return | $this | The query object itself

Source code

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

fillUpSnippets() protected method

Fills the query result rows with the snippets built from source determined by snippetCallback() result.

protected array|yii\sphinx\ActiveRecord[] fillUpSnippets ( $rows )
$rows | array | Raw query result rows.
return | array|yii\sphinx\ActiveRecord[] | Query result rows with filled up snippets.

Source code

                    protected function fillUpSnippets($rows)
    {
        if ($this->snippetCallback === null || empty($rows)) {
            return $rows;
        }
        $snippetSources = call_user_func($this->snippetCallback, $rows);
        $snippets = $this->callSnippets($snippetSources);
        $snippetKey = 0;
        foreach ($rows as $key => $row) {
            $rows[$key]['snippet'] = $snippets[$snippetKey];
            $snippetKey++;
        }
        return $rows;
    }

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

filterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::filterHaving()

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

This method is similar to having(). 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 having():

    // HAVING `age`=:age
    $query->filterHaving(['name' => null, 'age' => 20]);
    // HAVING `age`=:age
    $query->having(['age' => 20]);
    // HAVING `name` IS NULL AND `age`=:age
    $query->having(['name' => null, 'age' => 20]);

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

See also:

- having()
- andFilterHaving()
- orFilterHaving()

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

Source code

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

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

from() public method

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

Sets the FROM part of the query.

public $this from ( $tables )

$tables

string|array|yii\db\ExpressionInterface

The table(s) to be selected from. This can be either a string (e.g. `'user'`) or an array (e.g. `['user', 'profile']`) specifying one or several table names. Table names can contain schema prefixes (e.g. `'public.user'`) and/or table aliases (e.g. `'user u'`). The method will automatically quote the table names unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

When the tables are specified as an array, you may also use the array keys as the table aliases (if a table does not need alias, do not use a string key).

Use a Query object to represent a sub-query. In this case, the corresponding array key will be used as the alias for the sub-query.

To specify the `FROM` part in plain SQL, you may pass an instance of yii\db\ExpressionInterface.

Here are some examples:

    // SELECT * FROM  `user` `u`, `profile`;
    $query = (new \yii\db\Query)->from(['u' => 'user', 'profile']);

    // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
    $subquery = (new \yii\db\Query)->from('user')->where(['active' => true])
    $query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

    // subquery can also be a string with plain SQL wrapped in parenthesis
    // SELECT * FROM (SELECT * FROM `user` WHERE `active` = 1) `activeusers`;
    $subquery = "(SELECT * FROM `user` WHERE `active` = 1)";
    $query = (new \yii\db\Query)->from(['activeusers' => $subquery]);

return | $this | The query object itself

Source code

                    public function from($tables)
    {
        if ($tables instanceof ExpressionInterface) {
            $tables = [$tables];
        }
        if (is_string($tables)) {
            $tables = preg_split('/\s*,\s*/', trim($tables), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->from = $tables;
        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;
    }

getConnection() public method

public yii\sphinx\Connection getConnection ( )
return | yii\sphinx\Connection | Sphinx connection instance

Source code

                    public function getConnection()
    {
        if ($this->_connection === null) {
            $this->_connection = $this->defaultConnection();
        }
        return $this->_connection;
    }

getTablesUsedInFrom() public method (available since version 2.0.9)

Returns table names used in from() indexed by aliases.

Both aliases and names are enclosed into {{ and }}.

public string[] getTablesUsedInFrom ( )
return | string[] | Table names indexed by aliases
throws | yii\base\InvalidConfigException |

Source code

                    public function getTablesUsedInFrom()
    {
        // feature not supported, returning a stub:
        return [];
    }

getUnaliasedColumnsFromSelect() protected method (available since version 2.0.14)
Deprecated in 2.0.21

Defined in: yii\db\Query::getUnaliasedColumnsFromSelect()

protected array getUnaliasedColumnsFromSelect ( )
return | array | List of columns without aliases from SELECT statement.

Source code

                    protected function getUnaliasedColumnsFromSelect()
    {
        $result = [];
        if (is_array($this->select)) {
            foreach ($this->select as $name => $value) {
                if (is_int($name)) {
                    $result[] = $value;
                }
            }
        }
        return array_unique($result);
    }

getUniqueColumns() protected method (available since version 2.0.14)
Deprecated in 2.0.21

Defined in: yii\db\Query::getUniqueColumns()

Returns unique column names excluding duplicates.

Columns to be removed:

- if column definition already present in SELECT part with same alias
- if column definition without alias already present in SELECT part without alias too

protected void getUniqueColumns ( $columns )
$columns | array | The columns to be merged to the select.

Source code

                    protected function getUniqueColumns($columns)
    {
        $unaliasedColumns = $this->getUnaliasedColumnsFromSelect();
        $result = [];
        foreach ($columns as $columnAlias => $columnDefinition) {
            if (!$columnDefinition instanceof Query) {
                if (is_string($columnAlias)) {
                    $existsInSelect = isset($this->select[$columnAlias]) && $this->select[$columnAlias] === $columnDefinition;
                    if ($existsInSelect) {
                        continue;
                    }
                } elseif (is_int($columnAlias)) {
                    $existsInSelect = in_array($columnDefinition, $unaliasedColumns, true);
                    $existsInResultSet = in_array($columnDefinition, $result, true);
                    if ($existsInSelect || $existsInResultSet) {
                        continue;
                    }
                }
            }
            $result[$columnAlias] = $columnDefinition;
        }
        return $result;
    }

groupBy() public method

Defined in: yii\db\Query::groupBy()

Sets the GROUP BY part of the query.

See also addGroupBy().

public $this groupBy ( $columns )

$columns

string|array|yii\db\ExpressionInterface|null

The columns to be grouped by. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). 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 group-by is an expression containing commas, you should always use an array to represent the group-by information. Otherwise, the method will not be able to correctly determine the group-by columns.

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

return | $this | The query object itself

Source code

                    public function groupBy($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns) && !is_null($columns)) {
            $columns = preg_split('/\s*,\s*/', trim($columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $this->groupBy = $columns;
        return $this;
    }

groupLimit() public method (available since version 2.0.6)

Sets groups limit: to return (no more than) N top matches for each group.

This option will take effect only if groupBy() is set.

public $this groupLimit ( $limit )
$limit | integer | Group limit.
return | $this | The query object itself.

Source code

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

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

having() public method

Defined in: yii\db\Query::having()

Sets the HAVING part of the query.

See also:

- andHaving()
- orHaving()

public $this having ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The conditions to be put after HAVING. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function having($condition, $params = [])
    {
        $this->having = $condition;
        $this->addParams($params);
        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

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

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

Source code

                    public function init()
    {
    }

innerJoin() public method

Appends an INNER JOIN part to the query.

public $this innerJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\sphinx\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function innerJoin($table, $on = '', $params = [])
    {
        throw new NotSupportedException('"' . __METHOD__ . '" is not supported.');
    }

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

join() public method

Appends a JOIN part to the query.

The first parameter specifies what type of join it is.

public $this join ( $type, $table, $on = '', $params = [] )
$type | string | The type of join, such as INNER JOIN, LEFT JOIN.

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\sphinx\Query object representing the sub-query, and the corresponding key representing the alias.

$on

string|array

The join condition that should appear in the ON part. Please refer to where() on how to specify this parameter.

Note that the array format of where() is designed to match columns to values instead of columns to columns, so the following would not work as expected: `['post.author_id' => 'user.id']`, it would match the `post.author_id` column value against the string `'user.id'`. It is recommended to use the string syntax here which is more suited for a join:

    'post.author_id = user.id'

$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function join($type, $table, $on = '', $params = [])
    {
        throw new NotSupportedException('"' . __METHOD__ . '" is not supported.');
    }

leftJoin() public method

Appends a LEFT OUTER JOIN part to the query.

public $this leftJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\sphinx\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query
return | $this | The query object itself

Source code

                    public function leftJoin($table, $on = '', $params = [])
    {
        throw new NotSupportedException('"' . __METHOD__ . '" is not supported.');
    }

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

match() public method

Sets the fulltext query text. This text will be composed into MATCH operator inside the WHERE clause.

Note: this value will be processed by yii\sphinx\Connection::escapeMatchValue(), if you need to compose complex match condition use yii\db\Expression:

    $query = new Query();
    $query->from('my_index')
        ->match(new Expression(':match', ['match' => '@(content) ' . Yii::$app->sphinx->escapeMatchValue($matchValue)]))
        ->all();

public $this match ( $query )
$query | string|yii\db\Expression|yii\sphinx\MatchExpression | Fulltext query text.
return | $this | The query object itself.

Source code

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

max() public method

Defined in: yii\db\Query::max()

Returns the maximum of the specified column values.

public mixed max ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The maximum of the specified column values.

Source code

                    public function max($q, $db = null)
    {
        return $this->queryScalar("MAX($q)", $db);
    }

min() public method

Defined in: yii\db\Query::min()

Returns the minimum of the specified column values.

public mixed min ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The minimum of the specified column values.

Source code

                    public function min($q, $db = null)
    {
        return $this->queryScalar("MIN($q)", $db);
    }

noCache() public method (available since version 2.0.14)

Defined in: yii\db\Query::noCache()

Disables query cache for this Query.

public $this noCache ( )
return | $this | The Query object itself

Source code

                    public function noCache()
    {
        $this->queryCacheDuration = -1;
        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;
    }

normalizeSelect() protected method (available since version 2.0.21)

Defined in: yii\db\Query::normalizeSelect()

Normalizes the SELECT columns passed to select() or addSelect().

protected array normalizeSelect ( $columns )
$columns | string|array|yii\db\ExpressionInterface |

Source code

                    protected function normalizeSelect($columns)
    {
        if ($columns instanceof ExpressionInterface) {
            $columns = [$columns];
        } elseif (!is_array($columns)) {
            $columns = preg_split('/\s*,\s*/', trim((string)$columns), -1, PREG_SPLIT_NO_EMPTY);
        }
        $select = [];
        foreach ($columns as $columnAlias => $columnDefinition) {
            if (is_string($columnAlias)) {
                // Already in the normalized format, good for them
                $select[$columnAlias] = $columnDefinition;
                continue;
            }
            if (is_string($columnDefinition)) {
                if (
                    preg_match('/^(.*?)(?i:\s+as\s+|\s+)([\w\-_\.]+)$/', $columnDefinition, $matches) &&
                    !preg_match('/^\d+$/', $matches[2]) &&
                    strpos($matches[2], '.') === false
                ) {
                    // Using "columnName as alias" or "columnName alias" syntax
                    $select[$matches[2]] = $matches[1];
                    continue;
                }
                if (strpos($columnDefinition, '(') === false) {
                    // Normal column name, just alias it to itself to ensure it's not selected twice
                    $select[$columnDefinition] = $columnDefinition;
                    continue;
                }
            }
            // Either a string calling a function, DB expression, or sub-query
            $select[] = $columnDefinition;
        }
        return $select;
    }

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

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

Source code

                    public function one($db = null)
    {
        $row = parent::one($db);
        if ($row !== false) {
            list ($row) = $this->fillUpSnippets([$row]);
        }
        return $row;
    }

options() public method

Sets the query options.

See also addOptions().

public $this options ( $options )
$options | array | Query options in format: optionName => optionValue
return | $this | The query object itself

Source code

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

orFilterHaving() public method (available since version 2.0.11)

Defined in: yii\db\Query::orFilterHaving()

Adds an additional HAVING 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 orHaving(). 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:

- filterHaving()
- andFilterHaving()

public $this orFilterHaving ( array $condition )
$condition | array | The new HAVING condition. Please refer to having() on how to specify this parameter.
return | $this | The query object itself

Source code

                    public function orFilterHaving(array $condition)
    {
        $condition = $this->filterCondition($condition);
        if ($condition !== []) {
            $this->orHaving($condition);
        }
        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;
    }

orHaving() public method

Defined in: yii\db\Query::orHaving()

Adds an additional HAVING condition to the existing one.

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

See also:

- having()
- andHaving()

public $this orHaving ( $condition, $params = [] )
$condition | string|array|yii\db\ExpressionInterface | The new HAVING condition. Please refer to where() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query.
return | $this | The query object itself

Source code

                    public function orHaving($condition, $params = [])
    {
        if ($this->having === null) {
            $this->having = $condition;
        } else {
            $this->having = ['or', $this->having, $condition];
        }
        $this->addParams($params);
        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;
    }

params() public method

Defined in: yii\db\Query::params()

Sets the parameters to be bound to the query.

See also addParams().

public $this params ( $params )
$params | array | List of query parameter values indexed by parameter placeholders. For example, `[':name' => 'Dan', ':age' => 31]`.
return | $this | The query object itself

Source code

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

populate() public method

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)
    {
        return parent::populate($this->fillUpSnippets($rows));
    }

prepare() public method

Defined in: yii\db\Query::prepare()

Prepares for building SQL.

This method is called by yii\db\QueryBuilder when it starts to build SQL from a query object. You may override this method to do some final preparation work when converting a query into a SQL statement.

public $this prepare ( $builder )
$builder | yii\db\QueryBuilder |
return | $this | A prepared query instance which will be used by yii\db\QueryBuilder to build the SQL

Source code

                    public function prepare($builder)
    {
        return $this;
    }

queryScalar() protected method

Queries a scalar value by setting select() first.

Restores the value of select to make this query reusable.

protected boolean|string|null queryScalar ( $selectExpression, $db )
$selectExpression | string|yii\db\ExpressionInterface |
$db | yii\db\Connection|null | The database connection used to execute the query.
throws | Throwable | if can't create command

Source code

                    protected function queryScalar($selectExpression, $db)
    {
        if (!empty($this->emulateExecution)) {
            return null;
        }
        $select = $this->select;
        $limit = $this->limit;
        $offset = $this->offset;
        $this->select = [$selectExpression];
        $this->limit = null;
        $this->offset = null;
        $command = $this->createCommand($db);
        $this->select = $select;
        $this->limit = $limit;
        $this->offset = $offset;
        if (empty($this->groupBy) && empty($this->union) && !$this->distinct) {
            return $command->queryScalar();
        }
        return (new Query)->select([$selectExpression])
            ->from(['c' => $this])
            ->createCommand($command->db)
            ->queryScalar();
    }

rightJoin() public method

Appends a RIGHT OUTER JOIN part to the query.

public $this rightJoin ( $table, $on = '', $params = [] )

$table

string|array

The table or sub-query to be joined.

Use a string to represent the name of the table to be joined. The table name can contain a schema prefix (e.g. 'public.user') and/or table alias (e.g. 'user u'). The method will automatically quote the table name unless it contains some parenthesis (which means the table is given as a sub-query or DB expression).

You may also specify the table as an array with one element, using the array key as the table alias (e.g. ['u' => 'user']).

To join a sub-query, use an array with one element, with the value set to a yii\sphinx\Query object representing the sub-query, and the corresponding key representing the alias.

$on | string|array | The join condition that should appear in the ON part. Please refer to join() on how to specify this parameter.
$params | array | The parameters (name => value) to be bound to the query
return | $this | The query object itself

Source code

                    public function rightJoin($table, $on = '', $params = [])
    {
        throw new NotSupportedException('"' . __METHOD__ . '" is not supported.');
    }

scalar() public method

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

Returns the query result as a scalar value.

The value returned will be the first column in the first row of the query results.

public string|integer|null|false scalar ( $db = null )
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | string|integer|null|false | The value of the first column in the first row of the query result. False is returned if the query result is empty.

Source code

                    public function scalar($db = null)
    {
        if ($this->emulateExecution) {
            return null;
        }
        return $this->createCommand($db)->queryScalar();
    }

search() public method

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

public array search ( $db = null )
$db | yii\sphinx\Connection | The Sphinx connection used to generate the SQL statement.
return | array | The query results.

Source code

                    public function search($db = null)
    {
        if (!empty($this->emulateExecution)) {
            return [
                'hits' => [],
                'facets' => [],
                'meta' => [],
            ];
        }
        $command = $this->createCommand($db);
        $dataReader = $command->query();
        $rawRows = $dataReader->readAll();
        $facets = [];
        foreach ($this->facets as $facetKey => $facetValue) {
            $dataReader->nextResult();
            $rawFacetResults = $dataReader->readAll();
            if (is_numeric($facetKey)) {
                $facet = [
                    'name' => $facetValue,
                    'value' => $facetValue,
                    'count' => 'count(*)',
                ];
            } else {
                $facet = array_merge(
                    [
                        'name' => $facetKey,
                        'value' => $facetKey,
                        'count' => 'count(*)',
                    ],
                    $facetValue
                );
            }
            foreach ($rawFacetResults as $rawFacetResult) {
                $rawFacetResult['value'] = isset($rawFacetResult[strtolower($facet['value'])]) ? $rawFacetResult[strtolower($facet['value'])] : null;
                $rawFacetResult['count'] = $rawFacetResult[$facet['count']];
                $facets[$facet['name']][] = $rawFacetResult;
            }
        }
        $meta = [];
        if (!empty($this->showMeta)) {
            $dataReader->nextResult();
            $rawMetaResults = $dataReader->readAll();
            foreach ($rawMetaResults as $rawMetaResult) {
                $meta[$rawMetaResult['Variable_name']] = $rawMetaResult['Value'];
            }
        }
        // rows should be populated after all data read from cursor, avoiding possible 'unbuffered query' error
        $rows = $this->populate($rawRows);
        return [
            'hits' => $rows,
            'facets' => $facets,
            'meta' => $meta,
        ];
    }

select() public method

Defined in: yii\db\Query::select()

Sets the SELECT part of the query.

public $this select ( $columns, $option = null )

$columns

string|array|yii\db\ExpressionInterface

The columns to be selected. Columns can be specified in either a string (e.g. "id, name") or an array (e.g. ['id', 'name']). Columns can be prefixed with table names (e.g. "user.id") and/or contain column aliases (e.g. "user.id AS user_id"). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression). A DB expression may also be passed in form of an yii\db\ExpressionInterface object.

Note that if you are selecting an expression like `CONCAT(first_name, ' ', last_name)`, you should use an array to specify the columns. Otherwise, the expression may be incorrectly split into several parts.

When the columns are specified as an array, you may also use array keys as the column aliases (if a column does not need alias, do not use a string key).

Starting from version 2.0.1, you may also select sub-queries as columns by specifying each such column as a `Query` instance representing the sub-query.

$option | string|null | Additional option that should be appended to the 'SELECT' keyword. For example, in MySQL, the option 'SQL_CALC_FOUND_ROWS' can be used.
return | $this | The query object itself

Source code

                    public function select($columns, $option = null)
    {
        $this->select = $this->normalizeSelect($columns);
        $this->selectOption = $option;
        return $this;
    }

setCommandCache() protected method (available since version 2.0.14)

Defined in: yii\db\Query::setCommandCache()

Sets $command cache, if this query has enabled caching.

protected yii\db\Command setCommandCache ( $command )
$command | yii\db\Command |

Source code

                    protected function setCommandCache($command)
    {
        if ($this->queryCacheDuration !== null || $this->queryCacheDependency !== null) {
            $duration = $this->queryCacheDuration === true ? null : $this->queryCacheDuration;
            $command->cache($duration, $this->queryCacheDependency);
        }
        return $command;
    }

setConnection() public method

public $this setConnection ( $connection )
$connection | yii\sphinx\Connection | Sphinx connection instance
return | $this | The query object itself

Source code

                    public function setConnection($connection)
    {
        $this->_connection = $connection;
        return $this;
    }

showMeta() public method

Sets whether to automatically perform 'SHOW META' for the search query.

See also showMeta().

public $this showMeta ( $showMeta )
$showMeta | boolean|string|yii\db\Expression | Whether to automatically perform 'SHOW META'
return | $this | The query object itself

Source code

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

snippetCallback() public method

Sets the PHP callback, which should be used to retrieve the source data for the snippets building.

See also snippetCallback().

public $this snippetCallback ( $callback )
$callback | callable | PHP callback, which should be used to fetch source data for the snippets.
return | $this | The query object itself

Source code

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

snippetOptions() public method

Sets the call snippets query options.

See also snippetCallback().

public $this snippetOptions ( $options )
$options | array | Call snippet options in format: option_name => option_value
return | $this | The query object itself

Source code

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

sum() public method

Defined in: yii\db\Query::sum()

Returns the sum of the specified column values.

public mixed sum ( $q, $db = null )
$q | string | The column name or expression. Make sure you properly quote column names in the expression.
$db | yii\db\Connection|null | The database connection used to generate the SQL statement. If this parameter is not given, the `db` application component will be used.
return | mixed | The sum of the specified column values.

Source code

                    public function sum($q, $db = null)
    {
        if ($this->emulateExecution) {
            return 0;
        }
        return $this->queryScalar("SUM($q)", $db);
    }

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

union() public method

Defined in: yii\db\Query::union()

Appends a SQL statement using UNION operator.

public $this union ( $sql, $all = false )
$sql | string|yii\db\Query | The SQL statement to be appended using UNION
$all | boolean | TRUE if using UNION ALL and FALSE if using UNION
return | $this | The query object itself

Source code

                    public function union($sql, $all = false)
    {
        $this->union[] = ['query' => $sql, 'all' => $all];
        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;
    }

withQuery() public method (available since version 2.0.35)

Defined in: yii\db\Query::withQuery()

Prepends a SQL statement using WITH syntax.

public $this withQuery ( $query, $alias, $recursive = false )
$query | string|yii\db\Query | The SQL statement to be prepended using WITH
$alias | string | Query alias in WITH construction
$recursive | boolean | TRUE if using WITH RECURSIVE and FALSE if using WITH
return | $this | The query object itself

Source code

                    public function withQuery($query, $alias, $recursive = false)
    {
        $this->withQueries[] = ['query' => $query, 'alias' => $alias, 'recursive' => $recursive];
        return $this;
    }

within() public method

Sets the WITHIN GROUP ORDER BY part of the query.

See also addWithin().

public $this within ( $columns )
$columns | string|array | The columns (and the directions) to find best row within a group. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. `['id' => Query::SORT_ASC, 'name' => Query::SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).
return | $this | The query object itself

Source code

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