Nette Documentation Preview

syntax 
URL segédprogram
****************

.[perex]
Az [Url |#Url], [UrlImmutable |#UrlImmutable] és [UrlScript |#UrlScript] osztályok megkönnyítik az URL-ek kezelését, elemzését és manipulálását.

→ [Telepítés és követelmények |@home#Installation]


Url
===

A [api:Nette\Http\Url] osztály megkönnyíti az URL-rel és annak egyes összetevőivel való munkát, amelyeket ez az ábra vázol fel:

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

Az URL generálása intuitív:

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

Az URL-t is elemezheti, majd manipulálhatja:

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

A `Url` osztály megvalósítja a `JsonSerializable` interfészt, és biztosítja a `__toString()` metódust, ami lehetővé teszi az objektum nyomtatását vagy a `json_encode()` segítségével történő használatát.

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


URL Components .[method]
------------------------

A következő metódusok az egyes URL-komponensek lekérdezésére vagy módosítására állnak rendelkezésre:

.[language-php]
| Setter | Getter | Visszatérő érték
|--------------------------------------------------------------------------------------------
| `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` | teljes URL

Figyelmeztetés: Ha egy [HTTP-kérésből |request] kapott URL-címmel dolgozol, ne feledd, hogy az nem tartalmazza a töredéket, mivel a böngésző nem küldi el a kiszolgálónak.

Az egyes lekérdezési paraméterekkel is operálhatunk a következőkkel:

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


getDomain(int $level = 2): string .[method]
-------------------------------------------
Visszaadja a gazdatest jobb vagy bal oldalát. Így működik, ha a host a `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)` | `''`


isEqual(string|Url $anotherUrl): bool .[method]
-----------------------------------------------
Ellenőrzi, hogy két URL azonos-e.

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


Url::isAbsolute(string $url): bool .[method]{data-version:3.3.2}
----------------------------------------------------------------
Ellenőrzi, hogy egy URL abszolút-e. Egy URL akkor tekinthető abszolútnak, ha egy sémával kezdődik (pl. http, https, ftp), amelyet kettőspont követ.

```php
Url::isAbsolute('https://nette.org');    // true
Url::isAbsolute('//nette.org');          // false
```


Url::removeDotSegments(string $path): string .[method]{data-version:3.3.2}
--------------------------------------------------------------------------
Normalizálja az URL-útvonalat a `.` és a `..` speciális szegmensek eltávolításával. Ez a módszer a böngészőkhöz hasonlóan eltávolítja a felesleges útvonalelemeket.

```php
Url::removeDotSegments('/path/../subtree/./file.txt');  // '/subtree/file.txt'
Url::removeDotSegments('/../foo/./bar');                // '/foo/bar'
Url::removeDotSegments('./today/../file.txt');          // 'file.txt'
```


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

A [api:Nette\Http\UrlImmutable] osztály az [Url |#Url] osztály megváltoztathatatlan alternatívája (hasonlóan ahhoz, ahogy a `DateTimeImmutable` a `DateTime` megváltoztathatatlan alternatívája a PHP-ban). Setterek helyett witherekkel rendelkezik, amelyek nem változtatják meg az objektumot, hanem új példányokat adnak vissza a módosított értékkel:

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

A `UrlImmutable` osztály megvalósítja a `JsonSerializable` interfészt, és biztosítja a `__toString()` metódust, amely lehetővé teszi az objektum nyomtatását vagy a `json_encode()` segítségével történő használatát.

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


URL Components .[method]
------------------------

A következő metódusok állnak rendelkezésre az egyes URL-összetevők kinyeréséhez vagy módosításához:

.[language-php]
| Wither | Getter | Visszaadott érték
|--------------------------------------------------------------------------------------------
| `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` | teljes URL

A `withoutUserInfo()` módszer eltávolítja a `user` és a `password` címet.

Az egyes lekérdezési paraméterekkel is operálhatunk a következőkkel:

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


getDomain(int $level = 2): string .[method]
-------------------------------------------
Visszaadja a gazdatest jobb vagy bal oldalát. Így működik, ha a host a `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)` | `''`


resolve(string $reference): UrlImmutable .[method]{data-version:3.3.2}
----------------------------------------------------------------------
Feloldja az abszolút URL-címeket ugyanúgy, ahogyan a böngésző feldolgozza a HTML-oldalon található hivatkozásokat:
- Ha a hivatkozás abszolút URL (tartalmaz egy sémát), akkor azt változatlanul használja.
- Ha a hivatkozás `//`-val kezdődik, csak az aktuális URL sémáját alkalmazza a rendszer.
- Ha a hivatkozás `/`-val kezdődik, akkor a rendszer a tartomány gyökeréből kiinduló abszolút elérési utat hoz létre.
- Egyéb esetekben az URL az aktuális elérési úthoz képest kerül kialakításra.

```php
$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 .[method]
-----------------------------------------------
Ellenőrzi, hogy két URL azonos-e.

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


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

A [api:Nette\Http\UrlScript] osztály az [UrlImmutable |#UrlImmutable] leszármazottja, és további virtuális URL-összetevőkkel bővíti azt, például a projekt gyökérkönyvtárával stb. Szülő osztályához hasonlóan ez is egy megváltoztathatatlan objektum.

Az alábbi ábra mutatja az UrlScript által felismert komponenseket:

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

- `baseUrl` az alkalmazás alap URL címe, beleértve a tartományt és az alkalmazás gyökérkönyvtárának elérési útvonalát.
- `basePath` az alkalmazás gyökérkönyvtárának elérési útvonalának egy része.
- `scriptPath` az aktuális szkript elérési útvonala
- `relativePath` a szkript neve (és esetleg további elérési útszakaszok) a basePath-hez viszonyítva
- `relativeUrl` az URL teljes része a baseUrl után, beleértve a lekérdezési karakterláncot és a töredéket.
- `pathInfo` az URL egy ma már ritkán használt része a szkript neve után.

A következő metódusok állnak rendelkezésre ezen részek lekérdezéséhez:

.[language-php]
| Getter | Visszaadott érték
|------------------------------------------------
| `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/'`

A `UrlScript` objektumokat nem közvetlenül hozzuk létre, hanem a [Nette\Http\Request::getUrl() |request] metódus adja vissza.

URL segédprogram

Az Url, UrlImmutable és UrlScript osztályok megkönnyítik az URL-ek kezelését, elemzését és manipulálását.

→ Telepítés és követelmények

Url

A Nette\Http\Url osztály megkönnyíti az URL-rel és annak egyes összetevőivel való munkát, amelyeket ez az ábra vázol fel:

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

Az URL generálása intuitív:

use Nette\Http\Url;

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

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

Az URL-t is elemezheti, majd manipulálhatja:

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

A Url osztály megvalósítja a JsonSerializable interfészt, és biztosítja a __toString() metódust, ami lehetővé teszi az objektum nyomtatását vagy a json_encode() segítségével történő használatát.

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

URL Components

A következő metódusok az egyes URL-komponensek lekérdezésére vagy módosítására állnak rendelkezésre:

Setter Getter Visszatérő érték
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 teljes URL

Figyelmeztetés: Ha egy HTTP-kérésből kapott URL-címmel dolgozol, ne feledd, hogy az nem tartalmazza a töredéket, mivel a böngésző nem küldi el a kiszolgálónak.

Az egyes lekérdezési paraméterekkel is operálhatunk a következőkkel:

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

getDomain(int $level = 2): string

Visszaadja a gazdatest jobb vagy bal oldalát. Így működik, ha a host a 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

Ellenőrzi, hogy két URL azonos-e.

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

Url::isAbsolute(string $url): bool

Ellenőrzi, hogy egy URL abszolút-e. Egy URL akkor tekinthető abszolútnak, ha egy sémával kezdődik (pl. http, https, ftp), amelyet kettőspont követ.

Url::isAbsolute('https://nette.org');    // true
Url::isAbsolute('//nette.org');          // false

Url::removeDotSegments(string $path): string

Normalizálja az URL-útvonalat a . és a .. speciális szegmensek eltávolításával. Ez a módszer a böngészőkhöz hasonlóan eltávolítja a felesleges útvonalelemeket.

Url::removeDotSegments('/path/../subtree/./file.txt');  // '/subtree/file.txt'
Url::removeDotSegments('/../foo/./bar');                // '/foo/bar'
Url::removeDotSegments('./today/../file.txt');          // 'file.txt'

UrlImmutable

A Nette\Http\UrlImmutable osztály az Url osztály megváltoztathatatlan alternatívája (hasonlóan ahhoz, ahogy a DateTimeImmutable a DateTime megváltoztathatatlan alternatívája a PHP-ban). Setterek helyett witherekkel rendelkezik, amelyek nem változtatják meg az objektumot, hanem új példányokat adnak vissza a módosított értékkel:

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'

A UrlImmutable osztály megvalósítja a JsonSerializable interfészt, és biztosítja a __toString() metódust, amely lehetővé teszi az objektum nyomtatását vagy a json_encode() segítségével történő használatát.

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

URL Components

A következő metódusok állnak rendelkezésre az egyes URL-összetevők kinyeréséhez vagy módosításához:

Wither Getter Visszaadott érték
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 teljes URL

A withoutUserInfo() módszer eltávolítja a user és a password címet.

Az egyes lekérdezési paraméterekkel is operálhatunk a következőkkel:

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

getDomain(int $level = 2): string

Visszaadja a gazdatest jobb vagy bal oldalát. Így működik, ha a host a 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

Feloldja az abszolút URL-címeket ugyanúgy, ahogyan a böngésző feldolgozza a HTML-oldalon található hivatkozásokat:

  • Ha a hivatkozás abszolút URL (tartalmaz egy sémát), akkor azt változatlanul használja.
  • Ha a hivatkozás //-val kezdődik, csak az aktuális URL sémáját alkalmazza a rendszer.
  • Ha a hivatkozás /-val kezdődik, akkor a rendszer a tartomány gyökeréből kiinduló abszolút elérési utat hoz létre.
  • Egyéb esetekben az URL az aktuális elérési úthoz képest kerül kialakításra.
$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

Ellenőrzi, hogy két URL azonos-e.

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

UrlScript

A Nette\Http\UrlScript osztály az UrlImmutable leszármazottja, és további virtuális URL-összetevőkkel bővíti azt, például a projekt gyökérkönyvtárával stb. Szülő osztályához hasonlóan ez is egy megváltoztathatatlan objektum.

Az alábbi ábra mutatja az UrlScript által felismert komponenseket:

     baseUrl    basePath  relativePath  relativeUrl
        |          |        |               |
/---------------/-----\/--------\---------------------------\
http://nette.org/admin/script.php/pathinfo/?name=param#footer
                \_______________/\________/
                       |              |
                  scriptPath       pathInfo
  • baseUrl az alkalmazás alap URL címe, beleértve a tartományt és az alkalmazás gyökérkönyvtárának elérési útvonalát.
  • basePath az alkalmazás gyökérkönyvtárának elérési útvonalának egy része.
  • scriptPath az aktuális szkript elérési útvonala
  • relativePath a szkript neve (és esetleg további elérési útszakaszok) a basePath-hez viszonyítva
  • relativeUrl az URL teljes része a baseUrl után, beleértve a lekérdezési karakterláncot és a töredéket.
  • pathInfo az URL egy ma már ritkán használt része a szkript neve után.

A következő metódusok állnak rendelkezésre ezen részek lekérdezéséhez:

Getter Visszaadott érték
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/'

A UrlScript objektumokat nem közvetlenül hozzuk létre, hanem a Nette\Http\Request::getUrl() metódus adja vissza.