Nette Documentation Preview

syntax 
Razhroščevalnik in graditelj URL-jev
************************************

.[perex]
Razredi [Url |#Url], [UrlImmutable |#UrlImmutable] in [UrlScript |#UrlScript] omogočajo enostavno upravljanje, razčlenjevanje in manipuliranje z naslovi URL.

→ [Namestitev in zahteve |@home#Installation]


Url
===

Razred [api:Nette\Http\Url] omogoča enostavno delo z naslovom URL in njegovimi posameznimi sestavnimi deli, ki so opisani v tem diagramu:

/--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
\--

Ustvarjanje URL je intuitivno:

```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 lahko tudi razčlenite in ga nato obdelate:

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

Za pridobivanje ali spreminjanje posameznih komponent URL so na voljo naslednje metode:

.[language-php]
| Setter | Getter | Vrnjena vrednost
|--------------------------------------------------------------------------------------------
| `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` | polni URL

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

.[language-php]
| Setter | Getter
|---------------------------------------------------
| `setQuery(string\|array $query)` | `getQueryParameters(): array`
| `setQueryParameter(string $name, $val)`| `getQueryParameter(string $name)`

Metoda `getDomain(int $level = 2)` vrne desni ali levi del gostitelja. Tako deluje, če je gostitelj `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)` | `''`


Razred `Url` implementira vmesnik `JsonSerializable` in ima metodo `__toString()`, tako da se lahko objekt natisne ali uporabi v podatkih, posredovanih `json_encode()`.

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

Metoda `isEqual(string|Url $anotherUrl): bool` preveri, ali sta naslova URL enaka.

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


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

Razred [api:Nette\Http\UrlImmutable] je nespremenljiva alternativa razredu `Url` (tako kot je v PHP `DateTimeImmutable` nespremenljiva alternativa `DateTime`). Namesto setterjev ima tako imenovane witherje, ki ne spreminjajo objekta, temveč vračajo nove instance s spremenjeno vrednostjo:

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

Za pridobivanje ali spreminjanje posameznih komponent URL so na voljo naslednje metode:

.[language-php]
| Wither | Getter | Vrnjena vrednost
|--------------------------------------------------------------------------------------------
| `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` | polni URL

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

.[language-php]
| Wither | Getter
|-----------------------------------------------
| `withQuery(string\|array $query)` | `getQueryParameters(): array`
| `withQueryParameter(string $name, $val)` | `getQueryParameter(string $name)`

Metoda `getDomain(int $level = 2)` deluje enako kot metoda v `Url`. Metoda `withoutUserInfo()` odstrani `user` in `password`.

Razred `UrlImmutable` implementira vmesnik `JsonSerializable` in ima metodo `__toString()`, tako da se lahko objekt natisne ali uporabi v podatkih, posredovanih v `json_encode()`.

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

Metoda `isEqual(string|Url $anotherUrl): bool` preveri, ali sta naslova URL enaka.


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

Razred [api:Nette\Http\UrlScript] je potomec razreda `UrlImmutable` in dodatno razlikuje te logične dele URL-ja:

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

Za pridobitev teh delov so na voljo naslednje metode:

.[language-php]
| Getter | Vrnjena vrednost
|------------------------------------------------
| `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/'`


Ne ustvarjamo predmetov `UrlScript` neposredno, ampak jih vrne metoda [Nette\Http\Request::getUrl() |request].

Razhroščevalnik in graditelj URL-jev

Razredi Url, UrlImmutable in UrlScript omogočajo enostavno upravljanje, razčlenjevanje in manipuliranje z naslovi URL.

→ Namestitev in zahteve

Url

Razred Nette\Http\Url omogoča enostavno delo z naslovom URL in njegovimi posameznimi sestavnimi deli, ki so opisani v tem diagramu:

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

Ustvarjanje URL je intuitivno:

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 lahko tudi razčlenite in ga nato obdelate:

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

Za pridobivanje ali spreminjanje posameznih komponent URL so na voljo naslednje metode:

Setter Getter Vrnjena vrednost
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 polni URL

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

Setter Getter
setQuery(string|array $query) getQueryParameters(): array
setQueryParameter(string $name, $val) getQueryParameter(string $name)

Metoda getDomain(int $level = 2) vrne desni ali levi del gostitelja. Tako deluje, če je gostitelj 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) ''

Razred Url implementira vmesnik JsonSerializable in ima metodo __toString(), tako da se lahko objekt natisne ali uporabi v podatkih, posredovanih json_encode().

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

Metoda isEqual(string|Url $anotherUrl): bool preveri, ali sta naslova URL enaka.

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

UrlImmutable

Razred Nette\Http\UrlImmutable je nespremenljiva alternativa razredu Url (tako kot je v PHP DateTimeImmutable nespremenljiva alternativa DateTime). Namesto setterjev ima tako imenovane witherje, ki ne spreminjajo objekta, temveč vračajo nove instance s spremenjeno vrednostjo:

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'

Za pridobivanje ali spreminjanje posameznih komponent URL so na voljo naslednje metode:

Wither Getter Vrnjena vrednost
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 polni URL

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

Wither Getter
withQuery(string|array $query) getQueryParameters(): array
withQueryParameter(string $name, $val) getQueryParameter(string $name)

Metoda getDomain(int $level = 2) deluje enako kot metoda v Url. Metoda withoutUserInfo() odstrani user in password.

Razred UrlImmutable implementira vmesnik JsonSerializable in ima metodo __toString(), tako da se lahko objekt natisne ali uporabi v podatkih, posredovanih v json_encode().

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

Metoda isEqual(string|Url $anotherUrl): bool preveri, ali sta naslova URL enaka.

UrlScript

Razred Nette\Http\UrlScript je potomec razreda UrlImmutable in dodatno razlikuje te logične dele URL-ja:

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

Za pridobitev teh delov so na voljo naslednje metode:

Getter Vrnjena vrednost
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/'

Ne ustvarjamo predmetov UrlScript neposredno, ampak jih vrne metoda Nette\Http\Request::getUrl().