README

Eloquent compilation target for RulerZ.

Usage

Eloquent ORM is one of the targets supported by RulerZ.

This cookbook will show you how to retrieve objects using Eloquent and RulerZ.

Here is a summary of what you will have to do:

configure Eloquent;
configure RulerZ;
filter your target.

Configure Eloquent

This subject won't be directly treated here. You can either follow the official documentation.

Configure RulerZ

Once Eloquent is installed and configured we can the RulerZ engine:

$rulerz = new RulerZ(
    $compiler, [
        new \RulerZ\Eloquent\Target\Eloquent(), // this line is Eloquent-specific
        // other compilation targets...
    ]
);

The only Eloquent-related configuration is the Eloquent target being added to the list of the known compilation targets.

Filter your target

Now that both Eloquent and RulerZ are ready, you can use them to retrieve data.

The Eloquent instance that we previously injected into the RulerZ engine knows how to use both Illuminate\Database\Query\Builder and Illuminate\Database\Eloquent\Builder instances, so the first step is to create a query builder:

$queryBuilder = User::query(); // where "User" is an Eloquent model

And as usual, we call RulerZ with our target and our rule. RulerZ will build the right executor for the given target and use it to filter the data, or in our case to retrieve data from a database.

$rule  = 'gender = :gender and points > :points';
$parameters = [
    'points' => 30,
    'gender' => 'M',
];

var_dump(
    iterator_to_array($rulerz->filter($queryBuilder, $rule, $parameters))
);

That's it!

License

This library is under the MIT license.

rulerz-php / eloquent

Maintainers

Details