Parsowanie i składanie adresów URL

Klasy Url, UrlImmutable i UrlScript ułatwiają generowanie, przetwarzanie i manipulowanie adresami URL.

Url

Klasa Nette\Http\Url ułatwia pracę z adresem URL i jego poszczególnymi składnikami, jak pokazano na tym schemacie:

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

Generowanie adresów URL jest intuicyjne:

use Nette\Http\Url;

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

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

Możesz również parsować adres URL i manipulować nim dalej:

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

Aby zwrócić lub zmienić poszczególne składniki adresu URL, dostępne są następujące metody:

Setter	Getter	Wartość zwrotna
`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`
	`getDefaultPort(): ?int`	`80`
`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`	pełny adres URL

Ostrzeżenie: Podczas pracy z adresem URL uzyskanym z żądania HTTP należy pamiętać, że nie będzie on zawierał fragmentu, ponieważ przeglądarka nie wysyła go do serwera.

Możemy również pracować z poszczególnymi parametrami zapytania za pomocą:

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

Metoda getDomain(int $level = 2) zwraca prawą lub lewą część hosta. Działa to, jeśli host jest 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)`	`''`

Klasa Url implementuje interfejs JsonSerializable i posiada metodę __toString(), dzięki czemu obiekt może zostać zrzucony lub wykorzystany w danych przekazywanych do json_encode().

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

Metoda isEqual(string|Url $anotherUrl): bool sprawdza, czy dwa adresy URL są takie same.

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

UrlImmutable

Klasa Nette\Http\UrlImmutable jest niezmienną (immutowalną) alternatywą dla klasy Url (podobnie jak DateTimeImmutable jest niezmienną alternatywą dla DateTime w PHP ). Zamiast setterów posiada withery, które nie modyfikują obiektu, ale zwracają nowe instancje ze zmodyfikowaną wartością:

use Nette\Http\UrlImmutable;

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

$newUrl = $url
	->withUser('')
	->withPassword('')
	->withPath('/en/');

echo $newUrl; // 'http://nette.org:8080/en/?name=param#footer'

Metody służą do zwracania lub zmiany poszczególnych elementów adresu URL:

Wither	Getter	Wartość zwrotna
`withScheme(string $scheme)`	`getScheme(): string`	`'http'`
`withUser(string $user)`	`getUser(): string`	`'john'`
`withPassword(string $password)`	`getPassword(): string`	`'xyz*12'`
`withHost(string $host)`	`getHost(): string`	`'nette.org'`
`withPort(int $port)`	`getPort(): ?int`	`8080`
	`getDefaultPort(): ?int`	`80`
`withPath(string $path)`	`getPath(): string`	`'/en/download'`
`withQuery(string\|array $query)`	`getQuery(): string`	`'name=param'`
`withFragment(string $fragment)`	`getFragment(): string`	`'footer'`
	`getAuthority(): string`	`'nette.org:8080'`
	`getHostUrl(): string`	`'http://nette.org:8080'`
	`getAbsoluteUrl(): string`	pełny adres URL

Możemy również pracować z poszczególnymi parametrami zapytania za pomocą:

Wither	Getter
`withQuery(string\|array $query)`	`getQueryParameters(): array`
`withQueryParameter(string $name, $val)`	`getQueryParameter(string $name)`

Metoda getDomain(int $level = 2) działa tak samo jak jej imienniczka klasa Url. Metoda withoutUserInfo() usuwa user i password.

Klasa UrlImmutable implementuje interfejs JsonSerializable i posiada metodę __toString(), dzięki czemu obiekt może zostać zrzucony lub wykorzystany w danych przekazywanych do json_encode().

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

Metoda isEqual(string|Url $anotherUrl): bool sprawdza, czy dwa adresy URL są takie same.

UrlScript

Klasa Nette\Http\UrlScript jest potomkiem klasy UrlImmutable i dodatkowo wyróżnia następujące inne logiczne części adresu URL:

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

Udostępniane są metody pozwalające na zwrócenie części adresu URL:

Getter	Wartość zwrotna
`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/'`

Nie tworzymy bezpośrednio obiektów UrlScript, ale jest on zwracany przez metodę Nette\Http\Request::getUrl().