#TNTSearch

A fully featured full text search engine written in PHP

##Demo

To see TNTSearch in action take a look at the demo page

##Installation

The easiest way to install TNTSearch is via composer. Create the following composer.json file and run the php composer.phar install command to install it.

{
    "require": {
        "teamtnt/tntsearch": "0.2.*"
    }
}

##Examples

Creating an index

In order to be able to make full text search queries you have to create an index.

Usage:

    use TeamTNT\TNTSearch\TNTSearch;

    $tnt = new TNTSearch;

    $tnt->loadConfig([
        'driver'    => 'mysql',
        'host'      => 'localhost',
        'database'  => 'dbname',
        'username'  => 'user',
        'password'  => 'pass',
        'storage'   => '/var/www/tntsearch/examples/'
    ]);

    $indexer = $tnt->createIndex('name.index');
    $indexer->query('SELECT id, article FROM articles;');
    //$indexer->setLanguage('german');
    $indexer->run();

Important: "storage" settings marks the folder where all of your indexes will be saved so make sure to have permission to write to this folder otherwise you might expect the following exception thrown:

• [PDOException] SQLSTATE[HY000] [14] unable to open database file *

Note: Your select statment MUST contain an ID field.

Searching

Searching for a phrase or keyword is trivial

    use TeamTNT\TNTSearch\TNTSearch;

    $tnt = new TNTSearch;

    $tnt->loadConfig($config);
    $tnt->selectIndex("name.index");

    $res = $tnt->search("This is a test search", 12);

    print_r($res); //returns an array of 12 document ids that best match your query

    //to display the results you need an additional query
    //SELECT * FROM articles WHERE id IN $res ORDER BY FIELD(id, $res);

The ORDER BY FIELD clause is important otherwise the database engine will not return the results in required order

Boolean search

    use TeamTNT\TNTSearch\TNTSearch;

    $tnt = new TNTSearch;

    $tnt->loadConfig($config);
    $tnt->selectIndex("name.index");

    //this will return all documents that have romeo in it but not juliet
    $res = $tnt->searchBoolean("romeo -juliet");
    
    //returns all documents that have romeo or hamlet in it
    $res = $tnt->searchBoolean("romeo or hamlet");
    
    //returns all documents that have either romeo AND juliet or prince AND hamlet
    $res = $tnt->searchBoolean("(romeo juliet) or (prince hamlet)");

Contributing

Please see CONTRIBUTING and CONDUCT for details.

Credits

• Nenad Tičarić
• All Contributors

License

The MIT License (MIT). Please see License File for more information.