hugorut/filterable

A laravel package for working with query filtering

0.0.1 2015-12-06 14:14 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• mockery/mockery: >=0.9
• phpunit/phpunit: ^5.1

MIT

• Hugo Rut

• orm
• laravel
• eloquent

README

#Fiterable A package which provides a fluent interface to apply constraints to an Eloquent query

For example:

#Set the package to run all constraints against an Article model
$filter = Filter::setType('articles');

#filter those articles by the Page and Author model so that only
#articles that appear with these contraints are returned
$filter->only([
    'pages' => [1, 2], 
    'authors' => [4, 7, 9]
])->get();

Installation

First, pull in the package through Composer.

composer require hugorut/filterable

Include the service provider within config/app.php.

'providers' => [
    Hugorut\Filter\Laravel\FilterServiceProvider::class,
];

Add the facade alias to this same file at the bottom:

'aliases' => [
    'Filter'    => Hugorut\Filter\Laravel\Filter::class,
];

Then publish the package assets by running in your project root

php artisan vendor:publish

You should see a terminal output similar to:

Copied File [/vendor/Filter/src/Hugorut/Filter/config.php] To [/config/filter.php]
Publishing complete for tag []!

Usage

Config

First you need to provide the package with knowledge of what models are filterable and which can have filters applied to them. Add your settings to the package configuration file which located at app\config\filter.php after you have published the package assets.

Add models you wish to apply filters to in the Builders array

'Builders' => [
    'articles' => 'App\Article'
],

Add models you wish to filter by in the Filters array

'Filters' => [
    'pages' => 'App\Page',
    'authors' => 'App\Author'
],

API

It is highly recommended that you use the Filter facade or dependency injection to access the package functionality as this the class has a number of depencies which the laravel IOC container can rectify.

Using the Filter class is simple, first set a model you wish to appy filters against (and which has been aliased in the filter config file).

$filter = Filter::setType('articles');

Now the filter is configured to the correct model you can call either the only or the without methods on the filter.

$filter->only(['pages' => [1, 2]]);
/*-----
* or
-----*/
$filter->without(['pages' => [1, 2]]);

The parameters of both of these methods are an assoicative array. The keys of this associative array are the model aliases (as defined in your app\config\filter.php config file) and the values are an array of the ids of these models.

Call the get method on the filter to then query the database and return the filtered results.

$filter->get();