Sphinx full text search engine extension for the Yii framework

Fund package maintenance!
Open Collective

Installs: 797 740

Dependents: 7

Suggesters: 2

Security: 0

Stars: 182

Watchers: 33

Forks: 72

Open Issues: 4


2.0.16 2024-03-21 18:20 UTC


Sphinx Extension for Yii 2

This extension adds Sphinx full text search engine extension for the Yii framework 2.0. It supports all Sphinx features including Real-time Indexes.

For license information check the LICENSE-file.

Documentation is at docs/guide/README.md.

Latest Stable Version Total Downloads Build status


At least Sphinx version 2.0 is required. However, in order to use all extension features, Sphinx version 2.2.3 or higher is required.


The preferred way to install this extension is through composer.

Either run

php composer.phar require --prefer-dist yiisoft/yii2-sphinx

or add

"yiisoft/yii2-sphinx": "~2.0.0"

to the require section of your composer.json.


This extension interacts with Sphinx search daemon using MySQL protocol and SphinxQL query language. In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:

    listen = localhost:9306:mysql41

To use this extension, simply add the following code in your application configuration:

return [
    'components' => [
        'sphinx' => [
            'class' => 'yii\sphinx\Connection',
            'dsn' => 'mysql:host=;port=9306;',
            'username' => '',
            'password' => '',