Абстрактный класс yii\sphinx\ActiveRecord

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

public string getSnippetSource ( )

attributes() public method

Возвращает список всех имён атрибутов модели.

Реализация по умолчанию вернёт все имена столбцов таблицы, связанной с этим классом AR.

public array attributes ( )
return	array	Список имён атрибутов.

callKeywords() public static method

Возвращает токенизированные и нормализованные формы ключевых слов, а также, необязательно, статистику по ключевым словам.

public static array callKeywords ( $text, $fetchStatistic = false )
$text	string	Текст, который нужно разбить на ключевые слова.
$fetchStatistic	boolean	Нужно ли вернуть статистику по документам и совпадениям.
return	array	Ключевые слова и статистика.

callSnippets() public static method

Создаёт фрагмент из предоставленных данных и запроса, используя заданные настройки индекса.

public static string|array callSnippets ( $source, $match, $options = [] )
$source	string|array	Источник данных для извлечения фрагмента. Может быть строкой или массивом строк.
$match	string	Полный текстовый запрос для создания фрагментов.
$options	array	Список параметров в формате: имя параметра => значение параметра.
return	string|array	Созданный фрагмент, если "source" — строка; список созданных фрагментов, если "source" — массив.

delete() public method

Удаляет запись индекса, соответствующую этому активному записям.

Этот метод выполняет следующие шаги по порядку:

1. вызов beforeDelete(). Если метод возвращает false, остальные шаги будут пропущены;
2. удаление записи из индекса;
3. вызов afterDelete().

На шагах 1 и 3 события с именами EVENT_BEFORE_DELETE и EVENT_AFTER_DELETE будут вызваны соответствующими методами.

public integer|false delete ( )
return	integer|false	Количество строк, удалённых из базы, или false , если удаление не выполнено по какой-то причине. Обратите внимание, что количество удалённых строк может быть 0, даже если выполнение удаления успешно.
throws	yii\db\StaleObjectException	если включена опция оптимистической блокировки и удаляемые данные устарели.
throws	Exception	в случае, если удаление не удалось.

deleteAll() public static method

Удаляет строки в индексе, используя предоставленные условия.

Например, чтобы удалить все статьи, статус которых равен 3:

Article::deleteAll('status = 3');

public static integer deleteAll ( $condition = '', $params = [] )
$condition	string|array	Условие, которое будет добавлено в часть WHERE SQL-запроса DELETE. Обратитесь к yii\sphinx\Query::where() для получения информации о том, как указать этот параметр.
$params	array	Параметры (имя => значение), которые будут привязаны к запросу.
return	integer	Количество удалённых строк.

equals() public method

Возвращает значение, указывающее, является ли заданная запись активной такой же, как текущая.

Сравнение выполняется путём сравнения имён индексов и значений первичного ключа двух записей. Если одна из записей является новой, они также считаются не равными.

public boolean equals ( $record )
$record	yii\sphinx\ActiveRecord	Запись для сравнения.
return	boolean	Являются ли две активные записи ссылками на одну и ту же строку в одном и том же индексе.

fetchSnippet() protected method

Создаёт значение фрагмента из данного запроса.

protected string fetchSnippet ( $match, $options = [] )
$match	string	Полный текстовый запрос для создания фрагментов.
$options	array	Список параметров в формате: имя параметра => значение параметра.
return	string	Значение фрагмента.

find() public static method

Создаёт экземпляр \yii\sphinx\ActiveQueryInterface для целей запроса.

Возвращаемый экземпляр \yii\sphinx\ActiveQueryInterface может быть далее настроен путём вызова методов, определённых в \yii\sphinx\ActiveQueryInterface, до вызова one() или all(), для возврата заполненных экземпляров ActiveRecord. Например,

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

Этот метод также вызывается yii\db\BaseActiveRecord::hasOne() и yii\db\BaseActiveRecord::hasMany() для создания реляционного запроса.

Можно переопределить этот метод, чтобы вернуть настроенный запрос. Например,

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

Следующий код демонстрирует, как применить условие по умолчанию ко всем запросам:

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	Созданный экземпляр yii\sphinx\ActiveQuery.

findBySql() public static method

Создаёт экземпляр yii\sphinx\ActiveQuery с заданным SQL-запросом.

