artshpakov / search-sphinxsearchbundle

Sphinx search bundle for Symfony 2.

About SphinxsearchBundle

Installation:

1. Download the bundle
2. Configure the autoloader
3. Enable the bundle
4. Configure the bundle

Step 1: Download the bundle

How you actually download the bundle is entirely up to you. However, once downloaded, you should place it in the src/Search/SphinxsearchBundle directory.

Step 2: Configure the autoloader

<?php
// app/autoload.php

$loader->registerNamespaces(array(
        // ...
        'Search' => __DIR__ . '/../src',
));

Step 3: Enable the bundle

<?php
// app/AppKernel.php

public function registerBundles()
{
        $bundles = array(
                // ...
                new Search\SphinxsearchBundle\SphinxsearchBundle(),
        );
}

Step 4: Configure the bundle

sphinxsearch:
    indexes:
        - name: allSite                      #Index label
          index:                             #list of indexes
              - %sphinxsearch_index_pages%   #index name
              - %sphinxsearch_index_books%
          field_weights:
              label: 10
              content: 5
        - name: books
          index:
              - %sphinxsearch_index_books%
          field_weights:
              label: 10
              content: 5
    searchd:
        host:   %sphinxsearch_host%
        port:   %sphinxsearch_port%
        socket: %sphinxsearch_socket%
    indexer:
        bin:    %sphinxsearch_indexer_bin%

    mapping:
        Book:
           repository: "GIDiaBundle:Book"    #Doctrine repository name
           parameter: "model_name"           #returned by sphinx. By this parameter Bundle will choose repository
           value: 1                          #uniq value for parameter
        Page:
           repository: "GIDiaBundle:Page"
           parameter: "model_name"
           value: 2

At least one index must be defined, and you may define as many as you like.

In the above sample configuration, allSite is used as a label for the index named %sphinxsearch_index_pages% and %sphinxsearch_index_books% (as defined in your sphinx.conf). This allows you to avoid having to hard code raw index names inside of your code. You can also optionally define field weights to be applied when searching.

EXAMPLE

our basic search is simply:

$indexesToSearch = array(
  'Items' => array(),
  'Categories' => array(),
);
$sphinxSearch = $this->get('search.sphinxsearch.search');
$searchResults = $sphinxSearch->search('search query', $indexesToSearch);

That performs a search for search query against the indexes labeled Items and Categories with whatever defaults that are defined (both here and in your sphinx.conf).

If you want to do more than your basic search, it would look something like:

$indexesToSearch = array(
  'Items' => array(
    'result_offset' => 0,
    'result_limit' => 25,
  ),
  'Categories' => array(
    'result_offset' => 0,
    'result_limit' => 10,
  ),
);
$sphinxSearch = $this->get('search.sphinxsearch.search');
$sphinxSearch->setMatchMode(SPH_MATCH_EXTENDED);
$sphinxSearch->setFilter('disabled', array(1), true);
$searchResults = $sphinxSearch->search('search query', $indexesToSearch);

This would again search Items and Categories for search query, but now Items will return the first 25 matches, and Categories will return the first 10. In order to define a result_offset or a result_limit, you must explicitly define both values. Also, this will use the Extended matching mode, and exclude all results with a disabled attribute set to 1.

License:

Copyright (c) 2012, Ryan Rogers
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met: 

1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer. 
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution. 

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.