Класс yii\sphinx\ActiveQuery

ActiveQuery представляет запрос Sphinx, связанный с классом Active Record.

ActiveQuery может быть обычным запросом или использоваться в реляционном контексте.

Экземпляры ActiveQuery обычно создаются методами yii\sphinx\ActiveRecord::find() и yii\sphinx\ActiveRecord::findBySql(). Реляционные запросы создаются методами yii\sphinx\ActiveRecord::hasOne() и yii\sphinx\ActiveRecord::hasMany().

Обычный запрос

Поскольку ActiveQuery расширяет yii\sphinx\Query, можно использовать методы запроса, такие как where(), orderBy(), для настройки параметров запроса.

ActiveQuery также предоставляет следующие дополнительные параметры запроса:

• with(): список отношений, с которыми должен выполняться этот запрос.
• indexBy(): имя столбца, по которому должны индексироваться результаты запроса.
• asArray(): следует ли возвращать каждую запись в виде массива.

Эти параметры могут быть настроены с помощью методов с таким же именем. Например:

$articles = Article::find()->with('source')->asArray()->all();

ActiveQuery позволяет создавать фрагменты кода, используя данные, предоставленные ActiveRecord. Для этого можно использовать метод snippetByModel(). Например:

class Article extends ActiveRecord
{
    public function getSource()
    {
        return $this->hasOne('db', ArticleDb::className(), ['id' => 'id']);
    }

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

    ...
}

$articles = Article::find()->with('source')->snippetByModel()->all();

Реляционный запрос

В реляционном контексте ActiveQuery представляет отношение между двумя классами Active Record.

Реляционные экземпляры ActiveQuery обычно создаются вызовом yii\sphinx\ActiveRecord::hasOne() и yii\sphinx\ActiveRecord::hasMany(). Класс Active Record объявляет отношение, определяя метод-геттер, который вызывает один из вышеперечисленных методов и возвращает созданный объект ActiveQuery.

Отношение задаётся свойством $link, которое представляет ассоциацию между столбцами различных таблиц; кратность отношения указывается свойством $multiple.

Если отношение включает промежуточную таблицу, оно может быть задано методом via(). Этот метод может быть вызван только в реляционном контексте. То же самое относится к методу inverseOf(), который помечает отношение как обратное к другому.

Общедоступные свойства

Публичные методы

Защищённые методы

События

Подробное описание свойств

$sql общедоступное свойство

SQL-запрос для получения записей AR. Он устанавливается методом yii\sphinx\ActiveRecord::findBySql().

public string $sql = null

Подробное описание методов

class Article extends ActiveRecord
{
    public function getSnippetSource()
    {
        return file_get_contents('/path/to/source/files/' . $this->id . '.txt');;
    }
}

$articles = Article::find()->snippetByModel()->all();

Подробности событий