luchmewep/granular-search

This package is abandoned and no longer maintained. No replacement package was suggested.

Granular Search and Aggregation provides four (4) usable traits for model controllers which are useful for searching and aggregation.

3.0 2021-04-26 17:35 UTC

Requires

• illuminate/support: ~7|~8

Requires (Dev)

• orchestra/testbench: ~5|~6
• phpunit/phpunit: ~9.0

MIT

• James Carlo Luchavez

• laravel
• GranularSearch

README

Granular Search is an Eloquent model utility for implementing searching, filtering, and sorting with fewer lines of code.

Installation

Via Composer

$ composer require luchmewep/granular-search

Usage

To use this package, you have two options. You can either implement it on your Eloquent models, or you can just use the main method of this package which is the getGranularSearch (see GranularSearchTrait).

However, to fully utilize this package, the preferred way would be to implement the prepared Traits and Abstract Models. If still in doubt, you can just use the non-model intrusive way which is using the GranularSearch class itself.

Implement on Eloquent Models

There are two (2) ways to implement Granular Search on Eloquent models:

1. By extending the AbstractGranularModel or AbstractGranularUserModel for User-based models. (Highly Suggested)

1. By using the GranularSearchableTrait on your Eloquent models.

Extending the Abstract Models

Currently, there are two (2) models to choose from. For models that are unrelated to authentication, you can just use the AbstractGranularModel. As for authentication-related ones, using AbstractGranularUserModel is advised.

These two abstract classes are not really hard to understand since they just use the GranularSearchTrait and GranularSearchableTrait. They are just prepared beforehand to minimize trait-related bugs.

Once extended, you should set up these protected static fields.

// Model fields to be excluded from filtering
protected static $granular_excluded_keys = [];
// Model fields to use LIKE instead instead of equal
protected static $granular_like_keys = [];
// Relations to consider for filtering/searching
protected static $granular_allowed_relations = [];
// Relations to include on 'q' search (must be a subset of allowed relations array)
protected static $granular_q_relations = [];

Tinker Examples

• Normal Search / Filter

1. Filtering using model's own fields

1. Filtering using q as parameter

• Relational Search / Filter

1. Filtering through relations using other model's prepended fields

1. Filtering through relations using q parameter

Implement Manually

If you are not prepared to try it out on your current Eloquent models, you might want to test it out first using the GranularSearch class itself. Since the getGranularSearch is a static method, we don't need to instantiate the GranularSearch class. Here are the parameters for the static method:

/**
 * Filter the model collection using the contents of the $request variable.
 *
 * @param Request|array $request Contains all the information regarding the HTTP request
 * @param Model|Builder $model Model or query builder that will be subjected to searching/filtering
 * @param string $table_name Database table name associated with the $model
 * @param array $excluded_keys Request keys or table column names to be excluded from $request
 * @param array $like_keys Request keys or table column names to be search with LIKE
 * @param string $prepend_key
 * @param bool $ignore_q
 * @return Model|Builder
 */

Tinker Examples

1. Filtering using model's own fields

1. Filtering using q as parameter

Change log

Please see the changelog for more information on what has changed recently.

Testing

$ composer test

Contributing

Please see contributing.md for details and a todolist.

Security

If you discover any security related issues, please email author email instead of using the issue tracker.

Credits

• James Carlo Luchavez
• All Contributors

License

license. Please see the license file for more information.