A PHP library for generating RFC 3986 compliant uniform resource identifiers (URI).
This library has the following requirements:
- PHP 5.6+
Install Composer in your project:
$ curl -s https://getcomposer.org/installer | phpRequire the package via Composer:
$ php composer.phar require gravitymedia/uriThis example illustrates te basic usage of an URI object.
// require autoloader
require 'vendor/autoload.php';
// import classes
use GravityMedia\Uri\Uri;
// create URI object from string
$uri = Uri::fromString('http://username:password@example.com:8080/this/is/a/path?argument=value#my_fragment');
// dump scheme
var_dump($uri->getScheme()); // string(4) "http"
// dump authority
var_dump($uri->getAuthority()); // string(29) "username:password@example.com"
// dump user info
var_dump($uri->getUserInfo()); // string(17) "username:password"
// dump host
var_dump($uri->getHost()); // string(11) "example.com"
// dump port
var_dump($uri->getPort()); // int(8080)
// dump path
var_dump($uri->getPath()); // string(15) "/this/is/a/path"
// dump argument
var_dump($uri->getQuery()); // string(14) "argument=value"
// dump fragment
var_dump($uri->getFragment()); // string(11) "my_fragment"
// remove path and remove fragment
$uri = $uri->withPath('')->withFragment('');
// dump URI
var_dump($uri->toString()); // string(56) "http://username:password@example.com:8080?argument=value"The URI also supports URN syntax.
// require autoloader
require 'vendor/autoload.php';
// import classes
use GravityMedia\Uri\Uri;
// create URI object from string
$uri = Uri::fromString('urn:example:animal:ferret:nose');
// dump scheme
var_dump($uri->getScheme()); // string(3) "urn"
// dump path
var_dump($uri->getPath()); // string(26) "example:animal:ferret:nose"Use the SchemeRegistry to support additional schemes and normalize the the URI string.
// require autoloader
require 'vendor/autoload.php';
// import classes
use GravityMedia\Uri\SchemeRegistry;
use GravityMedia\Uri\Uri;
// register SSH scheme
SchemeRegistry::registerSchemes([
'ssh' => 22,
]);
// create URI object from string
$uri = Uri::fromString('ssh://git@github.com:22/GravityMedia/Uri.git');
// dump normalized URI
var_dump($uri->toString()); // string(41) "ssh://git@github.com/GravityMedia/Uri.git"The AbstractQuery class allows to define and manipulate the query string.
// require autoloader
require 'vendor/autoload.php';
// import classes
use GravityMedia\Uri\AbstractQuery;
use GravityMedia\Uri\Uri;
/**
* My query class.
*/
class MyQuery extends AbstractQuery
{
/**
* The argument.
*
* @var mixed
*/
protected $argument;
/**
* Get argument.
*
* @return mixed
*/
public function getArgument()
{
return $this->argument;
}
/**
* Set argument.
*
* @param mixed $argument
*
* @return $this
*/
public function setArgument($argument)
{
$this->argument = $argument;
return $this;
}
}
// create URI object from string
$uri = Uri::fromString('http://example.com?argument=value');
// create my query object from string
$query = MyQuery::fromString($uri->getQuery());
// dump array representation of query
var_dump($query->toArray()); // array(1) { ["argument"]=> string(5) "value" }
// update query argument value
var_dump($query->setArgument('new value')->toString()); // string(18) "argument=new+value"
// change query
$uri = $uri->withQuery($query->toString());
// dump URI
var_dump($uri->toString()); // string(37) "http://example.com?argument=new+value"