chub/search-bundle

Site search bundle for Symfony2

SearchBundle

Search Symfony2 bundle. Provides easy global search service for your site., _(*1)

, _(*2)

, _(*3)

Installation

Download bundle

First of all, download bundle using one of common ways:, _(*4)

Using deps file

Add the following lines to your deps file and run php bin/vendors install, _(*5)

[SearchBundle]
    git=https://github.com/ChubV/SearchBundle.git
    target=bundles/ChubProduction/SearchBundle

Using composer

Register the namespaces

Add the following namespace entry to the registerNamespaces call in your autoloader:, _(*6)

``` php <?php // app/autoload.php $loader->registerNamespaces(array( // ... 'ChubProduction\SearchBundle' => DIR.'/../vendor/bundles', // ... ));, <sub>(*7)</sub>

This is unnecessary step if you use Composer's automaticaly generated autoload file

### Register the bundle

To start using the bundle, register it in your Kernel:

``` php
<?php
// app/AppKernel.php

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

Use your Search

Create your search provider, that must implement SearchProviderInterface, <sub>(*8)</sub>

``` php <?php // NewsSearchProvider.php, <sub>(*9)</sub>

class NewsSearchProvider implements SearchProviderInterface { private $m;, <sub>(*10)</sub>

/**
 * @param string $str
 *
 * @return \Doctrine\Common\Collections\ArrayCollection
 */
public function search($str)
{
    // Perform search and return ArrayCollection of objects that implements SearchResultInterface
    // There is also default SearchResult class for this ChubProduction\SearchBundle\Service\SearchResult
}

/**
 * Return provider name
 *
 * @return string
 */
public function getName()
{
    return 'news';
}

/**
 * Return provider title
 *
 * @return string
 */
public function getTitle()
{
    return 'News, events, etc ';
}

Register search provider among other ones

``` yaml
# services.yml

news.search.provider:
        class: ChubProduction\NewsBundle\Search\NewsSearchProvider
        tags:
            - { name: search.provider }

content.search.provider:
        class: ...
        tags:
            - { name: search.provider }
....

Use the search getting an ArrayCollection of ResultSets with the results from your search providers, <sub>(*11)</sub>

``` php <?php ... /** * @return array|\Symfony\Component\HttpFoundation\RedirectResponse * @Route("/search/{_locale}", name="search") * @Template() */ public function searchAction($_locale) { $r = $this->getRequest(); if ($r->query->has('q')) { $res = $this->get('search')->search($r->query->get('q')); // Here is our service, <sub>(*12)</sub>

        return compact('res');
    }

    return $this->redirect($this->generateUrl('main_page', compact('_locale')));
}

```, <sub>(*13)</sub>