Stars: 156
Forks: 9
Pull Requests: 11
Issues: 9
Watchers: 9
Last Updated: 2022-12-11 17:12:11
Work with query strings
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.
You can install the package via composer:
composer require spatie/query-string
use Spatie\QueryString\QueryString;
$queryString = new QueryString($uri);
# / > /?toggle
$queryString->toggle('toggle');
# / > /?single=a
$queryString->toggle('single', 'a');
# /?single=a > /?single=b
$queryString->toggle('single', 'b');
# /?single=a > /?
$queryString->toggle('single', 'a');
# / > /?multi[]=a&multi[]=b
$queryString->toggle('multi[]', 'a');
$queryString->toggle('multi[]', 'b');
# /?multi[]=a&multi[]=b > /?multi[]=a
$queryString->toggle('multi[]', 'b');
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');
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');
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.
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');
# /?toggle > /
$queryString->clear('toggle');
# /?single=b > /
$queryString->clear('single');
# /?multi[]=a&multi[]=b > /
$queryString->clear('multi[]');
# /?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
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.
composer test
Please see CHANGELOG for more information on what has changed recently.
Please see CONTRIBUTING for details.
If you've found a bug regarding security please mail [email protected] instead of using the issue tracker.
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.
The MIT License (MIT). Please see License File for more information.