Class yii\sphinx\ActiveQuery

ActiveQuery represents a Sphinx query associated with an Active Record class.

An ActiveQuery can be a normal query or be used in a relational context.

ActiveQuery instances are usually created by yii\sphinx\ActiveRecord::find() and yii\sphinx\ActiveRecord::findBySql(). Relational queries are created by yii\sphinx\ActiveRecord::hasOne() and yii\sphinx\ActiveRecord::hasMany().

Normal Query

Because ActiveQuery extends from yii\sphinx\Query, one can use query methods, such as \yii\sphinx\where(), \yii\sphinx\orderBy() to customize the query options.

ActiveQuery also provides the following additional query options:

• \yii\sphinx\with(): list of relations that this query should be performed with.
• \yii\sphinx\indexBy(): the name of the column by which the query result should be indexed.
• \yii\sphinx\asArray(): whether to return each record as an array.

These options can be configured using methods of the same name. For example:

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

ActiveQuery allows to build the snippets using sources provided by ActiveRecord. You can use snippetByModel() method to enable this. For example:

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

Relational query

In relational context ActiveQuery represents a relation between two Active Record classes.

Relational ActiveQuery instances are usually created by calling yii\sphinx\ActiveRecord::hasOne() and yii\sphinx\ActiveRecord::hasMany(). An Active Record class declares a relation by defining a getter method which calls one of the above methods and returns the created ActiveQuery object.

A relation is specified by \yii\sphinx\link which represents the association between columns of different tables; and the multiplicity of the relation is indicated by \yii\sphinx\multiple.

If a relation involves a junction table, it may be specified by \yii\sphinx\via(). This methods may only be called in a relational context. Same is true for \yii\sphinx\inverseOf(), which marks a relation as inverse of another relation.