Parses and generates URLs based on URL parts. In favor of performance, URL parts are not validated.
Expanded class hierarchy of Url
class Url {
protected $scheme;
protected $host;
protected $port;
protected $username;
protected $password;
protected $path = '/';
protected $fragment;
/**
* @var QueryString Query part of the URL
*/
protected $query;
/**
* Factory method to create a new URL from a URL string
*
* @param string $url Full URL used to create a Url object
*
* @return Url
*/
public static function factory($url) {
$parts = ParserRegistry::getInstance()
->getParser('url')
->parseUrl($url);
// Convert the query string into a QueryString object
if ($parts['query']) {
$parts['query'] = QueryString::fromString($parts['query']);
}
return new self($parts['scheme'], $parts['host'], $parts['user'], $parts['pass'], $parts['port'], $parts['path'], $parts['query'], $parts['fragment']);
}
/**
* Build a URL from parse_url parts. The generated URL will be a relative URL if a scheme or host are not provided.
*
* @param array $parts Array of parse_url parts
*
* @return string
*/
public static function buildUrl(array $parts) {
$url = $scheme = '';
if (isset($parts['scheme'])) {
$scheme = $parts['scheme'];
$url .= $scheme . '://';
}
if (isset($parts['host'])) {
if (isset($parts['user'])) {
$url .= $parts['user'];
if (isset($parts['pass'])) {
$url .= ':' . $parts['pass'];
}
$url .= '@';
}
$url .= $parts['host'];
// Only include the port if it is not the default port of the scheme
if (isset($parts['port']) && !($scheme == 'http' && $parts['port'] == 80 || $scheme == 'https' && $parts['port'] == 443)) {
$url .= ':' . $parts['port'];
}
}
if (empty($parts['path'])) {
$url .= '/';
}
else {
if ($parts['path'][0] != '/') {
$url .= '/';
}
$url .= $parts['path'];
}
// Add the query string if present
if (!empty($parts['query'])) {
if ($parts['query'][0] != '?') {
$url .= array_key_exists('query_prefix', $parts) ? $parts['query_prefix'] : '?';
}
$url .= $parts['query'];
}
// Ensure that # is only added to the url if fragment contains anything.
if (isset($parts['fragment']) && !empty($parts['fragment'])) {
$url .= '#' . $parts['fragment'];
}
return $url;
}
/**
* Create a new URL from URL parts
*
* @param string $scheme Scheme of the URL
* @param string $host Host of the URL
* @param string $username Username of the URL
* @param string $password Password of the URL
* @param int $port Port of the URL
* @param string $path Path of the URL
* @param QueryString|array|string $query Query string of the URL
* @param string $fragment Fragment of the URL
*/
public function __construct($scheme, $host, $username = null, $password = null, $port = null, $path = null, QueryString $query = null, $fragment = null) {
$this->scheme = $scheme;
$this->host = $host;
$this->port = $port;
$this->username = $username;
$this->password = $password;
$this->fragment = $fragment;
$this
->setQuery($query ?: new QueryString());
if ($path) {
$this
->setPath($path);
}
}
/**
* Clone the URL
*/
public function __clone() {
$this->query = clone $this->query;
}
/**
* Returns the URL as a URL string
*
* @return string
*/
public function __toString() {
return self::buildUrl($this
->getParts());
}
/**
* Get the parts of the URL as an array
*
* @return array
*/
public function getParts() {
return array(
'scheme' => $this->scheme,
'user' => $this->username,
'pass' => $this->password,
'host' => $this->host,
'port' => $this->port,
'path' => $this
->getPath(),
'query' => (string) $this->query,
'fragment' => $this->fragment,
'query_prefix' => $this->query
->getPrefix(),
);
}
/**
* Set the host of the request.
*
* @param string $host Host to set (e.g. www.yahoo.com, yahoo.com)
*
* @return Url
*/
public function setHost($host) {
if (strpos($host, ':') === false) {
$this->host = $host;
}
else {
list($host, $port) = explode(':', $host);
$this->host = $host;
$this
->setPort($port);
}
return $this;
}
/**
* Get the host part of the URL
*
* @return string
*/
public function getHost() {
return $this->host;
}
/**
* Set the scheme part of the URL (http, https, ftp, etc)
*
* @param string $scheme Scheme to set
*
* @return Url
*/
public function setScheme($scheme) {
$this->scheme = $scheme;
return $this;
}
/**
* Get the scheme part of the URL
*
* @return string
*/
public function getScheme() {
return $this->scheme;
}
/**
* Set the port part of the URL
*
* @param int $port Port to set
*
* @return Url
*/
public function setPort($port) {
$this->port = $port;
return $this;
}
/**
* Get the port part of the URl. Will return the default port for a given scheme if no port has been set.
*
* @return int|null
*/
public function getPort() {
if ($this->port) {
return $this->port;
}
elseif ($this->scheme == 'http') {
return 80;
}
elseif ($this->scheme == 'https') {
return 443;
}
return null;
}
/**
* Set the path part of the URL
*
* @param array|string $path Path string or array of path segments
*
* @return Url
*/
public function setPath($path) {
if (is_array($path)) {
$this->path = '/' . implode('/', $path);
}
else {
if (substr($path, 0, 1) != '/' && $path != '*') {
$path = '/' . $path;
}
$this->path = $path;
}
return $this;
}
/**
* Normalize the URL so that double slashes and relative paths are removed
*
* @return Url
*/
public function normalizePath() {
if ($this->path == '*') {
return $this;
}
if ($this->path && $this->path != '/') {
// Replace // and /./ with /
$this->path = str_replace(array(
'/./',
'//',
), '/', $this->path);
// Remove trailing relative paths if possible
$segments = $this
->getPathSegments();
$last = end($segments);
$trailingSlash = false;
if ($last === '') {
array_pop($segments);
$trailingSlash = true;
}
while ($last == '..' || $last == '.') {
if ($last == '..') {
array_pop($segments);
$last = array_pop($segments);
}
if ($last == '.' || $last == '') {
$last = array_pop($segments);
}
}
$this->path = implode('/', $segments);
if ($trailingSlash) {
$this->path .= '/';
}
}
// Must always start with a slash
if (substr($this->path, 0, 1) != '/') {
$this->path = '/' . $this->path;
}
return $this;
}
/**
* Add a relative path to the currently set path
*
* @param string $relativePath Relative path to add
*
* @return Url
*/
public function addPath($relativePath) {
if (!$relativePath || $relativePath == '/') {
return $this;
}
// Add a leading slash if needed
if ($relativePath[0] != '/') {
$relativePath = '/' . $relativePath;
}
return $this
->setPath(str_replace('//', '/', $this
->getPath() . $relativePath));
}
/**
* Get the path part of the URL
*
* @return string
*/
public function getPath() {
return $this->path ?: '/';
}
/**
* Get the path segments of the URL as an array
*
* @return array
*/
public function getPathSegments() {
return array_slice(explode('/', $this
->getPath()), 1);
}
/**
* Set the password part of the URL
*
* @param string $password Password to set
*
* @return Url
*/
public function setPassword($password) {
$this->password = $password;
return $this;
}
/**
* Get the password part of the URL
*
* @return null|string
*/
public function getPassword() {
return $this->password;
}
/**
* Set the username part of the URL
*
* @param string $username Username to set
*
* @return Url
*/
public function setUsername($username) {
$this->username = $username;
return $this;
}
/**
* Get the username part of the URl
*
* @return null|string
*/
public function getUsername() {
return $this->username;
}
/**
* Get the query part of the URL as a QueryString object
*
* @return QueryString
*/
public function getQuery() {
return $this->query;
}
/**
* Set the query part of the URL
*
* @param QueryString|string|array $query Query to set
*
* @return Url
*/
public function setQuery($query) {
if (is_string($query)) {
$output = null;
parse_str($query, $output);
$this->query = new QueryString($output);
}
elseif (is_array($query)) {
$this->query = new QueryString($query);
}
elseif ($query instanceof QueryString) {
$this->query = $query;
}
return $this;
}
/**
* Get the fragment part of the URL
*
* @return null|string
*/
public function getFragment() {
return $this->fragment;
}
/**
* Set the fragment part of the URL
*
* @param string $fragment Fragment to set
*
* @return Url
*/
public function setFragment($fragment) {
$this->fragment = $fragment;
return $this;
}
/**
* Check if this is an absolute URL
*
* @return bool
*/
public function isAbsolute() {
return $this->scheme && $this->host;
}
/**
* Combine the URL with another URL. Parts specified in the passed URL will supersede parts in the current URL.
*
* @param string $url Relative URL to combine with
*
* @return Url
* @throws InvalidArgumentException
*/
public function combine($url) {
$absolutePath = $url[0] == '/';
$url = self::factory($url);
if ($buffer = $url
->getScheme()) {
$this->scheme = $buffer;
}
if ($buffer = $url
->getHost()) {
$this->host = $buffer;
}
if ($buffer = $url
->getPort()) {
$this->port = $buffer;
}
if ($buffer = $url
->getUsername()) {
$this->username = $buffer;
}
if ($buffer = $url
->getPassword()) {
$this->password = $buffer;
}
if ($buffer = $url
->getFragment()) {
$this->fragment = $buffer;
}
if ($absolutePath) {
// Replace the current URL and query if set
if ($buffer = $url
->getPath()) {
$this->path = $buffer;
}
if (count($url
->getQuery())) {
$this->query = clone $url
->getQuery();
}
}
else {
// Append to the current path and query string
if ($buffer = $url
->getPath()) {
$this
->addPath($buffer);
}
if ($buffer = $url
->getQuery()) {
$this->query
->merge($buffer);
}
}
return $this;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
protected | property | ||
Url:: |
public | function | Add a relative path to the currently set path | |
Url:: |
public static | function | Build a URL from parse_url parts. The generated URL will be a relative URL if a scheme or host are not provided. | |
Url:: |
public | function | Combine the URL with another URL. Parts specified in the passed URL will supersede parts in the current URL. | |
Url:: |
public static | function | Factory method to create a new URL from a URL string | |
Url:: |
public | function | Get the fragment part of the URL | |
Url:: |
public | function | Get the host part of the URL | |
Url:: |
public | function | Get the parts of the URL as an array | |
Url:: |
public | function | Get the password part of the URL | |
Url:: |
public | function | Get the path part of the URL | |
Url:: |
public | function | Get the path segments of the URL as an array | |
Url:: |
public | function | Get the port part of the URl. Will return the default port for a given scheme if no port has been set. | |
Url:: |
public | function | Get the query part of the URL as a QueryString object | |
Url:: |
public | function | Get the scheme part of the URL | |
Url:: |
public | function | Get the username part of the URl | |
Url:: |
public | function | Check if this is an absolute URL | |
Url:: |
public | function | Normalize the URL so that double slashes and relative paths are removed | |
Url:: |
public | function | Set the fragment part of the URL | |
Url:: |
public | function | Set the host of the request. | |
Url:: |
public | function | Set the password part of the URL | |
Url:: |
public | function | Set the path part of the URL | |
Url:: |
public | function | Set the port part of the URL | |
Url:: |
public | function | Set the query part of the URL | |
Url:: |
public | function | Set the scheme part of the URL (http, https, ftp, etc) | |
Url:: |
public | function | Set the username part of the URL | |
Url:: |
public | function | Clone the URL | |
Url:: |
public | function | Create a new URL from URL parts | |
Url:: |
public | function | Returns the URL as a URL string |