README

filter-lists is a Laravel package for dealing with lists. Especially, the results that have the type Illuminate\Database\Eloquent\Collection

Include a paginated response and include these basic filters: page, limit, sort by, desc.

// page (integer): get your list with a specific page.
// limit (integer): get your list with a limited number of returned records.
// sortBy (string): sort the results according to a column.
// desc (bool): determine the type of your sort.

Include filters according to your model's columns.

// e.g: name, email, is_admin, etc ...

Include filters according to "dateRange" attribute

// get your list that is created between two dates.
{
  "from": "string",
  "to": "string"
}

Include filters according to "fixRange" attribute

Available values: today, monthly, yearly
// get your list that is created today.
// get your list that is created in the current month.
// get your list that is created in the current year.

.dependencies

laravel/framework: ">=8",

Installation

Require this package, with Composer, in the root directory of your project.

composer require ahmadaldali/filter-lists

Usage

# use the result's Trait && Request Facade
use AhmadAldali\FilterLists\Traits\ListsResult;
use Illuminate\Http\Request;

#In your controller, or where you want to use the filtering 
$collection = User::all(); #or any model
# then, call getTheResult function
$results = $this->getTheResult($collection , $request);