Обратите внимание, что, поскольку SQL-запрос уже задан, вызов дополнительных методов изменения запроса (например, where(), order()) на созданном экземпляре yii\sphinx\ActiveQuery не повлияет. Однако, вызов with(), asArray() или indexBy() по-прежнему допустим.

Ниже пример:

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

public static yii\sphinx\ActiveQuery findBySql ( $sql, $params = [] )
$sql	string	SQL-запрос, который нужно выполнить.
$params	array	Параметры, которые нужно привязать к SQL-запросу во время выполнения.
return	yii\sphinx\ActiveQuery	Созданный экземпляр yii\sphinx\ActiveQuery

getDb() public static method

Возвращает подключение к Sphinx, используемое этим классом AR.

По умолчанию используется компонент приложения "sphinx" как подключение к Sphinx. Можно переопределить этот метод, если нужно использовать другое подключение к Sphinx.

public static yii\sphinx\Connection getDb ( )
return	yii\sphinx\Connection	Подключение к Sphinx, используемое этим классом AR.

getIndexSchema() public static method

Возвращает схему индекса Sphinx, связанную с этим классом AR.

public static yii\sphinx\IndexSchema getIndexSchema ( )
возвращает	yii\sphinx\IndexSchema	Информация о схеме индекса Sphinx, связанного с этим классом AR.
выбрасывает	yii\base\InvalidConfigException	если индекс для класса AR не существует.

getSnippet() public method

Возвращает текущее значение сниппета или генерирует новое из заданного совпадения.

public string getSnippet ( $match = null, $options = [] )
$match	string	Запрос источника сниппета
$options	array	Список опций в формате: имяОпции => значениеОпции
возвращает	string	Значение сниппета

getSnippetSource() public method

Возвращает строку, которая должна использоваться в качестве источника для создания сниппета для этого экземпляра Active Record.

Подклассы должны реализовать этот метод, чтобы вернуть фактический текст источника сниппета. Например:

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

public string getSnippetSource ( )
возвращает	string	Строка источника сниппета.
выбрасывает	yii\base\NotSupportedException	если это не поддерживается классом Active Record

indexName() public static method

Объявляет имя индекса Sphinx, связанного с этим классом AR.

По умолчанию этот метод возвращает имя класса в качестве имени индекса, вызывая yii\helpers\Inflector::camel2id(). Например, 'Article' становится 'article', а 'StockItem' становится 'stock_item'. Вы можете переопределить этот метод, если индекс не называется по этой соглашения.

public static string indexName ( )
возвращает	string	Имя индекса

insert() public method

Вставляет строку в связанный индекс Sphinx, используя значения атрибутов этой записи.

Этот метод выполняет следующие шаги в указанном порядке:

1. вызов beforeValidate(), если $runValidation имеет значение true. Если валидация завершится неудачно, остальные шаги будут пропущены;
2. вызов afterValidate(), если $runValidation имеет значение true.
3. вызов beforeSave(). Если метод возвращает false, остальные шаги будут пропущены;
4. вставка записи в индекс. Если это завершится неудачно, остальные шаги будут пропущены;
5. вызов afterSave();

На шагах 1, 2, 3 и 5 выше события EVENT_BEFORE_VALIDATE, EVENT_BEFORE_INSERT, EVENT_AFTER_INSERT и EVENT_AFTER_VALIDATE будут сгенерированы соответствующими методами.

Будут вставлены только \yii\sphinx\changedAttributes.

Например, чтобы вставить запись о статье:

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

public boolean insert ( $runValidation = true, $attributes = null )
$runValidation	boolean	Выполнять ли валидацию перед сохранением записи. Если валидация завершится неудачно, запись не будет вставлена.
$attributes	array	Список атрибутов, которые нужно сохранить. По умолчанию null, что означает, что будут сохранены все атрибуты, загруженные из индекса.
возвращает	boolean	Являются ли атрибуты валидными и успешно ли вставлена запись.
выбрасывает	Exception	в случае неудачной вставки.

isTransactional() public method

Возвращает значение, указывающее, является ли указанная операция транзакционной в текущем $scenario.

public boolean isTransactional ( $operation )
$operation	integer	Операция для проверки. Возможные значения: OP_INSERT, OP_UPDATE и OP_DELETE.
возвращает	boolean	Является ли указанная операция транзакционной в текущем $scenario.

populateRecord() public static method

Заполняет объект активной записи данными из строки базы данных/хранилища.

