$collectionEnvelope public property The name of the envelope (e.g. items) for returning the resource objects in a collection. This is used when serving a resource collection. When this is set and pagination is enabled, the serializer will return a collection in the following format: [ 'items' => [...], // assuming collectionEnvelope is "items" '_links' => { // pagination links as returned by Pagination::getLinks() 'self' => '...', 'next' => '...',

exists() public method Checks whether a specified key exists in the cache. This can be faster than getting the value from the cache if the data is big. Note that this method does not check whether the dependency associated with the cached data, if there is any, has changed. So a call to get() may return false while exists returns true. public boolean exists ( $key )$key mixed A key identifying the cached value. This can be a simple string or a complex data structure consisting of factors

deleteAll() public static method Deletes rows in the index using the provided conditions. For example, to delete all articles whose status is 3: Article::deleteAll('status = 3'); public static integer deleteAll ( $condition = '', $params = [] )$condition string|array The conditions that will be put in the WHERE part of the DELETE SQL. Please refer to yii\sphinx\Query::where() on how to specify this parameter. $params array The parameters (name => value) to be bound to the query.

$pattern public property The pattern used to parse and create the path info part of a URL. See also: $host $placeholders public string $pattern = null

indexName() public static method Declares the name of the Sphinx index associated with this AR class. By default this method returns the class name as the index name by calling yii\helpers\Inflector::camel2id(). For example, 'Article' becomes 'article', and 'StockItem' becomes 'stock_item'. You may override this method if the index is not named after this convention. public static string indexName ( )return string The index name

dropForeignKey() public method Creates a SQL command for dropping a foreign key constraint. public $this dropForeignKey ( $name, $table )$name string The name of the foreign key constraint to be dropped. The name will be properly quoted by the method. $table string The table whose foreign is to be dropped. The name will be properly quoted by the method. return $this The command object itself

alterColumn() public method Creates a SQL command for changing the definition of a column. public $this alterColumn ( $table, $column, $type )$table string The table whose column is to be changed. The table name will be properly quoted by the method. $column string The name of the column to be changed. The name will be properly quoted by the method. $type string The column type. yii\db\QueryBuilder::getColumnType() will be called to convert the give column type to the physical one. F

dropPrimaryKey() public method Creates a SQL command for removing a primary key constraint to an existing table. public $this dropPrimaryKey ( $name, $table )$name string The name of the primary key constraint to be removed. $table string The table that the primary key constraint will be removed from. return $this The command object itself

params() public method Sets the parameters to be parsed into the query. See also addParams(). public $this params ( $params )$params array List of expression parameter values indexed by parameter placeholders. For example, [':name' => 'Dan', ':age' => 31]. return $this The expression object itself

addOrderBy() public method Adds additional ORDER BY columns to the query. See also orderBy(). public $this addOrderBy ( $columns )$columns string|array|yii\db\Expression 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