public string getSnippet ( $match = null, $options = [] )
public void setSnippet ( $snippet )

public string getSnippetSource ( )

attributes() public method

Returns the list of all attribute names of the model.

The default implementation will return all column names of the table associated with this AR class.

public array attributes ( )
return	array	List of attribute names.

callKeywords() public static method

Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics.

public static array callKeywords ( $text, $fetchStatistic = false )
$text	string	The text to break down to keywords.
$fetchStatistic	boolean	Whether to return document and hit occurrence statistics
return	array	Keywords and statistics

callSnippets() public static method

Builds a snippet from provided data and query, using specified index settings.

public static string|array callSnippets ( $source, $match, $options = [] )
$source	string|array	Is the source data to extract a snippet from. It could be either a single string or array of strings.
$match	string	The full-text query to build snippets for.
$options	array	List of options in format: optionName => optionValue
return	string|array	Built snippet in case "source" is a string, list of built snippets in case "source" is an array.

delete() public method

Deletes the index entry corresponding to this active record.

This method performs the following steps in order:

1. call beforeDelete(). If the method returns false, it will skip the rest of the steps;
2. delete the record from the index;
3. call afterDelete().

In the above step 1 and 3, events named EVENT_BEFORE_DELETE and EVENT_AFTER_DELETE will be raised by the corresponding methods.

public integer|false delete ( )
return	integer|false	The number of rows deleted, or false if the deletion is unsuccessful for some reason. Note that it is possible the number of rows deleted is 0, even though the deletion execution is successful.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being deleted is outdated.
throws	Exception	in case delete failed.

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.
return	integer	The number of rows deleted

equals() public method

Returns a value indicating whether the given active record is the same as the current one.

The comparison is made by comparing the index names and the primary key values of the two active records. If one of the records is new they are also considered not equal.

public boolean equals ( $record )
$record	yii\sphinx\ActiveRecord	Record to compare to
return	boolean	Whether the two active records refer to the same row in the same index.

fetchSnippet() protected method

Builds up the snippet value from the given query.

protected string fetchSnippet ( $match, $options = [] )
$match	string	The full-text query to build snippets for.
$options	array	List of options in format: optionName => optionValue
return	string	Snippet value.

find() public static method

Creates an \yii\sphinx\ActiveQueryInterface instance for query purpose.

The returned \yii\sphinx\ActiveQueryInterface instance can be further customized by calling methods defined in \yii\sphinx\ActiveQueryInterface before one() or all() is called to return populated ActiveRecord instances. For example,

// find the customer whose ID is 1
$customer = Customer::find()->where(['id' => 1])->one();

// find all active customers and order them by their age:
$customers = Customer::find()
    ->where(['status' => 1])
    ->orderBy('age')
    ->all();

This method is also called by yii\db\BaseActiveRecord::hasOne() and yii\db\BaseActiveRecord::hasMany() to create a relational query.

You may override this method to return a customized query. For example,

class Customer extends ActiveRecord
{
    public static function find()
    {
        // use CustomerQuery instead of the default ActiveQuery
        return new CustomerQuery(get_called_class());
    }
}

The following code shows how to apply a default condition for all queries:

class Customer extends ActiveRecord
{
    public static function find()
    {
        return parent::find()->where(['deleted' => false]);
    }
}

// Use andWhere()/orWhere() to apply the default condition
// SELECT FROM customer WHERE `deleted`=:deleted AND age>30
$customers = Customer::find()->andWhere('age>30')->all();

// Use where() to ignore the default condition
// SELECT FROM customer WHERE age>30
$customers = Customer::find()->where('age>30')->all();

public static yii\sphinx\ActiveQuery find ( )
return	yii\sphinx\ActiveQuery	The newly created yii\sphinx\ActiveQuery instance.

findBySql() public static method

Creates an yii\sphinx\ActiveQuery instance with a given SQL statement.

Note that because the SQL statement is already specified, calling additional query modification methods (such as where(), order()) on the created yii\sphinx\ActiveQuery instance will have no effect. However, calling with(), asArray() or indexBy() is still fine.

Below is an example:

$customers = Article::findBySql("SELECT * FROM `idx_article` WHERE MATCH('development')")->all();

public static yii\sphinx\ActiveQuery findBySql ( $sql, $params = [] )
$sql	string	The SQL statement to be executed
$params	array	Parameters to be bound to the SQL statement during execution.
return	yii\sphinx\ActiveQuery	The newly created yii\sphinx\ActiveQuery instance

getDb() public static method

Returns the Sphinx connection used by this AR class.

By default, the "sphinx" application component is used as the Sphinx connection. You may override this method if you want to use a different Sphinx connection.

public static yii\sphinx\Connection getDb ( )
return	yii\sphinx\Connection	The Sphinx connection used by this AR class.

getIndexSchema() public static method

Returns the schema information of the Sphinx index associated with this AR class.

public static yii\sphinx\IndexSchema getIndexSchema ( )
return	yii\sphinx\IndexSchema	The schema information of the Sphinx index associated with this AR class.
throws	yii\base\InvalidConfigException	if the index for the AR class does not exist.

getSnippet() public method

Returns current snippet value or generates new one from given match.

public string getSnippet ( $match = null, $options = [] )
$match	string	Snippet source query
$options	array	List of options in format: optionName => optionValue
return	string	Snippet value

getSnippetSource() public method

Returns the string, which should be used as a source to create snippet for this Active Record instance.

