kphoen/rulerz-bundle

Symfony2 Bundle for RulerZ

Wednesday, April 18, 2018
by K-Phoen
Repository
4 Watchers
31 Stars
80,465 Installations

PHP
1 Dependents
0 Suggesters
14 Forks
3 Open issues
25 Versions
8 % Grown

The README.md

RulerZBundle

This bundle integrates RulerZ into Symfony., _(*1)

Installation

Require the bundle:, _(*2)

composer require 'kphoen/rulerz-bundle'

And declare it into your app/AppKernel.php file:, _(*3)

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

Usage

This bundle registers a rulerz service which is an instance of RulerZ\RulerZ., _(*4)

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

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

See RulerZ's documentation for more information., _(*5)

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:, _(*6)

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

In addition to the rulerz.operator tag, two other values are needed: * target: the compilation target we want to register the operator for ; * operator: the name that will be given to the operator in rules., _(*7)

Important: Operators registered as classes must implement the __invoke magic method as RulerZ expects custom operators to be defined as callable., _(*8)

Validators

A rule validator is provided by the bundle. In its simplest form, it will only validate the syntax of a given rule. Unknown variables or operators won't be detected unless you define a whitelist of accepted values., _(*9)

use Symfony\Component\Validator\Constraints as Assert;
use Symfony\Bridge\RulerZ\Validator\Constraints as RulerZAssert;

class TaggingRule
{
    /**
     * @var string
     *
     * @Assert\NotBlank()
     * @RulerZAssert\ValidRule(
     *  allowed_variables={"title", "url", "isArchived", "isStared", "content", "language", "mimetype", "readingTime", "domainName"},
     *  allowed_operators={">", "<", ">=", "<=", "=", "is", "!=", "and", "not", "or"}
     * )
     */
    private $rule;
}

Configuration reference

# app/config/config.yml

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

    targets:
        native: false
        doctrine: false
        doctrine_dbal: false
        eloquent: false
        pomm: false
        solarium: false
        elasticsearch: false

The targets section allows you to enable only the compilation targets needed by your application., _(*10)

Licence

This bundle is under the MIT licence., _(*11)

The Versions

18/04 2018

dev-master

9999999-dev https://github.com/K-Phoen/RulerZBundle

Symfony2 Bundle for RulerZ

symfony-bundle rulerz-bundle

Symfony2 Bundle for RulerZ

kphoen/rulerz-bundle

The README.md

RulerZBundle

Installation

Usage

Custom operators

Validators

Configuration reference

Licence

The Versions

dev-master

The Requires

The Development Requires

by Kévin Gomez

0.14.1

The Requires

The Development Requires

by Kévin Gomez

0.14.0

The Requires

The Development Requires

by Kévin Gomez

0.13.2

The Requires

The Development Requires

by Kévin Gomez

dev-bridge

The Requires

The Development Requires

by Kévin Gomez

0.13.1

The Requires

The Development Requires

by Kévin Gomez

0.13.0

The Requires

The Development Requires

by Kévin Gomez

0.12.1

The Requires

The Development Requires

by Kévin Gomez

0.12.0

The Requires

The Development Requires

by Kévin Gomez

0.11.1

The Requires

The Development Requires

by Kévin Gomez

0.11.0

The Requires

The Development Requires

by Kévin Gomez

0.10.0

The Requires

The Development Requires

by Kévin Gomez

0.9.1

The Requires

The Development Requires

by Kévin Gomez

0.9.0

The Requires

The Development Requires

by Kévin Gomez

0.8.0

The Requires

The Development Requires

by Kévin Gomez

0.7.3

The Requires

The Development Requires

by Kévin Gomez

0.7.2

The Requires

The Development Requires

by Kévin Gomez