uri-template/uri-template

RFC 6570 URI Template processor

UriTemplate

PHP RFC 6570 URI Template processor, _(*1)

Installation

If you use Composer, just run, _(*2)

composer require uri-template/uri-template

or add this to your composer.json, _(*3)

"uri-template/uri-template": "~1.0"

If you do not use composer, just copy the files into your project's lib folder., _(*4)

Reqirements

UriTemplate requires PHP 5.3 or greater, _(*5)

Examples

<?php
use UriTemplate\Processor;
$url = new Processor('http://github.com{/project}', array(
    'project' => array('mcrumley', 'uritemplate')
));
echo $url->process();
// prints http://github.com/mcrumley/uritemplate

// or
$url = new Processor();
$url->setTemplate('http://github.com{/project}');
$url->setData(array('project' => array('mcrumley', 'uritemplate')));
echo $url->process();
// prints http://github.com/mcrumley/uritemplate

Static Class

There is also a static class that does processes templates without creating an object., _(*6)

<?php
use UriTemplate\UriTemplate;
echo UriTemplate::expand('http://github.com{/project}', array(
    'project' => array('mcrumley', 'uritemplate')
));
// prints http://github.com/mcrumley/uritemplate

The static class has additional methods for getting information about the template, _(*7)

echo implode(', ', (UriTemplate::getVariables('http://{.url}{/project}')));
// prints url, project

$templateErrors = UriTemplate::getErrors('http://{.url:error}{=project}'));
echo implode(', ', $templateErrors);
// prints Malformed varspec: ".url:error", Malformed varspec: "=project"

Tests

Each version is tested against all samples available at https://github.com/uri-templates/uritemplate-test., _(*8)

License

© Michael Crumley, _(*9)

MIT licensed. For the full copyright and license information, please view the LICENSE file distributed with the source code., _(*10)