URI
The Uri package provides simple and intuitive classes to manage URIs in PHP. You will be able to
- parse, build and resolve URIs
- create URIs from different sources (string, PHP environment, base URI, URI template, ...);
- handle internalisation;
- infer properties and features from URIs;
<?php
use League\Uri\UriTemplate;
$template = 'https://api.twitter.com:443/{version}/search/{term:1}/{term}/{?q*,limit}#title';
$defaultVariables = ['version' => '1.1'];
$params = [
'term' => 'john',
'q' => ['a', 'b'],
'limit' => '10',
];
$uriTemplate = new UriTemplate($template, $defaultVariables);
$uri = $uriTemplate->expand($params);
// $uri is a League\Uri\Uri object
echo $uri->getScheme(); //displays "https"
echo $uri->getAuthority(); //displays "api.twitter.com:443"
echo $uri->getPath(); //displays "/1.1/search/j/john/"
echo $uri->getQuery(); //displays "q=a&q=b&limit=10"
echo $uri->getFragment(); //displays "title"
echo $uri;
//displays "https://api.twitter.com:443/1.1/search/j/john/?q=a&q=b&limit=10#title"
echo json_encode($uri);
//displays "https:\/\/api.twitter.com:443\/1.1\/search\/j\/john\/?q=a&q=b&limit=10#title"
Highlights
- Simple API
- RFC3986, RFC3987 and RFC6570 compliant
- Implements the
UriInterfacefrom PSR-7 - Fully documented
- Framework Agnostic
System Requirements
- You require PHP >= 7.2 but the latest stable version of PHP is recommended
- You will need the ext-intl to handle i18n URI.
- Since version 6.2.0 you will need the ext-fileinfo to handle Data URI creation from a filepath.
Dependencies
In order to handle IDN host you are required to also install the intl extension otherwise an exception will be thrown when attempting to validate such host.
In order to create Data URI from a filepath, since version 6.2, you are required to also install the fileinfo extension otherwise an exception will be thrown.
Installation
$ composer require league/uri
Documentation
Full documentation can be found at uri.thephpleague.com.
Contributing
Contributions are welcome and will be fully credited. Please see CONTRIBUTING and CONDUCT for details.
Testing
The library has a :
- a PHPUnit test suite
- a coding style compliance test suite using PHP CS Fixer.
- a code analysis compliance test suite using PHPStan.
To run the tests, run the following command from the project folder.
$ composer test
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
Attribution
The UriTemplate class is adapted from the Guzzle 6 project.
License
The MIT License (MIT). Please see License File for more information.
![[docs] Update Parsing, Building & Normalizing URIs](https://avatars.githubusercontent.com/u/1427081?v=4)
The left shows the original object (that has been serialized to JSON) and the right one shows the deserialized object (from JSON).
216 Oct 18, 2022
351 Dec 30, 2022
31 Nov 18, 2022
430 Jan 5, 2023
4.3k Jan 6, 2023
68 Sep 20, 2022
2.5k Jan 3, 2023
51 Nov 16, 2021
908 Dec 21, 2022
1.6k Dec 30, 2022
2 Nov 20, 2021
4.3k Dec 29, 2022
985 Dec 4, 2022
837 Dec 21, 2022