URL Dienstprogramm

Die Klassen Url, UrlImmutable und UrlScript erleichtern das Verwalten, Parsen und Manipulieren von URLs.

→ Installation und Anforderungen

Url

Die Klasse Nette\Http\Url erleichtert die Arbeit mit der URL und ihren einzelnen Komponenten, die in diesem Diagramm skizziert werden:

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

Die URL-Generierung ist intuitiv:

use Nette\Http\Url;

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

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

Sie können die URL auch parsen und dann manipulieren:

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

Die Klasse Url implementiert die Schnittstelle JsonSerializable und stellt die Methode __toString() zur Verfügung, die es ermöglicht, das Objekt zu drucken oder mit json_encode() zu verwenden.

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

URL Components

Die folgenden Methoden sind verfügbar, um einzelne URL-Komponenten zu erhalten oder zu ändern:

Warnung: Bei der Arbeit mit einer URL, die aus einer HTTP-Anfrage stammt, ist zu beachten, dass sie das Fragment nicht enthält, da der Browser es nicht an den Server sendet.

Wir können auch mit einzelnen Abfrageparametern arbeiten:

getDomain (int $level = 2): string

Gibt den rechten oder linken Teil des Hosts zurück. So funktioniert es, wenn der Host www.nette.org ist:

isEqual (string|Url $anotherUrl): bool

Prüft, ob zwei URLs identisch sind.

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

Url::isAbsolute (string $url): bool

Prüft, ob eine URL absolut ist. Eine URL gilt als absolut, wenn sie mit einem Schema beginnt (z. B. http, https, ftp), gefolgt von einem Doppelpunkt.

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

Url::removeDotSegments (string $path): string

Normalisiert einen URL-Pfad durch Entfernen der speziellen Segmente . und ... Diese Methode entfernt überflüssige Pfadelemente auf die gleiche Weise, wie es die Browser tun.

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

UrlImmutable

Die Klasse Nette\Http\UrlImmutable ist eine unveränderbare Alternative zur Klasse Url (ähnlich wie DateTimeImmutable eine unveränderbare Alternative zu DateTime in PHP ist). Anstelle von Settern hat sie Wither, die das Objekt nicht ändern, sondern neue Instanzen mit dem geänderten Wert zurückgeben:

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'

Die Klasse UrlImmutable implementiert die Schnittstelle JsonSerializable und stellt die Methode __toString() zur Verfügung, mit der Sie das Objekt drucken oder mit json_encode() verwenden können.

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

URL Components

Die folgenden Methoden sind verfügbar, um einzelne URL-Komponenten zu erhalten oder zu ändern:

Bei der Methode withoutUserInfo() werden user und password entfernt.

Wir können auch mit einzelnen Abfrageparametern arbeiten, indem wir:

getDomain (int $level = 2): string

Gibt den rechten oder linken Teil des Hosts zurück. So funktioniert es, wenn der Host www.nette.org ist:

resolve (string $reference): UrlImmutable

Löst einen absoluten URL in der gleichen Weise auf, wie ein Browser Links auf einer HTML-Seite verarbeitet:

• Wenn der Link ein absoluter URL ist (ein Schema enthält), wird er unverändert verwendet.
• Wenn der Link mit // beginnt, wird nur das Schema der aktuellen URL verwendet.
• Beginnt der Link mit /, wird ein absoluter Pfad vom Domänenstamm erstellt.
• In anderen Fällen wird die URL relativ zum aktuellen Pfad aufgebaut.

$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

Prüft, ob zwei URLs identisch sind.

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

UrlScript

Die Klasse Nette\Http\UrlScript ist ein Abkömmling von UrlImmutable und erweitert diese um zusätzliche virtuelle URL-Komponenten, wie das Stammverzeichnis des Projekts usw. Wie ihre Elternklasse ist sie ein unveränderliches Objekt.

Das folgende Diagramm zeigt die Komponenten, die UrlScript erkennt:

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

• baseUrl ist die Basis-URL der Anwendung einschließlich der Domäne und eines Teils des Pfads zum Stammverzeichnis der Anwendung
• basePath ist ein Teil des Pfads zum Stammverzeichnis der Anwendung
• scriptPath ist der Pfad zum aktuellen Skript
• relativePath ist der Skriptname (und möglicherweise zusätzliche Pfadsegmente) relativ zu basePath
• relativeUrl ist der gesamte Teil der URL nach baseUrl, einschließlich Abfragezeichenfolge und Fragment.
• pathInfo ist ein jetzt selten verwendeter Teil der URL nach dem Skriptnamen

Die folgenden Methoden sind verfügbar, um diese Teile zu erhalten:

Wir erstellen die Objekte UrlScript nicht direkt, aber die Methode Nette\Http\Request::getUrl() gibt sie zurück.