README

Main purpose of this bundle is to integrate the RollerworksSearch Doctrine ORM extension with any Symfony based application.

RollerworksSearch provides a powerful searching system.

Installation

This package is an extension for the RollerworksSearchBundle make sure you have successfully installed and configured the bundle before continuing.

Require the rollerworks/search-doctrine-orm-bundle package in your composer.json and update your dependencies.

$ composer require rollerworks/search-doctrine-orm-bundle

Add the RollerworksSearchDoctrineOrmBundle to your application's kernel:

// in AppKernel::registerBundles()
$bundles = [
    ...
    new Rollerworks\Bundle\SearchBundle\RollerworksSearchBundle(),
    new Rollerworks\Bundle\SearchDoctrineDbalBundle\RollerworksSearchDoctrineDbalBundle(),
    new Rollerworks\Bundle\SearchDoctrineOrmBundle\RollerworksSearchDoctrineOrmBundle(),
    ...
];

Configuration

The RollerworksSearchDoctrineOrmBundle is already pre-configured and does not require configuring. But you properly want to configure a 'real' cache which stays persistent between page requests.

Caching

The Caching system uses the doctrine/cache system for caching generated SQL/DQL queries. You can use any driver supported by Doctrine for caching.

Note: The default driver uses an array which is only cached in memory.

Use a service-id as value for rollerworks_search_doctrine_orm.cache_driver.

# app/config/config.yml
rollerworks_search_doctrine_orm:
    cache_driver: rollerworks_search.doctrine_orm.cache.array_driver

Multiple EntityManagers

If you want to use the search system with other EntityManagers then the "default" you can configure this with the following:

# app/config/config.yml
rollerworks_search_doctrine_orm:
    entity_managers: [default, second]

Usage

The rollerworks_search.doctrine_orm.factory service provides the Rollerworks\Component\Search\Doctrine\Orm\DoctrineOrmFactory for creating WhereBuilders.

License

The source of this package is subject to the MIT license that is bundled with this source code in the file LICENSE.

Contributing

This is an open source project. If you'd like to contribute, please read the Contributing Code part of Symfony for the basics. If you're submitting a pull request, please follow the guidelines in the Submitting a Patch section.

rollerworks / search-doctrine-orm-bundle

Maintainers

Details