Praca z adresami URL

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

→ Instalacja i wymagania

Url

Klasa Nette\Http\Url pozwala łatwo manipulować adresami URL i ich poszczególnymi składowymi, jak pokazuje ten diagram:

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

Generowanie URL-i 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'

URL możesz też sparsować, a następnie nim manipulować:

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

Klasa Url implementuje interfejs JsonSerializable i ma metodę __toString(), więc obiekt można wypisać albo użyć w danych przekazywanych do json_encode().

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

Składowe URL

Do odczytu albo zmiany poszczególnych składowych URL służą poniższe metody:

Metody getUser(), getPassword(), setUser() i setPassword() są przestarzałe, bo osadzanie danych uwierzytelniających bezpośrednio w URL jest odradzane.

Uwaga: przy pracy z URL uzyskanym z żądania HTTP pamiętaj, że nie będzie zawierał fragmentu, bo przeglądarka nie wysyła go na serwer.

Z poszczególnymi parametrami query możemy pracować za pomocą:

getDomain (int $level = 2): string

Zwraca prawą albo lewą część hosta. Oto jak to działa, jeśli hostem jest www.nette.org:

isEqual (string|Url $url): bool

Sprawdza, czy dwa URL-e są identyczne.

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

canonicalize()

Konwertuje URL do postaci kanonicznej. Zamienia nazwę hosta na małe litery i normalizuje ścieżkę (percent-encoding i usunięcie zbędnych znaków). Query string pozostaje niezmieniony.

Url::isAbsolute (string $url): bool

Sprawdza, czy URL jest absolutny. URL uznaje się za absolutny, jeśli zaczyna się schematem (np. http, https, ftp), po którym następuje dwukropek.

Url::isAbsolute('https://nette.org');    // true
Url::isAbsolute('//nette.org');          // false

Url::removeDotSegments (string $path): string

Normalizuje ścieżkę URL, usuwając specjalne segmenty . i ... Metoda usuwa zbędne elementy ścieżki tak samo, jak robią to przeglądarki.

Url::removeDotSegments('/path/../subtree/./file.txt');  // '/subtree/file.txt'
Url::removeDotSegments('/../foo/./bar');                // '/foo/bar'
Url::removeDotSegments('./today/../file.txt');          // 'file.txt'

UrlImmutable

Klasa Nette\Http\UrlImmutable to niezmienna alternatywa dla klasy Url (podobnie jak DateTimeImmutable jest w PHP niezmienną alternatywą dla DateTime). Zamiast setterów ma “withery”, które nie zmieniają obiektu, tylko zwracają nowe instancje ze zmienioną wartością:

use Nette\Http\UrlImmutable;

$url = new UrlImmutable(
	'https://nette.org:8080/en/download?name=param#footer',
);

$newUrl = $url
	->withHost('example.com')
	->withPath('/en/')
	->withQueryParameter('name', 'value');

echo $newUrl; // 'https://example.com:8080/en/?name=value#footer'

Klasa UrlImmutable implementuje interfejs JsonSerializable i ma metodę __toString(), więc obiekt można wypisać albo użyć w danych przekazywanych do json_encode().

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

Składowe URL

Do odczytu albo zmiany poszczególnych składowych URL służą poniższe metody:

Metody getUser(), getPassword(), withUser(), withPassword() i withoutUserInfo() są przestarzałe, bo osadzanie danych uwierzytelniających bezpośrednio w URL jest odradzane.

Z poszczególnymi parametrami query możemy pracować za pomocą:

getDomain (int $level = 2): string

Zwraca prawą albo lewą część hosta. Oto jak to działa, jeśli hostem jest www.nette.org:

resolve (string $reference): UrlImmutable

Rozwiązuje absolutny URL tak samo, jak przeglądarka przetwarza odnośniki na stronie HTML:

• jeśli odnośnik jest absolutnym URL (zawiera schemat), używany jest bez zmian
• jeśli odnośnik zaczyna się od //, przejmowany jest tylko schemat z bieżącego URL
• jeśli odnośnik zaczyna się od /, tworzona jest absolutna ścieżka od korzenia domeny
• w pozostałych przypadkach URL składany jest względem bieżącej ścieżki

$url = new UrlImmutable('https://example.com/path/page');
echo $url->resolve('../foo');           // 'https://example.com/foo'
echo $url->resolve('/bar');             // 'https://example.com/bar'
echo $url->resolve('sub/page.html');    // 'https://example.com/path/sub/page.html'

isEqual (string|Url $url): bool

Sprawdza, czy dwa URL-e są identyczne.

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

UrlScript

Klasa Nette\Http\UrlScript to potomek UrlImmutable rozszerzający ją o kolejne wirtualne składowe URL, jak katalog główny projektu itd. Podobnie jak klasa nadrzędna jest obiektem niezmiennym.

Poniższy diagram pokazuje składowe, które UrlScript rozpoznaje:

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

• baseUrl to bazowy URL aplikacji wraz z domeną i częścią ścieżki do katalogu głównego aplikacji
• basePath to część ścieżki do katalogu głównego aplikacji
• scriptPath to ścieżka do bieżącego skryptu
• relativePath to nazwa skryptu (i ewentualnie kolejne segmenty ścieżki) względem basePath
• relativeUrl to cała część URL za baseUrl wraz z query stringiem i fragmentem
• pathInfo to dziś rzadko używana część URL za nazwą skryptu

Do odczytu tych części URL służą poniższe metody:

Obiektów UrlScript zwykle nie tworzymy bezpośrednio; zamiast tego zwraca go metoda Nette\Http\Request::getUrl() z już poprawnie ustawionymi składowymi dla bieżącego żądania HTTP.