Download the PHP package freebuu/laravel-filterable without Composer

On this page you can find all versions of the php package freebuu/laravel-filterable. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package laravel-filterable

Laravel Filterable

Simple filter and paginate index data. Main idea - KISS.

Example query:

In code this query reflects:

Installation

Requires laravel >= 9 and php ^8.1

Basic usage (pagination only)

Add HasRequestFilter trait to Model - that's all.

Example result for query /api/posts/?limit=25&offset=10

Filtration

For filtration, you need to create filter class for each model. Filter class must extend AbstractFilter. Best place for these classes is App\Http\Filters.

In method getFilterableFields() you specify which fields can be filtered in each filter case.

HINT - always add default state because filter cases may be supplemented.

To set this filter for Model - overwrite requestFilterClass() method

Filter case

Filterable query params contains four parts separated with _. Let's see example with where_has_groups__id=30,40

In code, they are presented as FilterCaseEnum.php and they work like this

Custom filters

In filter class you can make custom filter by creating a method like filterCustom - it must begin with filter. Then yoy can use it in query like ?filter_custom=123

HINT - you can use fieldValue here like ?filter_custom__alias=123 - it pass as third parameter in filter method.

Advanced usage

Limit

For security reasons, the limit field is set to a maximum value. If the request specifies a value greater, it will be reset to the default value.

Resource

To set up resource - just pass resource class like here Post::requestFilter()->response(PostResource::class).

Query callbacks

Sometimes you need to set up query condition situational - e.g. filter only for auth user


All versions of laravel-filterable with dependencies

PHP Build Version
Package Version
Requires php Version ^8.1
illuminate/support Version ^9.0 | ^10.0 | ^11.0
illuminate/database Version ^9.0 | ^10.0 | ^11.0
illuminate/http Version ^9.0 | ^10.0 | ^11.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package freebuu/laravel-filterable contains the following files

Loading the files please wait ....