stanislav-web/phalcon-searcher

Phalcon Database Searcher. This is the search service is designed to search multiple SQL tables. Convenient to use autocomplete, search documents, search the whole site.

Phalcon Database Searcher

, _(*1)

Extension is used to group search for project models. (Currently under TDD), _(*2)

Description

This is the search service is designed to search multiple SQL tables. Convenient to use autocomplete, search documents, search the whole site., _(*3)

Change Log

[v 1.0-beta] 2014-12-16

- support MySQL
- support column type such as INT, VARCHAR, CHAR, TEXT, DATE, DATETIME
- fulltext search
- support all main expressions (where, order, group, limit, offset)
- multi table search
- compatible with \Phalcon\Paginator
- view results as json, serialized, array or \Phalcon\Mvc\Model\Resultset\Simple
- support callbacks to pretty modifying result

Compatible

• PSR-0, PSR-1, PSR-2, PSR-4 Standards

System requirements

• PHP 5.5.x >
• MySQL
• Phalcon extension 1.3.x

Install

First update your dependencies through composer. Add to your composer.json:, _(*4)

"require": {
    "stanislav-web/phalcon-searcher": "dev-master",
}

Then run to update dependency and autoloader, _(*5)

php composer.phar update
php composer.phar install

or just, _(*6)

php composer.phar require stanislav-web/phalcon-searcher dev-master 

(Do not forget to include the composer autoloader), _(*7)

Or manual require in your loader service, _(*8)

    $loader->registerNamespaces([
        'Searcher\Searcher' => 'path to src'
    ]);

You can create an injectable service, _(*9)

    $this->di['searcher'] = function() {
        return new \Searcher\Searcher();
    };

Usage

Simple usage

<?php 
    use \Searcher\Searcher;

    // create object instance
    $searcher = new Searcher();

    // Prepare models and fields to participate in search
    $searcher->setFields([
        '\Models\Auto'    =>    [
            'mark',
            'model'
        ],
        '\Models\Distributor'    =>    [
            'name',
            'description'
        ]
    ])
    ->setQuery('FerRari');

    $result = $searcher->run();

Filters

<?php 
    use \Searcher\Searcher;

    // create object instance
    $searcher = new Searcher();

    // Prepare models and fields to participate in search
    $searcher->setFields([
        '\Models\Auto'    =>    [
            'mark',
            'model'
        ],
        '\Models\Distributor'    =>    [
            'name',
            'description'
        ]
    ])
    ->setMin(3)                                         //  minimum char to query
    ->setMax(15)                                        //  maximum char to query
    ->setExact(true)                                    //  strict mode search 
    ->setOrder(['\Models\Auto' => ['id' => 'DESC']])    //  ORDER BY \Models\Auto.id DESC
    ->setGroup(['\Models\Distributor' => ['id']])       //  GROUP BY \Models\Auto.id
    ->setThreshold(100)                                 //  LIMIT 100
    ->setQuery('FerRari');

    $result = $searcher->run();

<?php 
    use \Searcher\Searcher;

    // create object instance
    $searcher = new Searcher();

    // Prepare models and fields to participate in search
    $searcher->setFields([
        '\Models\Auto'    =>    [
            'mark',
            'model'
        ],
        '\Models\Distributor'    =>    [
            'name',
            'description'
        ]
    ])
    ->setExact(true) // strict mode search 
    ->setOrder([
                    '\Models\Auto' => ['id' => 'DESC']
                    '\Models\Distributor' => ['description' =>  'ASC']
              ])                                                //  ORDER BY \Models\Auto.id DESC, \Models\Distributor.description ASC
    ->setGroup([
                '\Models\Auto' => ['id', 'mark']
                '\Models\Distributor' => ['id', 'description']
              ])                                                //  GROUP BY \Models\Auto.id, \Models\Auto.mark, \Models\Distributor.id, \Models\Distributor.description 

    ->setThreshold([0,100])                                     //    OFFSET 0, LIMIT 100
    ->setQuery('FerRari');

    $result = $searcher->run();

Result modifiers and callbacks

<?php 
    use \Searcher\Searcher;

    // create object instance
    $searcher = new Searcher();

    // Prepare models and fields to participate in search
    $searcher->setFields([
        '\Models\Auto'    =>    [
            'mark',
            'model'
        ],
        '\Models\Distributor'    =>    [
            'name',
            'description'
        ]
    ])
    ->setQuery('FerRari');

    $result = $searcher->run('json'); // available array, serialize, json, Resultset as default

    // OR

    /**
     * @param $result 
     */
    $result = $searcher->run('array', function($result) {

        //... any modifiers 
        return $result;

    }); // available, array, serialize, json, Resultset as default

Unit Test

Also available in /phpunit directory. Run command to start, _(*10)

php build/phpunit.phar --configuration phpunit.xml.dist --coverage-text

Read logs from phpunit/log, _(*11)

Change Log

Issues

Screen (For what I use it?)

, _(*12)

, _(*13)

, _(*14)