The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
Either run
Either run
```
```
php composer.phar require yiisoft/yii2-sphinx "*"
php composer.phar require yiisoft/yii2-sphinx "*"
```
```
or add
or add
```
```json
"yiisoft/yii2-sphinx":"*"
"yiisoft/yii2-sphinx":"*"
```
```
to the require section of your composer.json.
*Note: You might have to run `php composer.phar selfupdate`*
to the require section of your composer.json.
Usage & Documentation
Usage & Documentation
---------------------
---------------------
This extension adds [Sphinx](http://sphinxsearch.com/docs) full text search engine extension for the Yii framework.
This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) query language.
This extension interact with Sphinx search daemon using MySQL protocol and [SphinxQL](http://sphinxsearch.com/docs/current.html#sphinxql) query language.
In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:
In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added: