lpi-lab/search-bundle

A bundle that use the lucene search engine

0.1.8 2015-05-04 08:38 UTC

Requires

• php: >=5.3.3
• egeloen/lucene-search-bundle: ~1.0
• zendframework/zendsearch: dev-master

Apache

• LPI - Jeremy

• lpi zend lucene search

README

The search bundle is a bundle that offer to you a light search engine. It works on lucene search library and include zend components.

Installation

1. in AppKernel

    new Ivory\LuceneSearchBundle\IvoryLuceneSearchBundle(),
    new Lpi\Bundle\SearchBundle\LpiSearchBundle(),

Configuration

1. in app/config/config.yml

    ivory_lucene_search:

        # Index identifier
        search_index:
            # Path to store the index (Required)
            path: %kernel.cache_dir%/search_index

            # Index analyser (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.charset.html
            analyzer: ZendSearch\Lucene\Analysis\Analyzer\Common\Text\CaseInsensitive

            # Max Buffered documents (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.index-creation.html#zend.search.lucene.index-creation.optimization.maxbuffereddocs
            max_buffered_docs: 10

            # Max merge documents (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.index-creation.html#zend.search.lucene.index-creation.optimization.maxmergedocs
            max_merge_docs: 10000 # (default: PHP_INT_MAX)

            # Merge factor (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.index-creation.html#zend.search.lucene.index-creation.optimization.mergefactor
            merge_factor: 10

            # Index directory permission (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.index-creation.html#zend.search.lucene.index-creation.permissions
            permissions: 0777

            # Auto optmized flag (Optional)
            # If this flag is true, each time you request an index, it will be optmized
            # See http://framework.zend.com/manual/en/zend.search.lucene.index-creation.html#zend.search.lucene.index-creation.optimization
            auto_optimized: false

            # Query parser encoding (Optional)
            # See http://framework.zend.com/manual/en/zend.search.lucene.searching.html#zend.search.lucene.searching.query_building.parsing
            query_parser_encoding: "UTF-8" # (default: "")

1. For each entities you want to be indexed, you will have to add the "Lpi\Bundle\SearchBundle\Model\IndexableInterface" an entity need to have these 4 methods:
   • getId()
   • getTitle()
   • getSlug()
   • getDescription()
2. in app/config/config.yml

    lpi_search:
        mappings: 
            - { value: ApplicationLpiEventBundle:Event , path: programmation_detail} #name of the entity you want to be indexed

Usage

Now you have all indexes registered and you want to uses them, really easy!

in a controller for example :

/**
 * @param Request $request
 * @return array
 * @Route("/search", name="path_search")
 * @Template()
 * @Method({"GET", "POST"})
 */
public function searchAction(Request $request) {
    $results = null;
    if ($request->request->has('term') and '' !== $request->request->get('term')) {
        $results = $this->get('lpi_lucene.search')->search($request->request->get('term'));
    }

    return array(
        'results' => $results
    );
}

and the render in your view for example:

{% if results is defined and results|length > 0 %}
    {% for result in results %}
        <div class="col-xs-12">
            <a href="{{ result.url }}" title="{{ result.title }}">
                {{ result.title }}
            </a>
        </div>
    {% endfor %}
{% else %}
    <div class="alert alert-warning">{{ 'search.result.nothing'|trans({}, 'messages') }}</div>
{% endif %}