yiisoft/yii2-sphinx API Documentation 2.0

This is the API Documentation for the yiisoft/yii2-sphinx extension. Here you will find detailed information about all classes provided by this extension. Below you find a list of the existing classes, interfaces, and traits, ordered by their fully qualified name (including the namespace). Each of them has a dedicated page which contains a description about the purpose of the class, a list of the available methods, properties and constants, and detailed description on how to use each of them.

On this page you find all the classes included in version 2.0 of the extension. You can use the dropdown menu on the top right to switch between versions.

Class Description
yii\sphinx\ActiveDataProvider ActiveDataProvider is an enhanced version of \yii\data\ActiveDataProvider specific to the Sphinx.
yii\sphinx\ActiveFixture ActiveFixture represents a fixture backed up by a modelClass or a Sphinx index.
yii\sphinx\ActiveQuery ActiveQuery represents a Sphinx query associated with an Active Record class.
yii\sphinx\ActiveRecord ActiveRecord is the base class for classes representing relational data in terms of objects.
yii\sphinx\ColumnSchema ColumnSchema class describes the metadata of a column in a Sphinx index.
yii\sphinx\Command Command represents a SQL statement to be executed against a Sphinx.
yii\sphinx\Connection Connection represents the Sphinx connection via MySQL protocol.
yii\sphinx\IndexSchema IndexSchema represents the metadata of a Sphinx index.
yii\sphinx\MatchBuilder MatchBuilder builds a MATCH SphinxQL expression based on the specification given as a yii\sphinx\MatchExpression object.
yii\sphinx\MatchExpression MatchExpression represents a MATCH SphinxQL expression.
yii\sphinx\Query Query represents a SELECT SQL statement.
yii\sphinx\QueryBuilder QueryBuilder builds a SELECT SQL statement based on the specification given as a yii\sphinx\Query object.
yii\sphinx\Schema Schema represents the Sphinx schema information.
yii\sphinx\gii\model\Generator This generator will generate one or multiple ActiveRecord classes for the specified Sphinx index.