Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/spatie/query-string
Manipulate query strings
https://github.com/spatie/query-string
http manipulate php query
Last synced: 3 days ago
JSON representation
Manipulate query strings
- Host: GitHub
- URL: https://github.com/spatie/query-string
- Owner: spatie
- License: mit
- Created: 2018-12-14T13:12:01.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-11T17:12:11.000Z (almost 2 years ago)
- Last Synced: 2024-05-09T22:22:04.898Z (6 months ago)
- Topics: http, manipulate, php, query
- Language: PHP
- Homepage: https://spatie.be/open-source
- Size: 65.4 KB
- Stars: 159
- Watchers: 9
- Forks: 10
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE.md
Awesome Lists containing this project
README
[
](https://supportukrainenow.org)
# QueryString
[](https://packagist.org/packages/spatie/query-string)
[](https://packagist.org/packages/spatie/query-string)
Work with query strings
## Support us
[
](https://spatie.be/github-ad-click/query-string)
We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).
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](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).
## Installation
You can install the package via composer:
```bash
composer require spatie/query-string
```
## Usage
``` php
use Spatie\QueryString\QueryString;
$queryString = new QueryString($uri);
```
### Toggle parameters
#### A single toggle
```php
# / > /?toggle
$queryString->toggle('toggle');
```
#### Toggle a value
```php
# / > /?single=a
$queryString->toggle('single', 'a');
```
```php
# /?single=a > /?single=b
$queryString->toggle('single', 'b');
```
```php
# /?single=a > /?
$queryString->toggle('single', 'a');
```
#### Toggle multiple values
```php
# / > /?multi[]=a&multi[]=b
$queryString->toggle('multi[]', 'a');
$queryString->toggle('multi[]', 'b');
```
```php
# /?multi[]=a&multi[]=b > /?multi[]=a
$queryString->toggle('multi[]', 'b');
```
### Filter
Filtering the query string will use the JSON API filter syntax.
```php
# / > /?filter[field]=a
$queryString->filter('field', 'a');
```
```php
# / > /?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.
```php
# / > /?sort=field > /?sort=-field > /?sort=field
$queryString->sort('field');
$queryString->sort('field');
$queryString->sort('field');
```
### Pagination
There's built-in support for pagination:
```php
$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:
```php
$queryString->withBaseUrl('https://other.url');
```
#### Clear a parameter
```php
# /?toggle > /
$queryString->clear('toggle');
```
```php
# /?single=b > /
$queryString->clear('single');
```
```php
# /?multi[]=a&multi[]=b > /
$queryString->clear('multi[]');
```
#### Active parameter or not
```php
# /?multi[]=a
$queryString->isActive('multi[]'); # true
$queryString->isActive('multi[]', 'a'); # true
$queryString->isActive('multi[]', 'b'); # false
```
```php
# /?single=a
$queryString->isActive('single'); # true
$queryString->isActive('single', 'a'); # true
$queryString->isActive('single', 'b'); # false
```
```php
# /?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
``` bash
composer test
```
### Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.
### Security
If you've found a bug regarding security please mail [[email protected]](mailto:[email protected]) 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](https://spatie.be/en/opensource/postcards).
## Credits
- [Brent Roose](https://github.com/brendt)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.