Skip to content

K-Phoen/RulerZBundle

Repository files navigation

RulerZBundle

This bundle integrates RulerZ into Symfony.

Installation

Require the bundle:

composer require 'kphoen/rulerz-bundle'

And declare it into your app/AppKernel.php file:

public function registerBundles()
{
    return array(
        // ...
        new KPhoen\RulerZBundle\KPhoenRulerZBundle(),
    );
}

Usage

This bundle registers a rulerz service which is an instance of RulerZ\RulerZ.

$rulerz = $this->container->get('rulerz');

$rulerz->filter(/* ... */);

Custom operators

Custom operators can be added to RulerZ executors. The bundle provide a way to register new operators directly from the container, you just need to tag a service:

services:
    operator.array.like:
        class: RulerZ\Operator\ArrayExecutor\Like
        tags:
            - { name: rulerz.operator, executor: RulerZ\Executor\ArrayExecutor, operator: like }

In addition to the rulerz.operator parameter, two other values are needed:

  • executor: the class we want to register the operator to ;
  • operator: the name that will be given to the operator.

Important: Operators registered as classes must implement the __invoke magic method as RulerZ expects custom operators to be defined as callable.

Configuration reference

# app/config/config.yml

kphoen_rulerz:
    cache: %kernel.cache_dir%/rulerz
    debug: %kernel.debug%

Licence

This bundle is under the MIT licence.