Download the PHP package doncadavona/eloquenturl without Composer
On this page you can find all versions of the php package doncadavona/eloquenturl. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download doncadavona/eloquenturl
More information about doncadavona/eloquenturl
Files in doncadavona/eloquenturl
Package eloquenturl
Short Description Search and filter Laravel Eloquent models by query parameters with ease.
License MIT
Homepage https://github.com/doncadavona/eloquenturl
Informations about the package eloquenturl
Eloquenturl
Eloquenturl automatically adds search and filtering for your Eloquent models using query strings.
Eloquenturl respects the $fillable
and $hidden
attributes of your Eloquent models to make sensible defaults, providing zero-configuration usage. For example:
By just passing the model and the request, the model is made searchable and filterable without you having to manage which attributes are queryable and without writing complex logic and database queries.
Eloquenturl is fast because it is built and executed as a single database query.
Read Eloquenturl: A Laravel Package to Simplify or Eliminate Query Building for URL Parameters.
Table of Contents
- I. Installation
- II. Usage
- III. Query Parameters
- IV. Change Log
- V. Testing
- VI. Contributing
- VII. Security
- VIII. Credits
- IX. License
I. Installation
Install using Composer:
II. Usage
Eloquenturl::eloquenturled()
Use Eloquenturl::eloquenturled()
to quickly build and execute the database query based on the request query parameters. It returns the paginated entries of the given Eloquent model, based on the URL parameters and the model's $fillable
and $hidden
attributes. Just pass the model and the request:
Eloquenturl::eloquenturl()
Use Eloquenturl::eloquenturl()
when you need to add additional queries, such as eager-loading, or any other database queries available in Laravel Query Builder.
Here is an example UsersController
with several examples.
Here are example URLs with query parameters:
III. Query Parameters
- page
- per_page
- search
- search_by
- order
- order_by
- scopes
- lt (less than)
- gt (greater than)
- lte (less than or equal)
- gte (greater than or equal)
- min (alias for gte)
- max (alias for lte)
page
per_page
search
search_by
order
order_by
scopes
lt (less than)
gt (greater than)
lte (less than or equal)
gte (greater than or equal)
min (alias for gte)
max (alias for lte)
When unknown parameters are in the request, they will be queried with WHERE Clause using equality condition. For example:
The equivalent database queries will be:
IV. Change log
Please see the changelog for more information on what has changed recently.
V. Testing
VI. Contributing
Please see contributing.md for details and a todolist.
VII. Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
VIII. Credits
IX. License
MIT. Please see the license file for more information.