Парсер і конструктор URL

Класи Url, UrlImmutable і UrlScript дають змогу легко керувати, розбирати і маніпулювати URL-адресами.

→ Встановлення та вимоги

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:

Попередження: Працюючи з URL-адресою, отриманою з HTTP-запиту, майте на увазі, що вона не міститиме фрагмент, оскільки браузер не надсилає його на сервер.

Ми також можемо працювати з окремими параметрами запиту, використовуючи:

getDomain (int $level = 2): string

Повертає праву або ліву частину хоста. Ось як це працює, якщо хост має вигляд www.nette.org:

isEqual (string|Url $anotherUrl): bool

Перевіряє, чи не збігаються дві URL-адреси.

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

Url::isAbsolute (string $url): bool

Перевіряє, чи є 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:

Метод withoutUserInfo() видаляє user і password.

Ми також можемо оперувати індивідуальними параметрами запиту за допомогою:

getDomain (int $level = 2): string

Повертає праву або ліву частину хоста. Ось як це працює, якщо хост має вигляд www.nette.org:

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

Для отримання цих частин доступні такі методи:

Ми не створюємо об'єкти UrlScript безпосередньо, але метод Nette\Http\Request::getUrl() повертає його.