Abstract Class yii\sphinx\ActiveRecord

Inheritanceyii\sphinx\ActiveRecord » yii\db\BaseActiveRecord
Available since version2.0

ActiveRecord is the base class for classes representing relational data in terms of objects.

Warning: optimistic lock will NOT work in case of updating fields (not attributes) for the runtime indexes!

Public Methods

Hide inherited methods

MethodDescriptionDefined By
attributes() Returns the list of all attribute names of the model. yii\sphinx\ActiveRecord
callKeywords() Returns tokenized and normalized forms of the keywords, and, optionally, keyword statistics. yii\sphinx\ActiveRecord
callSnippets() Builds a snippet from provided data and query, using specified index settings. yii\sphinx\ActiveRecord
delete() Deletes the index entry corresponding to this active record. yii\sphinx\ActiveRecord
deleteAll() Deletes rows in the index using the provided conditions. yii\sphinx\ActiveRecord
equals() Returns a value indicating whether the given active record is the same as the current one. yii\sphinx\ActiveRecord
find() yii\sphinx\ActiveRecord
findBySql() Creates an yii\sphinx\ActiveQuery instance with a given SQL statement. yii\sphinx\ActiveRecord
getDb() Returns the Sphinx connection used by this AR class. yii\sphinx\ActiveRecord
getIndexSchema() Returns the schema information of the Sphinx index associated with this AR class. yii\sphinx\ActiveRecord
getSnippet() Returns current snippet value or generates new one from given match. yii\sphinx\ActiveRecord
getSnippetSource() Returns the string, which should be used as a source to create snippet for this Active Record instance. yii\sphinx\ActiveRecord
indexName() Declares the name of the Sphinx index associated with this AR class. yii\sphinx\ActiveRecord
insert() Inserts a row into the associated Sphinx index using the attribute values of this record. yii\sphinx\ActiveRecord
isTransactional() Returns a value indicating whether the specified operation is transactional in the current \yii\sphinx\scenario. yii\sphinx\ActiveRecord
populateRecord() yii\sphinx\ActiveRecord
primaryKey() Returns the primary key name for this AR class. yii\sphinx\ActiveRecord
setSnippet() yii\sphinx\ActiveRecord
transactions() Declares which operations should be performed within a transaction in different scenarios. yii\sphinx\ActiveRecord
update() Saves the changes to this active record into the associated Sphinx index. yii\sphinx\ActiveRecord
updateAll() Updates the whole table using the provided attribute values and conditions. yii\sphinx\ActiveRecord

Protected Methods

Hide inherited methods

MethodDescriptionDefined By
fetchSnippet() Builds up the snippet value from the given query. yii\sphinx\ActiveRecord
updateInternal() yii\sphinx\ActiveRecord

Constants

Hide inherited constants

ConstantValueDescriptionDefined By
OP_ALL 7 All three operations: insert, update, delete. This is a shortcut of the expression: OP_INSERT | OP_UPDATE | OP_DELETE. yii\sphinx\ActiveRecord
OP_DELETE 4 The delete operation. This is mainly used when overriding transactions() to specify which operations are transactional. yii\sphinx\ActiveRecord
OP_INSERT 1 The insert operation. This is mainly used when overriding transactions() to specify which operations are transactional. yii\sphinx\ActiveRecord
OP_UPDATE 2 The update operation. This is mainly used when overriding transactions() to specify which operations are transactional. yii\sphinx\ActiveRecord

Method Details

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 \yii\sphinx\beforeDelete(). If the method returns false, it will skip the rest of the steps;
  2. delete the record from the index;
  3. call \yii\sphinx\afterDelete().

In the above step 1 and 3, events named \yii\sphinx\EVENT_BEFORE_DELETE and \yii\sphinx\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 \yii\sphinx\optimisticLock 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 \yii\sphinx\isNewRecord 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

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 \yii\sphinx\beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
  2. call \yii\sphinx\afterValidate() when $runValidation is true.
  3. call \yii\sphinx\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 \yii\sphinx\afterSave();

In the above step 1, 2, 3 and 5, events \yii\sphinx\EVENT_BEFORE_VALIDATE, \yii\sphinx\EVENT_BEFORE_INSERT, \yii\sphinx\EVENT_AFTER_INSERT and \yii\sphinx\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 \yii\sphinx\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 \yii\sphinx\scenario.

populateRecord() public static method

public static void populateRecord ( $record, $row )
$record
$row
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 \yii\sphinx\beforeValidate() when $runValidation is true. If validation fails, it will skip the rest of the steps;
  2. call \yii\sphinx\afterValidate() when $runValidation is true.
  3. call \yii\sphinx\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 \yii\sphinx\afterSave();

In the above step 1, 2, 3 and 5, events \yii\sphinx\EVENT_BEFORE_VALIDATE, \yii\sphinx\EVENT_BEFORE_UPDATE, \yii\sphinx\EVENT_AFTER_UPDATE and \yii\sphinx\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 \yii\sphinx\beforeSave() stops the updating process.

throws \yii\db\StaleObjectException

if \yii\sphinx\optimisticLock 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