Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rize/UriTemplate
PHP URI Template (RFC 6570) supports both URI expansion & extraction
https://github.com/rize/UriTemplate
expansion extraction php rfc-6570 uri-template
Last synced: 28 days ago
JSON representation
PHP URI Template (RFC 6570) supports both URI expansion & extraction
- Host: GitHub
- URL: https://github.com/rize/UriTemplate
- Owner: rize
- License: mit
- Created: 2014-03-31T09:42:43.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-03-10T08:10:08.000Z (9 months ago)
- Last Synced: 2024-05-01T19:57:24.142Z (7 months ago)
- Topics: expansion, extraction, php, rfc-6570, uri-template
- Language: PHP
- Homepage:
- Size: 98.6 KB
- Stars: 397
- Watchers: 10
- Forks: 13
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# PHP URI Template
This is a URI Template implementation in PHP based on [RFC 6570 URI Template](http://tools.ietf.org/html/rfc6570). In addition to URI expansion, it also supports URI extraction (used by [Google Cloud Core](https://github.com/googleapis/google-cloud-php-core) and [Google Cloud Client Library](https://github.com/googleapis/google-cloud-php)).
 [](https://packagist.org/packages/rize/uri-template)
[](https://opencollective.com/rize-uri-template)
* [Node.js/Javascript](https://github.com/rezigned/uri-template.js) URI Template
## Usage
### Expansion
A very simple usage (string expansion).
```php
expand('/{username}/profile', ['username' => 'john']);
>> '/john/profile'
```
`Rize\UriTemplate` supports all `Expression Types` and `Levels` specified by RFC6570.
```php
expand('/search/{term:1}/{term}/{?q*,limit}', [
'term' => 'john',
'q' => ['a', 'b'],
'limit' => 10,
])
>> '/search/j/john/?q=a&q=b&limit=10'
```
#### `/` Path segment expansion
```php
expand('http://{host}{/segments*}/{file}{.extensions*}', [
'host' => 'www.host.com',
'segments' => ['path', 'to', 'a'],
'file' => 'file',
'extensions' => ['x', 'y'],
]);
>> 'http://www.host.com/path/to/a/file.x.y'
```
`Rize\UriTemplate` accepts `base-uri` as a 1st argument and `default params` as a 2nd argument. This is very useful when you're working with API endpoint.
Take a look at real world example.
```php
1.1]);
$uri->expand('/statuses/show/{id}.json', ['id' => '210462857140252672']);
>> https://api.twitter.com/1.1/statuses/show/210462857140252672.json
```
### Extraction
It also supports URI Extraction (extract all variables from URI). Let's take a look at the example.
```php
1.1]);
$params = $uri->extract('/search/{term:1}/{term}/{?q*,limit}', '/search/j/john/?q=a&q=b&limit=10');
>> print_r($params);
(
[term:1] => j
[term] => john
[q] => Array
(
[0] => a
[1] => b
)
[limit] => 10
)
```
Note that in the example above, result returned by `extract` method has an extra keys named `term:1` for `prefix` modifier. This key was added just for our convenience to access prefix data.
#### `strict` mode
```php
extract($template, $uri, $strict = false)
```
Normally `extract` method will try to extract vars from a uri even if it's partially matched. For example
```php
extract('/{?a,b}', '/?a=1')
>> print_r($params);
(
[a] => 1
[b] => null
)
```
With `strict mode`, it will allow you to extract uri only when variables in template are fully matched with given uri.
Which is useful when you want to determine whether the given uri is matched against your template or not (in case you want to use it as routing service).
```php
extract('/{?a,b}', '/?a=1', true);
>>> null
// Now we give `b` some value
$params = $uri->extract('/{?a,b}', '/?a=1&b=2', true);
>>> print_r($params)
(
[a] => 1
[b] => 2
)
```
#### Array modifier `%`
By default, RFC 6570 only has 2 types of operators `:` and `*`. This `%` array operator was added to the library because current spec can't handle array style query e.g. `list[]=a` or `key[user]=john`.
Example usage for `%` modifier
```php
expand('{?list%,keys%}', [
'list' => [
'a', 'b',
),
'keys' => [
'a' => 1,
'b' => 2,
),
]);
// '?list[]=a&list[]=b&keys[a]=1&keys[b]=2'
>> '?list%5B%5D=a&list%5B%5D=b&keys%5Ba%5D=1&keys%5Bb%5D=2'
// [] get encoded to %5B%5D i.e. '?list[]=a&list[]=b&keys[a]=1&keys[b]=2'
$params = $uri->extract('{?list%,keys%}', '?list%5B%5D=a&list%5B%5D=b&keys%5Ba%5D=1&keys%5Bb%5D=2', )
>> print_r($params);
(
[list] => Array
(
[0] => a
[1] => b
)
[keys] => Array
(
[a] => 1
[b] => 2
)
)
```
## Installation
Using `composer`
```
{
"require": {
"rize/uri-template": "~0.3"
}
}
```
### Changelogs
* **0.2.0** Add a new modifier `%` which allows user to use `list[]=a&list[]=b` query pattern.
* **0.2.1** Add nested array support for `%` modifier
* **0.2.5** Add strict mode support for `extract` method
* **0.3.0** Improve code quality + RFC3986 support for `extract` method by @Maks3w
* **0.3.1** Improve `extract` method to parse two or more adjacent variables separated by dot by @corleonis
## Contributors
### Code Contributors
This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].
### Financial Contributors
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/rize-uri-template/contribute)]
#### Individuals
#### Organizations
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/rize-uri-template/contribute)]