Child classes must implement this method to return the actual snippet source text. For example:

public function getSnippetSource()
{
    return $this->snippetSourceRelation->content;
}

public string getSnippetSource ( )
return	string	Snippet source string.
throws	yii\base\NotSupportedException	if this is not supported by the Active Record class

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

insert() public method

Inserts a row into the associated Sphinx index using the attribute values of this record.

This method performs the following steps in order:

1. call beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
2. call afterValidate() when $runValidation is true.
3. call beforeSave(). If the method returns false, it will skip the rest of the steps;
4. insert the record into index. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_BEFORE_INSERT, EVENT_AFTER_INSERT and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the \yii\sphinx\changedAttributes will be inserted.

For example, to insert an article record:

$article = new Article();
$article->id = $id;
$article->genre_id = $genreId;
$article->content = $content;
$article->insert();

public boolean insert ( $runValidation = true, $attributes = null )
$runValidation	boolean	Whether to perform validation before saving the record. If the validation fails, the record will not be inserted.
$attributes	array	List of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from index will be saved.
return	boolean	Whether the attributes are valid and the record is inserted successfully.
throws	Exception	in case insert failed.

isTransactional() public method

Returns a value indicating whether the specified operation is transactional in the current $scenario.

public boolean isTransactional ( $operation )
$operation	integer	The operation to check. Possible values are OP_INSERT, OP_UPDATE and OP_DELETE.
return	boolean	Whether the specified operation is transactional in the current $scenario.

populateRecord() public static method

Populates an active record object using a row of data from the database/storage.

This is an internal method meant to be called to create active record objects after fetching data from the database. It is mainly used by yii\sphinx\ActiveQuery to populate the query results into active records.

When calling this method manually you should call afterFind() on the created record to trigger the afterFind Event.

public static void populateRecord ( $record, $row )
$record	yii\db\BaseActiveRecord	The record to be populated. In most cases this will be an instance created by instantiate() beforehand.
$row	array	Attribute values (name => value)

primaryKey() public static method

Returns the primary key name for this AR class.

The default implementation will return the primary key as declared in the Sphinx index, which is associated with this AR class.

Note that an array should be returned even for a table with single primary key.

public static string[] primaryKey ( )
return	string[]	The primary keys of the associated Sphinx index.

setSnippet() public method

public void setSnippet ( $snippet )
$snippet	string

transactions() public method

Declares which operations should be performed within a transaction in different scenarios.

The supported DB operations are: OP_INSERT, OP_UPDATE and OP_DELETE, which correspond to the insert(), update() and delete() methods, respectively. By default, these methods are NOT enclosed in a transaction.

In some scenarios, to ensure data consistency, you may want to enclose some or all of them in transactions. You can do so by overriding this method and returning the operations that need to be transactional. For example,

return [
    'admin' => self::OP_INSERT,
    'api' => self::OP_INSERT | self::OP_UPDATE | self::OP_DELETE,
    // the above is equivalent to the following:
    // 'api' => self::OP_ALL,

];

The above declaration specifies that in the "admin" scenario, the insert operation (insert()) should be done in a transaction; and in the "api" scenario, all the operations should be done in a transaction.

public array transactions ( )
return	array	The declarations of transactional operations. The array keys are scenarios names, and the array values are the corresponding transaction operations.

update() public method

Saves the changes to this active record into the associated Sphinx index.

This method performs the following steps in order:

1. call beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
2. call afterValidate() when $runValidation is true.
3. call beforeSave(). If the method returns false, it will skip the rest of the steps;
4. save the record into index. If this fails, it will skip the rest of the steps;
5. call afterSave();

In the above step 1, 2, 3 and 5, events EVENT_BEFORE_VALIDATE, EVENT_BEFORE_UPDATE, EVENT_AFTER_UPDATE and EVENT_AFTER_VALIDATE will be raised by the corresponding methods.

Only the \yii\sphinx\changedAttributes will be saved into database.

For example, to update an article record:

$article = Article::findOne($id);
$article->genre_id = $genreId;
$article->group_id = $groupId;
$article->update();

Note that it is possible the update does not affect any row in the table. In this case, this method will return 0. For this reason, you should use the following code to check if update() is successful or not:

if ($this->update() !== false) {
    // update successful
} else {
    // update failed
}

public integer|false update ( $runValidation = true, $attributeNames = null )
$runValidation	boolean	Whether to perform validation before saving the record. If the validation fails, the record will not be inserted into the database.
$attributeNames	array	List of attributes that need to be saved. Defaults to null, meaning all attributes that are loaded from DB will be saved.
return	integer|false	The number of rows affected, or false if validation fails or beforeSave() stops the updating process.
throws	yii\db\StaleObjectException	if optimistic locking is enabled and the data being updated is outdated.
throws	Exception	in case update failed.

updateAll() public static method

Updates the whole table using the provided attribute values and conditions.

For example, to change the status to be 1 for all articles which status is 2:

Article::updateAll(['status' => 1], 'status = 2');

public static integer updateAll ( $attributes, $condition = '', $params = [] )
$attributes	array	Attribute values (name-value pairs) to be saved into the table
$condition	string|array	The conditions that will be put in the WHERE part of the UPDATE 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.
return	integer	The number of rows updated

updateInternal() protected method

See also \yii\sphinx\CActiveRecord::update().

protected void updateInternal ( $attributes = null )
$attributes
throws	yii\db\StaleObjectException