URL Parser e Builder

As classes Url, UrlImmutable e UrlScript facilitam o gerenciamento, a análise e a manipulação de URLs.

→ Instalação e requisitos

Url

A classe Nette\Http\Url facilita o trabalho com a URL e seus componentes individuais, que estão delineados neste diagrama:

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

A geração de URL é intuitiva:

use Nette\Http\Url;

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

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

Você também pode analisar a URL e depois manipulá-la:

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

Os seguintes métodos estão disponíveis para obter ou alterar os componentes individuais da URL:

Aviso: Ao trabalhar com um URL obtido de uma solicitação HTTP, lembre-se de que ele não conterá o fragmento, pois o navegador não o envia para o servidor.

Também podemos operar com parâmetros de consulta individuais usando:

O método getDomain(int $level = 2) retorna a parte direita ou esquerda do anfitrião. É assim que funciona se o anfitrião for www.nette.org:

A classe Url implementa a interface JsonSerializable e tem um método __toString() para que o objeto possa ser impresso ou usado em dados passados para json_encode().

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

O método isEqual(string|Url $anotherUrl): bool testa se as duas URLs são idênticas.

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

UrlImmutável

A classe Nette\Http\UrlImmutable é uma alternativa imutável à classe Url (assim como no PHP DateTimeImmutable é uma alternativa imutável ao DateTime). Ao invés de setters, ela tem os chamados murchadores, que não mudam o objeto, mas retornam novas instâncias com um valor modificado:

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'

Os seguintes métodos estão disponíveis para obter ou alterar os componentes individuais da URL:

Também podemos operar com parâmetros de consulta individuais usando:

O método getDomain(int $level = 2) funciona da mesma forma que o método em Url. O método withoutUserInfo() remove user e password.

A classe UrlImmutable implementa a interface JsonSerializable e tem um método __toString() para que o objeto possa ser impresso ou usado em dados passados para json_encode().

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

O método isEqual(string|Url $anotherUrl): bool testa se as duas URLs são idênticas.

UrlScript

A classe Nette\Http\UrlScript é descendente de UrlImmutable e, além disso, distingue estas partes lógicas da URL:

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

Os seguintes métodos estão disponíveis para obter estas peças:

Não criamos objetos UrlScript diretamente, mas o método Nette\Http\Request::getUrl() o devolve.