Парсер и конструктор на URL адреси
Класовете Url, UrlImmutable и UrlScript позволяват лесно управление, анализиране и манипулиране на URL адреси.
Урл
Класът Nette\Http\Url позволява лесна работа с URL адреса и отделните му компоненти, които са показани на тази диаграма:
scheme user password host port path query fragment | | | | | | | | /--\ /--\ /------\ /-------\ /--\/----------\ /--------\ /----\ http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer \______\__________________________/ | | hostUrl authority
Генерирането на URL адреси е интуитивно:
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 адреса и след това да го манипулирате:
$url = new Url(
'http://john:xyz%2A12@nette.org:8080/en/download?name=param#footer',
);
Класът Url
имплементира интерфейса JsonSerializable
и
предоставя метода __toString()
, което дава възможност за отпечатване
на обекта или използването му с json_encode()
.
echo $url;
echo json_encode([$url]);
URL Components
Следните методи са достъпни за получаване или промяна на отделни компоненти на URL:
Setter | Getter | Върната стойност |
---|---|---|
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 |
пълен URL адрес |
Предупреждение: Когато работите с URL, получен от HTTP заявка, имайте предвид, че той няма да съдържа фрагмента, тъй като браузърът не го изпраща на сървъра.
Можем да работим и с отделни параметри на заявката, като използваме:
Установяване | Получаване |
---|---|
setQuery(string|array $query) |
getQueryParameters(): array |
setQueryParameter(string $name, $val) |
getQueryParameter(string $name) |
getDomain (int $level = 2): string
Връща дясната или лявата част на хоста. Ето как работи, ако хостът е
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) |
'' |
isEqual (string|Url $anotherUrl): bool
Проверява дали два URL адреса са идентични.
$url->isEqual('https://nette.org');
Url::isAbsolute (string $url): bool
Проверява дали даден URL адрес е абсолютен. URL адресът се счита за абсолютен, ако започва със схема (напр. http, https, ftp), последвана от двоеточие.
Url::isAbsolute('https://nette.org'); // true
Url::isAbsolute('//nette.org'); // false
Url::removeDotSegments (string $path): string
Нормализира URL пътя, като премахва специалните сегменти .
и
..
. Този метод премахва излишните елементи на пътя по същия
начин, по който го правят браузърите.
Url::removeDotSegments('/path/../subtree/./file.txt'); // '/subtree/file.txt'
Url::removeDotSegments('/../foo/./bar'); // '/foo/bar'
Url::removeDotSegments('./today/../file.txt'); // 'file.txt'
UrlImmutable
Класът Nette\Http\UrlImmutable е
неизменна алтернатива на класа Url
(точно както в PHP
DateTimeImmutable
е неизменна алтернатива на DateTime
). Вместо сетъри
има т.нар. withers, които не променят обекта, а връщат нови екземпляри с
променената стойност:
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'
Класът UrlImmutable
имплементира интерфейса JsonSerializable
и
предоставя метода __toString()
, който ви позволява да отпечатате
обекта или да го използвате с json_encode()
.
echo $url;
echo json_encode([$url]);
URL Components
Следните методи са достъпни за получаване или промяна на отделни компоненти на URL:
Wither | Getter | Върната стойност |
---|---|---|
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 |
пълен URL адрес |
Методът withoutUserInfo()
премахва user
и password
.
Можем да работим и с отделни параметри на заявката, като използваме:
Увяхване | Получаване |
---|---|
withQuery(string|array $query) |
getQueryParameters(): array |
withQueryParameter(string $name, $val) |
getQueryParameter(string $name) |
getDomain (int $level = 2): string
Връща дясната или лявата част на хоста. Ето как работи, ако хостът е
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) |
'' |
resolve (string $reference): UrlImmutable
Разрешава абсолютен URL адрес по същия начин, по който браузърът обработва връзките в HTML страница:
- Ако връзката е абсолютен URL адрес (съдържа схема), той се използва непроменен.
- Ако връзката започва с
//
, се прилага само схемата от текущия URL адрес. - Ако връзката започва с
/
, се създава абсолютен път от корена на домейна. - В останалите случаи URL адресът се конструира относително към текущия път.
$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 $anotherUrl): bool
Проверява дали два URL адреса са идентични.
$url->isEqual('https://nette.org');
UrlScript
Класът Nette\Http\UrlScript е потомък
на класа UrlImmutable
и допълнително разграничава тези логически
части на URL:
baseUrl basePath relativePath relativeUrl | | | | /---------------/-----\/--------\---------------------------\ http://nette.org/admin/script.php/pathinfo/?name=param#footer \_______________/\________/ | | scriptPath pathInfo
За извличането на тези части са налични следните методи:
Getter | Върната стойност |
---|---|
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/' |
Не създаваме директно обекти UrlScript
, но методът Nette\Http\Request::getUrl() ги връща.