MassiveSearchBundle¶

Installation¶

You can install the MassiveSearchBundle by adding it to composer.json:

"require": {
    ...
    "massive/search-bundle": "0.1"
}

And then include it in your AppKernel:

class AppKernel
{
    public function registerBundles()
    {
        return array(
            // ...
            new \Massive\Bundle\SearchBundle\MassiveSearchBundle(),
        );
    }
}

You will also need to include a search library. The search libraries are listed in the suggests section of composer.json, and exact package versions can also be found in the require-dev section (as all the libraries are tested).

For example, to enable the ZendLucene search library:

"require": {
    ...
    "zendframework/zend-stdlib": "2.3.1 as 2.0.0rc5",
    "zendframework/zendsearch": "2.*",
}

Mapping¶

The MassiveSearchBundle requires that you define which objects should be indexed through mapping. Currently only XML mapping supported:

This mapping will cause the fields title and body to be indexed into an index named product using the ID obtained from the objects id field. (We use the Symfony PropertyAccess component, so it works on properties and methods alike).

Note:

• This file MUST be located in YourBundle/Resources/config/massive-search
• It must be named after the name of your class (without the namespace) e.g. Product.xml
• Your Product class MUST be located in one of the following folders: - YourBundle/Document - YourBundle/Entity - YourBundle/Model

Indexing¶

Once you have created your mapping files you can index your objects, for example after saving it.

The bundle provides the massive_search.search_manager object which is the only service which you will need to access.

$product = new Product();

// ... populate the product, persist it, whatever.

$searchManager = $this->get('massive_search.search_manager');
$searchManager->index($product);

The SearchManager will know from the mapping how to index the product, and it will be indexed using the configured search library adapter.

Searching¶

As with the indexing, searching for results is also done with the SearchManager.

Currently only supported by query string is supported. The query string is passed directly to the search library:

$hits = $searchManager->createSearch('My Product')->index('product')->execute();

foreach ($hits as $hit) {
    echo $hit->getScore();

    // @var Massive\Bundle\SearchBundle\Search\Document
    $document = $hit->getDocument();

    // retrieve the indexed documents "body" field
    $body = $document->getField('body');

    // retrieve the indexed ID of the document
    $body = $document->getId();
}

Commands¶

The MassiveBuildBundle provides some commands.

$ php app/console massive:search:query "Foobar" --index="barfoo"
+------------------+--------------------------------------+-----------+-------------+-----------+------------------------+
| Score            | ID                                   | Title     | Description | Url       | Class                  |
+------------------+--------------------------------------+-----------+-------------+-----------+------------------------+
| 0.53148467371593 | ac984681-ca92-4650-a9a6-17bc236f1830 | Structure |             | structure | OverviewStructureCache |
+------------------+--------------------------------------+-----------+-------------+-----------+------------------------+

$ php app/console massive:search:status
+-------------+--------------------------------------------------------------+
| Field       | Value                                                        |
+-------------+--------------------------------------------------------------+
| Adapter     | Massive\Bundle\SearchBundle\Search\Adapter\ZendLuceneAdapter |
| idx:product | {"size":11825,"nb_files":36,"nb_documents":10}               |
+-------------+--------------------------------------------------------------+

Extending¶

You can extend the bundle by customizing the Factory class and with custom metadata drivers.

namespace My\Namespace;

use Massive\Bundle\SearchBundle\Search\Factory as BaseFactory;

class MyFactory extends BaseFactory
{
    public function makeDocument()
    {
        return MyCustomDocument();
    }
}

massive_search:
    services:
        factory: my.factory.service

<service id="massive_search.metadata.driver.xml" class="%massive_search.metadata.driver.xml.class%">
    <argument type="service" id="massive_search.metadata.file_locator" />
    <tag type="massive_search.metadata.driver" />
</service>

<?php

namespace Sulu\Bundle\SearchBundle\EventListener;

use Massive\Bundle\SearchBundle\Search\Event\HitEvent;

class HitListener
{
    public function onHit(HitEvent $event)
    {
        $reflection = $event->getDocumentReflection();
        if (false === $reflection->isSubclassOf('MyClass')) {
            return;
        }

        $document = $event->getDocument();
        $docuemnt->setUrl('Foo' . $document->getUrl());
    }
}