https://github.com/yiisoft/yii2-sphinx

Yii 2 Sphinx extension.
https://github.com/yiisoft/yii2-sphinx

hacktoberfest sphinx yii yii2

Last synced: 29 days ago
JSON representation

Yii 2 Sphinx extension.

• Host: GitHub
• URL: https://github.com/yiisoft/yii2-sphinx
• Owner: yiisoft
• License: bsd-3-clause
• Created: 2013-11-24T22:45:37.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-03-21T18:21:22.000Z (8 months ago)
• Last Synced: 2024-03-24T16:09:25.418Z (8 months ago)
• Topics: hacktoberfest, sphinx, yii, yii2
• Language: PHP
• Homepage: http://www.yiiframework.com
• Size: 9.93 MB
• Stars: 183
• Watchers: 34
• Forks: 72
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: .github/CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md
  • Security: .github/SECURITY.md

Awesome Lists containing this project

README

        


    

        

    

    
Sphinx Extension for Yii 2

    


This extension adds [Sphinx](https://sphinxsearch.com/docs) full text search engine extension for the [Yii framework 2.0](https://www.yiiframework.com).

It supports all Sphinx features including [Real-time Indexes](https://sphinxsearch.com/docs/current.html#rt-indexes).

For license information check the [LICENSE](LICENSE.md)-file.

Documentation is at [docs/guide/README.md](docs/guide/README.md).

[![Latest Stable Version](https://poser.pugx.org/yiisoft/yii2-sphinx/v/stable.png)](https://packagist.org/packages/yiisoft/yii2-sphinx)

[![Total Downloads](https://poser.pugx.org/yiisoft/yii2-sphinx/downloads.png)](https://packagist.org/packages/yiisoft/yii2-sphinx)

[![Build status](https://github.com/yiisoft/yii2-sphinx/workflows/build/badge.svg)](https://github.com/yiisoft/yii2-sphinx/actions?query=workflow%3Abuild)

Requirements

------------

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.

Installation

------------

The preferred way to install this extension is through [composer](https://getcomposer.org/download/).

Either run

```

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

```

or add

```json

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

```

to the require section of your composer.json.

Configuration

-------------

This extension interacts with Sphinx search daemon using MySQL protocol and [SphinxQL](https://sphinxsearch.com/docs/current.html#sphinxql) query language.

In order to setup Sphinx "searchd" to support MySQL protocol following configuration should be added:

```

searchd

{

    listen = localhost:9306:mysql41

    ...

}

```

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

```php

return [

    //....

    'components' => [

        'sphinx' => [

            'class' => 'yii\sphinx\Connection',

            'dsn' => 'mysql:host=127.0.0.1;port=9306;',

            'username' => '',

            'password' => '',

        ],

    ],

];

```