spatie/query-string

Manipulate query strings

1.0.1 2019-11-15 10:28 UTC

This package is auto-updated.

Last update: 2020-07-26 08:11:17 UTC


README

Latest Version on Packagist Build Status StyleCI Quality Score Total Downloads

Work with query strings

Support us

Learn how to create a package like this one, by watching our premium video course:

Laravel Package training

We invest a lot of resources into creating best in class open source packages. You can support us by buying one of our paid products.

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on our contact page. We publish all received postcards on our virtual postcard wall.

Installation

You can install the package via composer:

composer require spatie/query-string

Usage

use Spatie\QueryString\QueryString;

$queryString = new QueryString($uri);

Toggle parameters

A single toggle

# / > /?toggle

$queryString->toggle('toggle');

Toggle a value

# / > /?single=a

$queryString->toggle('single', 'a');
# /?single=a > /?single=b

$queryString->toggle('single', 'b');
# /?single=a > /?

$queryString->toggle('single', 'a');

Toggle multiple values

# / > /?multi[]=a&multi[]=b

$queryString->toggle('multi[]', 'a');
$queryString->toggle('multi[]', 'b');
# /?multi[]=a&multi[]=b > /?multi[]=a

$queryString->toggle('multi[]', 'b');

Filter

Filtering the query string will use the JSON API filter syntax.

# / > /?filter[field]=a

$queryString->filter('field', 'a');
# / > /?filter[field][]=b

$queryString->filter('field[]', 'b');

Sort

Sorting the query string will use the JSON API sort syntax. At the moment only single sorts are supported.

# / > /?sort=field > /?sort=-field > /?sort=field

$queryString->sort('field');
$queryString->sort('field');
$queryString->sort('field');

Pagination

There's built-in support for pagination:

$queryString->page(10); # /?page=10
$queryString->nextPage(); # /?page=11
$queryString->previousPage(); # /?page=9
$queryString->resetPage(); # /?

$queryString->isCurrentPage(1); # true

Note that changing any other value on the query string, will reset the page too.

Other useful methods

Base URL

Casting a QueryString to a string will generate the URL. You can choose to use a different base URL like so:

$queryString->withBaseUrl('https://other.url');

Clear a parameter

# /?toggle > /

$queryString->clear('toggle');
# /?single=b > /

$queryString->clear('single');
# /?multi[]=a&multi[]=b > /

$queryString->clear('multi[]');

Active parameter or not

# /?multi[]=a

$queryString->isActive('multi[]'); # true
$queryString->isActive('multi[]', 'a'); # true
$queryString->isActive('multi[]', 'b'); # false
# /?single=a

$queryString->isActive('single'); # true
$queryString->isActive('single', 'a'); # true
$queryString->isActive('single', 'b'); # false
# /?toggle

$queryString->isActive('toggle'); # true

Laravel support

A separate Laravel package will be added in the future. The Laravel package will use this one under the hood and implement the JSON API spec.

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Postcardware

You're free to use this package, but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Kruikstraat 22, 2018 Antwerp, Belgium.

We publish all received postcards on our company website.

Credits

License

The MIT License (MIT). Please see License File for more information.