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',
);

Razred Url implementira vmesnik JsonSerializable in zagotavlja metodo __toString(), ki omogoča tiskanje predmeta ali njegovo uporabo z json_encode().

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

URL Components

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

Opozorilo: Pri delu z URL-jem, pridobljenim z zahtevo HTTP, upoštevajte, da ne bo vseboval fragmenta, saj ga brskalnik ne pošlje strežniku.

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

getDomain (int $level = 2): string

Vrne desni ali levi del gostitelja. Če je gostitelj www.nette.org, je prikazano naslednje delovanje:

isEqual (string|Url $anotherUrl): bool

Preveri, ali sta dva naslova URL enaka.

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

Url::isAbsolute (string $url): bool

Preveri, ali je naslov URL absoluten. URL se šteje za absolutnega, če se začne s shemo (npr. http, https, ftp), ki ji sledi dvopičje.

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

Url::removeDotSegments (string $path): string

Normalizira pot URL z odstranitvijo posebnih segmentov . in ... Ta metoda odstrani odvečne elemente poti na enak način kot brskalniki.

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

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'

Razred UrlImmutable implementira vmesnik JsonSerializable in zagotavlja metodo __toString(), ki omogoča tiskanje predmeta ali njegovo uporabo z json_encode().

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

URL Components

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

Metoda withoutUserInfo() odstrani user in password.

S posameznimi parametri poizvedbe lahko operiramo tudi z uporabo:

getDomain (int $level = 2): string

Vrne desni ali levi del gostitelja. Če je gostitelj www.nette.org, je prikazano naslednje delovanje:

resolve (string $reference): UrlImmutable

Absolutni naslov URL rešuje na enak način, kot brskalnik obdeluje povezave na strani HTML:

• Če je povezava absolutni URL (vsebuje shemo), se uporabi nespremenjena.
• Če se povezava začne s //, se uporabi samo shema iz trenutnega URL-ja.
• Če se povezava začne s /, se ustvari absolutna pot iz korena domene.
• V drugih primerih se URL ustvari relativno glede na trenutno pot.

$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

Preveri, ali sta dva naslova URL enaka.

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

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:

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