roaresearch/yii2-fulltext

Yii 2 Library to support full text index and search

dev-master 2024-05-17 06:23 UTC

Requires

• php: ~8.1
• yiisoft/yii2: ~2.0.27

Requires (Dev)

• ext-mbstring: *
• codeception/codeception: ~5.0.0
• codeception/module-asserts: dev-master
• codeception/module-yii2: *
• codeception/verify: ~1.2.0
• roaresearch/composer-utils: *
• yiisoft/yii2-debug: ~2.1.0

BSD-3-Clause

• framework
• migration
• migrate
• fulltext
• advanced
• yii2
• relational model database

README

Library with migrations and queries to utilize the FullText search funcionality.

Installation

You can use composer to install the library roaresearch/yii2-fulltext by running the command;

composer require roaresearch/yii2-fulltext

or edit the composer.json file

require: {
    "roareasearch/yii2-fulltext": "*",
}

Usage

Create Migrations

The migration to create a full text index is meant to be executed after loading the DB data using Fixtures or other tools.

roaresearch\yii2\fullText\AddFullTextMigration

Create a new migration for each table to be modified. Remember that FullText significantly slows the storing of information so its meant to be used sparcely.

use roaresearch\yii2\fullText\AddFullTextMigration;

class m170101_000001_add_fulltext_article extends AddFullTextMigration
{
    public function getTableName()
    {
        return 'article';
    }

    public function fullTextIndexes()
    {
        return [
            'ft-index1' => 'column1',
            'ft-index2' => ['column1', 'column2'],
        ];
    }
}

Testing Environment

This library use Composer Utils to quickly deploy the needed database and testing Environment.

git clone https://github.com/ROAResearch/yii2-fulltext.git
cd yii2-rmdb/
composer deploy

This will ask db credentials, validate them and create the needed database and structure.