emhar/search-doctrine-bundle

Simple way to create a search service in tiny web sites. It works without search engine, just with Doctrine ORM.

Search Doctrine Bundle

What is SearchDoctrineBundle ?

Simple way to create a search service in tiny web sites. It works without search engine, just with Doctrine ORM. Describe your result with a simple PHP class, bind it with annotations to your Doctrine entities., _(*1)

This Symfony2 Bundle provide a service that generate a search Form, results and page count. Result objects are ordered by score, calculated with requested word weights in hits., _(*2)

, _(*3)

Installation

Composer

Add the following dependencies to your projects composer.json file:, _(*4)

"require": {
    # ..
    "emhar/search-doctrine-bundle": "dev-master"
    # ..
}

You have to enable the bundle in your AppKernel.php :, _(*5)

// app/AppKernel.php
public function registerBundles()
{
    return array(
        //...
            new Emhar\SearchDoctrineBundle\EmharSearchDoctrineBundle(),
        //...
    );
}

Usage

Describe a Search Item

//...

use Emhar\SearchDoctrineBundle\Item\AbstractItem;
use Emhar\SearchDoctrineBundle\Mapping\Annotation\Hit;
use Emhar\SearchDoctrineBundle\Mapping\Annotation\ItemEntity;

/**
 * @ItemEntity(
 *  identifier="artist",
 *  label="My Artists",
 *  entityClass="MyBundle\Entity\Artist"
 * )
 * @ItemEntity(
 *  identifier="album",
 *  label="My Albums",
 *  entityClass="MyBundle\Entity\Album"
 * )
 */
class MyItem extends AbstractItem
{

    //...

    /**
     * Construct Resource
     *
     * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID", mapping={
     *  "album"="id",
     *  "artist"="id"
     * })
     * @Hit(identifier="name", scoreFactor=3, sortable=false, label="Name", mapping={
     *  "album""name",
     *  "artist""name"
     * })
     */
    public function __construct($id, $name, $score, $type)
    {
        //...
    }

    //...
}

Call service to get form, results and page count

//...
use ...\Resource;
//...
$searchService = $this->get('emhar_search_doctrine.search_service');
/* @var $searchService \Emhar\SearchDoctrineBundle\Services\SearchService */
$form = $searchService->getForm(MyItem::getClass(), $this->generateUrl('...'));
$form->handleRequest($this->getRequest());
if ($form->isValid())
{
    $items = $searchService->getResults(MyItem::getClass(), $form, $page);
    $pageCount = $searchService->getPageCount(MyItem::getClass(), $form);
}
//...

You must provide an action URI to getForm method, _(*6)

ItemEntity annotation

/**
 * @ItemEntity(
 *  identifier="album",
 *  label="My Albums",
 *  entityClass="MyBundle\Entity\Album"
 * )
 */

• identifier: an identifier of your choice string required
• label: Entity label, will be used in form string required
• entityClass: Entity class, must be a valid doctrine entity string required

Hit annotation

/**
 * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID" mapping={
 *  "album"="id",
 *  "artist"="id"
 * })
 */

• identifier: constructor parameter string required
• scoreFactor: hit factor in score int default 1
• sortable: boolean, determine if hit is sortable bool default false, currently not supported
• label: label for this hit string required
• mapping key: entity identifier from SearchItem annotation string
• mapping value: entity attribute name string required

Several types, string conversion

If a hit has several types depending on the entities, returns depending on type : - result casted as string - empty string., _(*7)

/**
 * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID", mapping={
 *  "album"="id",
 *  "artist"="name"
 * })
 */

Omit some entities

You can omit some entities in the hit definitions, returns null value., _(*8)

/**
 * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID", mapping={
 *  "album"="id",
 *  "artist"="id"
 * })
 * @Hit(identifier="name", scoreFactor=3, sortable=false, label="Name", mapping={
 *  "album"="name"
 * })
 */

Chain getter, nToOne relation

You can chain getters for nToOne relations, implode attribute names by points., _(*9)

/**
 * @Hit(identifier="ownerName", scoreFactor=2, sortable=false, label="Owner Name", mapping={
 *  "album"="artist.name",
 *  "track"="album.artist.name"
 * })
 */

Waring: Chained getters duplicates results in nToMany relations., _(*10)

Get score and entity identifier

If you name an item constructor parameter : - score: receive the item score, calculate with the character number that match with request text - type: receive the entity identifier, useful to recognize from where the result comes and maybe generate different URL..., _(*11)

//...
/**
 * Construct Resource
 *
 * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID", mapping={
 *  "album"="id",
 *  "artist"="id"
 * })
 * @Hit(identifier="name", scoreFactor=3, sortable=false, label="Name", mapping={
 *  "album""name",
 *  "artist""name"
 * })
 */
public function __construct($id, $name, $score, $type)
{
    //...
}
//...

Or omit them if you do not need, _(*12)

//...
/**
 * Construct Resource
 *
 * @Hit(identifier="id", scoreFactor=0, sortable=false, label="ID", mapping={
 *  "album"="id",
 *  "artist"="id"
 * })
 * @Hit(identifier="name", scoreFactor=3, sortable=false, label="Name", mapping={
 *  "album""name",
 *  "artist""name"
 * })
 */
public function __construct($id, $name)
{
    //...
}
//...