Parsování a skládání URL

Třídy Url a UrlScript umožňují snadné generování, parsování a manipulaci s URL.

Instalace:

composer require nette/http

Url

Třída Nette\Http\Url umožňuje snadno pracovat s URL a jednotlivými jeho komponentami, které zachycuje tento nákres:

scheme  user  password  host   port    path        query  fragment
  |      |      |        |      |       |            |       |
/--\   /--\ /------\ /-------\ /--\/----------\ /--------\ /----\
http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer
\______\__________________________/
    |               |
 hostUrl        authority

Generování URL je intuitivní:

use Nette\Http\Url;

$url = new Url;
$url->setScheme('https')
	->setHost('localhost')
	->setPath('/edit')
	->setQueryParameter('foo', 'bar');

echo $url; // 'https://localhost/edit?foo=bar'

Lze také URL naparsovat a dále s ním manipulovat:

$url = new Url(
	'http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer'
);

Pro vrácení nebo změnu jednotlivých komponent URL jsou vám k dispozici tyto metody:

Setter	Getter	Vrácená hodnota
setScheme(string $scheme)	getScheme(): string	'http'
setUser(string $user)	getUser(): string	'john'
setPassword(string $password)	getPassword(): string	'xyz*12'
setHost(string $host)	getHost(): string	'nette.org'
setPort(int $port)	getPort(): ?int	8080
setPath(string $path)	getPath(): string	'/en/download'
setQuery(string|array $query)	getQuery(): string	'name=param'
setFragment(string $fragment)	getFragment(): string	'footer'
	getAuthority(): string	'nette.org:8080'
	getHostUrl(): string	'http://nette.org:8080'
	getAbsoluteUrl(): string	celá URL

Můžeme pracovat i s jednotlivými query parametry pomocí:

Setter	Getter
setQuery(string|array $query)	getQueryParameters(): array
setQueryParameter(string $name, $val)	getQueryParameter(string $name)

Metoda getDomain(int $level = 2) vrací pravou či levou část hostitele. Takto funguje, pokud host je www.nette.org:

getDomain(1)	'org'
getDomain(2)	'nette.org'
getDomain(3)	'www.nette.org'
getDomain(0)	'www.nette.org'
getDomain(-1)	'www.nette'
getDomain(-2)	'www'
getDomain(-3)	''

Třída Url implementuje rozhraní JsonSerializable a má metodu __toString(), takže objekt lze vypsat nebo použít v datech předávaných do json_encode().

echo $url;
echo json_encode([$url]);

Metoda isEqual(string|Url $anotherUrl): bool ověří, zda jsou dvě URL shodné.

$url->isEqual('https://nette.org');

UrlScript

Třída Nette\Http\UrlScript je potomkem Url a navíc rozlišuje tyto další logické části URL:

     baseUrl    basePath  relativePath  relativeUrl
        |          |        |               |
/---------------/-----\/--------\---------------------------\
http://nette.org/admin/script.php/pathinfo/?name=param#footer
                \_______________/\________/
                       |              |
                  scriptPath       pathInfo

Pro vrácení částí URL jsou k dispozici metody:

Getter	Vrácená hodnota
getScriptPath(): string	'/admin/script.php'
getBasePath(): string	'/admin/'
getBaseUrl(): string	'http://nette.org/admin/'
getRelativePath(): string	'script.php'
getRelativeUrl(): string	'script.php/pathinfo/?name=param#footer'
getPathInfo(): string	'/pathinfo/'

Objekty UrlScript přímo nevytváříme, ale vrací jej metoda Nette\Http\Request::getUrl().