Nette Documentation Preview

syntax 
Парсер и конструктор на URL адреси
**********************************

.[perex]
Класовете [Url |#Url], [UrlImmutable |#UrlImmutable] и [UrlScript |#UrlScript] позволяват лесно управление, анализиране и манипулиране на URL адреси.

→ [Монтаж и изисквания |@home#Installation]


Урл
===

Класът [api:Nette\Http\Url] позволява лесна работа с URL адреса и отделните му компоненти, които са показани на тази диаграма:

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

Генерирането на URL адреси е интуитивно:

```php
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 адреса и след това да го манипулирате:

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

Следните методи са достъпни за извличане или промяна на отделни компоненти на URL:

.[language-php]
| 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 заявка |request], имайте предвид, че той няма да съдържа фрагмента, тъй като браузърът не го изпраща на сървъра.

Можем да работим и с отделни параметри на заявката, като използваме:

.[language-php]
| Установяване | Получаване
|---------------------------------------------------
| `setQuery(string\|array $query)` | `getQueryParameters(): array`
| `setQueryParameter(string $name, $val)`| `getQueryParameter(string $name)`

Методът `getDomain(int $level = 2)` връща дясната или лявата страна на хоста. Ето как става това, ако хостът е `www.nette.org`:

.[language-php]
| `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)` | `''`


Класът `Url` имплементира интерфейса `JsonSerializable` и има метод `__toString()`, така че обектът може да бъде отпечатан или използван в данните, предадени на `json_encode()`.

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

Методът `isEqual(string|Url $anotherUrl): bool` проверява дали двата URL адреса са идентични.

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


UrlImmutable .[#toc-urlimmutable]
=================================

Класът [api:Nette\Http\UrlImmutable] е неизменна алтернатива на класа `Url` (точно както в PHP `DateTimeImmutable` е неизменна алтернатива на `DateTime`). Вместо сетъри има т.нар. withers, които не променят обекта, а връщат нови екземпляри с променената стойност:

```php
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'
```

Следните методи са достъпни за извличане или промяна на отделни компоненти на URL:

.[language-php]
| 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 адрес

Можем да работим и с отделни параметри на заявката, като използваме:

.[language-php]
| Увяхване | Получаване
|-----------------------------------------------
| `withQuery(string\|array $query)` | `getQueryParameters(): array`
| `withQueryParameter(string $name, $val)` | `getQueryParameter(string $name)`

Методът `getDomain(int $level = 2)` работи по същия начин като метода в `Url`. Методът `withoutUserInfo()` премахва `user` и `password`.

Класът `UrlImmutable` имплементира интерфейса `JsonSerializable` и има метод `__toString()`, така че обектът може да бъде отпечатан или използван в данните, предадени на `json_encode()`.

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

Методът `isEqual(string|Url $anotherUrl): bool` проверява дали двата URL адреса са идентични.


UrlScript .[#toc-urlscript]
===========================

Класът [api:Nette\Http\UrlScript] е потомък на класа `UrlImmutable` и допълнително разграничава тези логически части на URL:

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

За извличането на тези части са налични следните методи:

.[language-php]
| 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() |request] ги връща.

Парсер и конструктор на 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:

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) връща дясната или лявата страна на хоста. Ето как става това, ако хостът е 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) ''

Класът Url имплементира интерфейса JsonSerializable и има метод __toString(), така че обектът може да бъде отпечатан или използван в данните, предадени на json_encode().

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

Методът isEqual(string|Url $anotherUrl): bool проверява дали двата URL адреса са идентични.

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

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'

Следните методи са достъпни за извличане или промяна на отделни компоненти на 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 адрес

Можем да работим и с отделни параметри на заявката, като използваме:

Увяхване Получаване
withQuery(string|array $query) getQueryParameters(): array
withQueryParameter(string $name, $val) getQueryParameter(string $name)

Методът getDomain(int $level = 2) работи по същия начин като метода в Url. Методът withoutUserInfo() премахва user и password.

Класът UrlImmutable имплементира интерфейса JsonSerializable и има метод __toString(), така че обектът може да бъде отпечатан или използван в данните, предадени на json_encode().

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

Методът isEqual(string|Url $anotherUrl): bool проверява дали двата URL адреса са идентични.

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() ги връща.