verdet/sphinxsearch-bundle

Sphinx search bundle for Symfony 2

Installs: 6 307

Dependents: 1

Stars: 7

Watchers: 1

Forks: 3

Language: PHP

v1.0.1 2014-04-01 16:39 UTC

README

This bundle is a fork of timewasted/Search-SphinxsearchBundle.

Installation:

  1. Download the bundle using composer
  2. Configure the bundle

Step 1: Download the bundle

Add SphinxSearchBundle in your composer.json:

{
    "require": {
        "verdet/sphinxsearch-bundle": "*",
        "neutron/sphinxsearch-api": "*"
    }
}

Bundle require SphinxApi via "neutron/sphinxsearch-api", specify it version according to your sphinxsearch system package version.

Step 2: Configure the bundle

sphinx_search:
    indexes:
        Categories: %sphinxsearch_index_categories%
        Items:      %sphinxsearch_index_items%
    searchd:
        host:   %sphinxsearch_host%
        port:   %sphinxsearch_port%
        socket: %sphinxsearch_socket%
    indexer:
        sudo:   %sphinxsearch_indexer_sudo%
        bin:    %sphinxsearch_indexer_bin%
        config: %sphinxsearch_indexer_config%

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

In the above sample configuration, Categories is used as a label for the index named %sphinxsearch_index_categories% (as defined in your sphinxsearch.conf). This allows you to avoid having to hard code raw index names inside of your code.

Usage examples:

The most basic search, using the above configuration as an example, would be:

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

This performs a search for search query against the index labeled Items. The results of the search are stored in $searchResults.

You can also perform more advanced searches, such as:

$indexesToSearch = array('Items');
$options = array(
  'result_offset' => 0,
  'result_limit' => 25,
  'field_weights' => array(
    'Name' => 2,
    'SKU' => 3,
  ),
);
$sphinxSearch = $this->get('search.sphinxsearch.search');
$sphinxSearch->setMatchMode(SPH_MATCH_EXTENDED2);
$sphinxSearch->setFilter('disabled', array(1), true);
$searchResults = $sphinxSearch->search('search query', $indexesToSearch, $options);

This would again search Items for search query, but now it will only return up to the first 25 matches and weight the Name and SKU fields higher than normal. Note that in order to define a result_offset or a result_limit, you must explicitly define both values. Also, this search will use the Extended query syntax, and exclude all results with a disabled attribute set to 1.

License:

Copyright (c) 2012, Ryan Rogers
Copyright (c) 2013, Igor Khokhlov
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.