codelytv/criteria-from-url

There is no license information available for the latest version (0.1.3) of this package.

Maintainers

Details

github.com/CodelyTV/php-criteria-from_url

Source

Issues

Installs: 30

Dependents: 2

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

0.1.3 2024-08-06 13:56 UTC

Requires

Requires (Dev)

Unknown License 8c1709351fcda29daf5c6797c1e0eefca1eb30b1

This package is auto-updated.

Last update: 2024-12-06 14:41:16 UTC

README

🎼 Criteria from URL

🔒 Read-only repository

Any modification must be done in the main repository.

📥 Installation

composer require codelytv/criteria-from-url

💻 Usage

The criteria converter expect an url with the following format:

  • filters: An array of filters. Composed by:
    • field: The field to filter by.
    • operator: The operator to apply. You can see here the valid operators list.
    • value: The value to filter by.
  • orderBy: The field to order by.
  • order: The order to apply. asc or desc.
  • pageSize: The number of items per page.
  • pageNumber: The page number.

Url examples

Url with one filter and no order or pagination:

http://localhost:3000/api/users?filters[0][field]=name&filters[0][operator]=CONTAINS&filters[0][value]=Javi`

Url with two filter, order and pagination:

http://localhost:3000/api/users
     ?filters[0][field]=name&filters[0][operator]=CONTAINS&filters[0][value]=Javi
     &filters[1][field]=email&filters[1][operator]=CONTAINS&filters[1][value]=gmail
     &orderBy=name
     &order=asc
     &pageSize=10
     &pageNumber=2

Code usage

$url = 'http://localhost:3000/api/users?filters[0][field]=name&filters[0][operator]=CONTAINS&filters[0][value]=Javi';

$converter = new CriteriaFromUrlConverter();

$criteria = $converter->toCriteria($url);