Это внутренний метод, предназначенный для вызова для создания объектов активной записи после извлечения данных из базы данных. Он в основном используется yii\sphinx\ActiveQuery для заполнения результатов запроса активными записями.

При ручном вызове этого метода вы должны вызвать afterFind() на созданной записи, чтобы запустить после нахождения события.

public static void populateRecord ( $record, $row )
$record	yii\db\BaseActiveRecord	Запись, которая должна быть заполнена. В большинстве случаев это будет экземпляр, созданный instantiate() предварительно.
$row	array	Значения атрибутов (имя => значение)

primaryKey() public static method

Возвращает имя первичного ключа для этого класса AR.

Реализация по умолчанию вернёт первичный ключ, как объявленный в индексе Sphinx, связанном с этим классом AR.

Обратите внимание, что должна возвращаться массив, даже для таблицы с единственным первичным ключом.

public static string[] primaryKey ( )
возвращает	string[]	Первичные ключи связанного индекса Sphinx.

setSnippet() public method

public void setSnippet ( $snippet )
$snippet	string

transactions() public method

Объявляет, какие операции должны выполняться в транзакции в разных сценариях.

Поддерживаемые операции БД: OP_INSERT, OP_UPDATE и OP_DELETE, которые соответствуют методам insert(), update() и delete() соответственно. По умолчанию, эти методы НЕ заключены в транзакцию.

В некоторых случаях, для обеспечения согласованности данных, вы можете захотеть заключить некоторые или все из них в транзакции. Вы можете сделать это, переопределив этот метод и вернув операции, которые должны быть транзакционными. Например,

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,

];

Это объявление указывает, что в сценарии "admin" операция вставки (insert()) должна выполняться в транзакции; и в сценарии "api" все операции должны выполняться в транзакции.

public array transactions ( )
возвращает	array	Объявления транзакционных операций. Ключи массива — имена сценариев, а значения — соответствующие операции транзакции.

update() public method

Сохраняет изменения в этой активной записи в связанный индекс Sphinx.

Этот метод выполняет следующие шаги в указанном порядке:

1. вызов beforeValidate(), когда $runValidation имеет значение true. Если валидация завершится неудачно, остальные шаги будут пропущены;
2. вызов afterValidate(), когда $runValidation имеет значение true.
3. вызов beforeSave(). Если метод вернёт false, остальные шаги будут пропущены;
4. сохранение записи в базе данных. Если произойдёт ошибка, остальные шаги будут пропущены;
5. вызов afterSave();

В шагах 1, 2, 3 и 5 события EVENT_BEFORE_VALIDATE, EVENT_BEFORE_UPDATE, EVENT_AFTER_UPDATE и EVENT_AFTER_VALIDATE будут сгенерированы соответствующими методами.

В базу данных будут сохранены только значения из \yii\sphinx\changedAttributes.

Например, для обновления записи статьи:

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

Обратите внимание, что обновление может не повлиять на ни одну строку в таблице. В этом случае этот метод вернёт 0. По этой причине вам следует использовать следующий код для проверки успешности выполнения update():

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

public целое число|false update ( $runValidation = true, $attributeNames = null )
$runValidation	boolean	Выполнять ли валидацию перед сохранением записи. Если валидация завершится неудачно, запись не будет добавлена в базу данных.
$attributeNames	массив	Список атрибутов, которые необходимо сохранить. По умолчанию null, что означает сохранение всех атрибутов, загруженных из базы данных.
return	целое число|false	Количество изменённых строк или false если валидация завершилась неудачно или метод beforeSave() остановил процесс обновления.
throws	yii\db\StaleObjectException	если включена оптимистическая блокировка и обновляемые данные устарели.
throws	Исключение	в случае неудачи при обновлении.

updateAll() public static method

Обновляет всю таблицу с помощью предоставленных значений атрибутов и условий.

Например, чтобы изменить статус на 1 для всех статей, у которых статус равен 2:

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

public static целое число updateAll ( $attributes, $condition = '', $params = [] )
$attributes	массив	Значения атрибутов (имя-значение) для сохранения в таблице
$condition	строка|массив	Условия, которые будут добавлены в часть WHERE запроса UPDATE. Обратитесь к yii\sphinx\Query::where() для получения информации о задании этого параметра.
$params	массив	Параметры (имя => значение) для привязки к запросу.
return	целое число	Количество обновлённых строк

updateInternal() protected method

См. также \yii\sphinx\CActiveRecord::update().

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