Package Data | |
---|---|
Maintainer Username: | tinchogon34 |
Maintainer Contact: | dave@heroicpixels.com (Dave Hodgins) |
Package Create Date: | 2014-03-28 |
Package Last Update: | 2014-03-29 |
Language: | PHP |
License: | MIT |
Last Refreshed: | 2024-12-22 03:11:55 |
Package Statistics | |
---|---|
Total Downloads: | 22 |
Monthly Downloads: | 0 |
Daily Downloads: | 0 |
Total Stars: | 3 |
Total Watchers: | 2 |
Total Forks: | 0 |
Total Open Issues: | 1 |
This package gives you a convenient way to automatically filter Eloquent results based on query string parameters in the URL. Filterable parses the query string, compares it with columns that you'd like to automatically filter, then creates a dynamic scope that is used by Eloquent to construct the SQL.
Add the package to 'require' in your composer.json file:
"require": {
"heroicpixels/filterable": "dev-master"
},
Run 'composer dump-autoload' from the command line:
#composer dump-autoload
Register the service provider in 'app/config/app.php'. Service provider:
'providers' => array(
\\...
'Heroicpixels\Filterable\FilterableServiceProvider',
\\...
);
Edit your Eloquent model to extend 'Heroicpixels\Filterable\Filterable'.
class Object extends Heroicpixels\Filterable\Filterable {
// ...
}
In the above example, class Object corresponds to table 'objects':
| id | color | shape | total | |:-----|:--------|:-----------|:--------| | 1 | red | square | 150 | | 2 | blue | square | 2000 | | 3 | green | circle | 575 | | 4 | yellow | triangle | 15 | | 5 | red | triangle | 900 | | 6 | red | triangle | 600 |
Specify the column you want to automatically filter.
$columns = [ 'color', 'shape', 'total' ];
For example:
http://www.your-site/?color=blue&shape=round&total=500
You can also alias the columns if you prefer not to reveal them:
$columns = [ 'col' => 'color', 'sha' => 'shape', 'tot' => 'total' ];
For example:
http://www.your-site/?col=blue&sha=round&tot=500
To filter results, simply pass the columns to Eloquent using filterColumns():
$objects = Object::filterColumns($columns)->get()->toArray();
You can also filter joins:
$columns = array('color' => 'objects.color',
'name' => 'objects.name',
'shape' => 'objects.shape',
'category' => 'cat_object.cat_id');
$objects = Object::join('cat_object', 'objects.id', '=', 'cat_object.object_id')
->filterColumns($columns)
->get()->toArray();
And you can filter eager loads:
/**
* Columns available in main query
*/
$columns = array('color' => 'objects.color',
'name' => 'objects.name',
'shape' => 'objects.shape');
$objects = Object::with(array('categories' => function($q) {
/**
* Columns available to sub-query
*/
$columns = array('category' => 'cat_object.cat_id');
$q->filterColumns($columns);
}))->filterColumns($columns)
->get()
->toArray();
?color=red
SELECT ... WHERE ... color = 'red'
?color[]=red&color[]=blue
SELECT ... WHERE ... color = 'red' OR color = 'blue'
?color[]=red&shape[]=triangle
SELECT ... WHERE ... color = 'red' AND shape = 'triangle'
?color[]=red&shape[]=triangle&bool[shape]=or
SELECT ... WHERE ... color = 'red' OR shape = 'triangle'
Greater Than
?total=599&operator[total]=>
SELECT ... WHERE ... total > '599'
| id | color | shape | total | |:-----|:--------|:-----------|:--------| | 2 | blue | square | 2000 | | 5 | red | triangle | 900 | | 6 | red | triangle | 600 |
Less Than
?total=600&operator[total]=<
SELECT ... WHERE ... total < '600'
| id | color | shape | total | |:-----|:--------|:-----------|:--------| | 1 | red | square | 150 | | 3 | green | circle | 575 | | 4 | yellow | triangle | 15 |
Not Equal
?shape=triangle&operator[shape]=!=
SELECT ... WHERE ... shape != 'triangle'
| id | color | shape | total | |:-----|:--------|:-----------|:--------| | 4 | yellow | triangle | 15 | | 5 | red | triangle | 900 | | 6 | red | triangle | 600 |
Between
?total[start]=900&total[end]=5000
SELECT ... WHERE ... total BETWEEN '900' AND '5000'
| id | color | shape | total | |:-----|:--------|:-----------|:--------| | 2 | blue | square | 2000 | | 5 | red | triangle | 900 |