URI parser and builder
PHP has been relying on the parse_url
function to split URI into its component. But the
function predates RFC3986 and as such does not fully comply to the specification. To work
around this limitation the tooklit provides the League\Uri\UriString
class. It is a
user-land PHP URI parser and builder compliant with RFC 3986 and RFC 3987
The class act as a drop-in replacement for PHP’s parse_url
feature.
URI parsing
UriString::parse(string $uri): array
UriString::parseAuthority(string $autority): array
The parser is:
- RFC3986/RFC3987 compliant;
- returns all URI components (No extra parameters needed);
- the path component is never equal to
null
; - makes a distinction between empty and undefined components;
- the parser throws a
League\Uri\Contracts\UriException
exception instead of returningfalse
on error;
<?php
use League\Uri\UriString;
var_export(UriString::parse('http://foo.com?@bar.com/#'));
//returns the following array
//array(
// 'scheme' => 'http',
// 'user' => null,
// 'pass' => null,
// 'host' => 'foo.com',
// 'port' => null,
// 'path' => '',
// 'query' => '@bar.com/',
// 'fragment' => '',
//);
var_export(UriString::parse('http:www.example.com'));
//returns the following array
//array(
// 'scheme' => 'http',
// 'user' => null,
// 'pass' => null,
// 'host' => null,
// 'port' => null,
// 'path' => 'www.example.com',
// 'query' => null,
// 'fragment' => null,
//);
URI Building
UriString::build(array $components): string
UriString::buildAuthority(array $components): string
UriString::buildUri(?string $scheme, ?string $authority, string $path, ?string $query, ?string $fragment): string
You can rebuild a URI from its hash representation returned by the UriString::parse
method or PHP’s parse_url
function using the UriString::build
public static method.
$components = UriString::parse('http://hello:world@foo.com?@bar.com/');
//returns the following array
//array(
// 'scheme' => 'http',
// 'user' => 'hello',
// 'pass' => 'world',
// 'host' => 'foo.com',
// 'port' => null,
// 'path' => '',
// 'query' => '@bar.com/',
// 'fragment' => null,
//);
echo UriString::build($components); //displays http://hello:world@foo.com?@bar.com/
The build
method provides similar functionality to the http_build_url()
function from v1.x of the pecl_http
PECL extension.