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.

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

facets() public method Sets FACET part of the query. public $this facets ( $facets )$facets array Facet specifications. return $this The query object itself

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

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.

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.

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

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

addFacets() public method Adds additional FACET part of the query. public $this addFacets ( $facets )$facets array Facet specifications. return $this The query object itself

$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