URI
class URI extends Alvine
URI
Diese Klasse bildet eine URI ab und ist im wesentlichen für Stringoperationen gedacht. Nach dem aktuellen Standard RFC 3986 besteht ein URI aus fünf Teilen: scheme (Schema), authority (Anbieter), path (Pfad), query (Abfrage) und fragment (Teil). Nur das Schema und der Pfad müssen in jedem URI vorhanden sein. Die generische Syntax ist
foo://example.com:8042/over/there?name=ferret#nose
_/ ______________/_________/ _________/ __/
| | | | |
scheme authority path query fragment
| _____________________|__
/ \ / \
Neben hirachischen URI gibt es auch noch andere Vertreter, wie z.B. beim Telefon-Schema: tel. Mit der Methode isOpaque kann man herausfinden, um welche Art der URI es sich handelt.
Traits
Constants
VERSION |
Generelle Alvine-Version |
APIVERSION |
Version der API-Version der Klasse. |
IDENTIFICATION |
Identifizierung der Alvine API |
SERIALVERSION |
Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren. |
SCHEME_DATA |
Data-URL: direkt eingebettete Daten |
SCHEME_FILE |
Dateien im lokalen Dateisystem |
SCHEME_FTP |
File Transfer Protocoll |
SCHEME_HTTP |
Hypertext Transfer Protocol |
SCHEME_HTTPS |
Hypertext Transfer Protocol (verschlüsselt) |
SCHEME_LDAP |
Lightweight Directory Access Protocol |
SCHEME_MAILTO |
E-Mail-Adresse |
SCHEME_SIP |
SIP-gestützter Sitzungsaufbau, z. B. für IP-Telefonie |
SCHEME_TELEPHONE |
Telefonnummer |
SCHEME_URN |
Uniform Resource Names (URNs) |
SCHEME_WS |
Websocket |
SCHEME_XMPP |
Protokoll für Jabber |
SCHEME_UNIX |
Protokoll für Jabber |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
static protected array | $unsafeCharacter | ||
protected string | $scheme | ||
protected string | $user | ||
protected boolean | $local | ||
protected string | $password | ||
protected string | $host | ||
protected integer | $port | ||
protected string | $path | ||
protected KeyValue> | $query | ||
protected string | $fragment |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Ausgabe der URI
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
Erstellt ein neues URI-Objekt oder wirft im Fehlerfall eine Exception. Das Schema und der Pfad sind Pflichtangaben und führen, wenn diese fehlen, zu einem Fehler.
Query-Parsen und in Map zerlegen
Interne Prüfung
Parse-Funktion für URI
Gibt true bei relativen URI zurück
Gibt true bei absoluten URI zurück.
Lokale URI
Gibt das Schema zurück.
Gibt den Host zurück.
Unsichere Zeichen
Gibt den Port zurück.
Diese Methode setzt den Benutzernamen, der in der URI verwendet werden soll.
Gibt den Benutzernamen zurück
Diese Methode setzt das Passwort, das in der URI verwendet werden soll.
Gibt das Passwort oder null zurück.
Gibt den Pfad oder null zurück
Den Queryteil einer URI zurücksetzen
Schlüssel/Wert-Paar in der URL (Query) setzen Sind mehrere identische Paare gesetzt, so werden die Werte bis auf einen entfernt
Anders als \Alvine\Net\Resource\URI::setQueryValue() fügt diese Methode Werte zu der Query-Liste hinzu.
Gibt den Abfrageteil oder null zurück
Gibt den Abfrageteil als Map zurück Das Ergebnis ist ein Clone der Map.
Clone der internen Collection mit den Schlüssel/Wert Objekten
Setzt das Fragment (den reletiven Pfad innerhalb einer Ressource. Dieser wird mit einem # abgegrenzt.
Gibt das Fragment oder null zurück
Nicht hierarchische URI
Prüfen auf generelle Gültigkeit
Aufbau der Schema-Zeichenkette
Query-Trennzeichen setzen
Details
in SerializableImplementation at line 125
string
serialize()
Serialisieren
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert. Soll eine abgeleitete Klasse nicht serialisierbar sein, so muss diese Methode überschrieben werden und eine Exception werfen.
Eigenschaften die mit volatile oder associated beginnen werden gesonder behandelt. Eigenschaften mit Prefix volatile werde nicht serialisiert. Bei Eigenschaften mit der Vorsilbe associated wird nur die ID des Objektes serialisiert. Wird in der Eigenschaft kein Objekt gespeichert wird eine TypeException geworfen.
in SerializableImplementation at line 197
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 209
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 232
protected
checkAndAdjustSerialisation(array $serialization)
Umgang mit Versionen
Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.
Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.
in SerializableImplementation at line 257
unserialize(string $serialization)
Klasse deserialisieren
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
at line 720
string
__toString()
Ausgabe der URI
Ausgabe zur Weiterverarbeitung als String.
in Alvine at line 212
void
__set(string $name, mixed $value)
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.
class MyObject extends Alvine {
}
$obj = new MyObject();
$obj->myValue = 4;
in Alvine at line 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
mixed
__get(string $name)
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.
if($obj->propertyExists('myproperty')) {
$value = $obj->myproperty;
}
in Alvine at line 282
Closure
getClosure(string $name)
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
in Alvine at line 308
boolean
propertyExists(string $name)
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
if($obj->propertyExists('myproperty')) {
$value = $obj->myproperty;
}
in Alvine at line 340
mixed
__call(string $name, array $arguments)
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Achtung: Wird das Closure in einem Objekt definiert, so ist die Variable $this nicht das Objekt des Closures, sondern des, in dem das Closure definiert wurde.
// als erster Parameter wird immer das Objekt übergeben
$a->myfunction = function($obj, $b) { echo $b.'!'; };
// Aufruf als Eigenschaft ohne Parameter
$a->myfunction; // Ausgabe ist ein !
//
// Aufruf als Methode mit Parametern
$a->myfunction('OK'); // Ausgabe ist OK!
in Alvine at line 363
boolean
isCallable(type $name)
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
if($obj->isCallable('myfunction')) {
$obj->myfunction();
}
in Alvine at line 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 397
string
getID()
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Objekte haben bei der Erstellung noch keine eindeutige ID, erst mit dem expliziten Aufruf der ID wird diese einmalig erstellt und im Objekt gepseichert.
Diese Methode wird implizit beim Serialisieren aufgerufen.
Die UUID ist dabei vom Type4 (Random)
in Alvine at line 416
string
getShortID(integer $length = null)
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Methode ist hilreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.
in Alvine at line 442
boolean
equals(Alvine $object)
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
class MyObject extends Alvine {};
$objA = new MyObject();
$objB = new MyObject();
if($objA->equals($objB)) {
// ...
}
in Alvine at line 463
Alvine
getClone(boolean $deepClone = false)
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Wenn eine abgeleitete Klasse diese Methode nicht unterstützt, so muss diese die Methode überschreiben und eine CloneNotSupportedException werfen. Die Standardmethode klont eine seichte Kopie der Eigenschaften. Das bedeutet das Objekte in den Eigenschaften nicht geclont werden. Sollen diese auch geclont werden muss true übergeben werden.
Wenn weitere Funktionen implementiert werden sollen, so muss __clone überschrieben werden
in Alvine at line 475
__clone()
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.
in Alvine at line 493
string
getClass()
Name der Klasse
class MyObject extends Alvine {};
$obj = new MyObject();
echo $obj->getClass();
in Alvine at line 518
boolean
isInstanceOf(object $object)
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
if($obj instanceof Alvine &&
$obj->isInstanceOf($object)) { };
Die Prüfung entspricht
$this instanceof $object
at line 206
__construct(string $uri = null)
Erstellt ein neues URI-Objekt oder wirft im Fehlerfall eine Exception. Das Schema und der Pfad sind Pflichtangaben und führen, wenn diese fehlen, zu einem Fehler.
Die URL muss urlcodiert sein, das heisst die Werte im Query müssen Sonderzeichen codiert vorliegen.
at line 248
protected KeyValue>
parseQuery(string $query)
Query-Parsen und in Map zerlegen
Die Queryparameter werden mit rawurldecode decodiert. Pluszeichen werden genauso wie %20 in leerzeichen geändert.
at line 276
protected
validateParts()
Interne Prüfung
Diese interne Methode wird vom Konstruktor aufgerufen und prüft verschiedene Regeln und wirft im Fehlerfall eine Exception. Abgeleitete Klassen können an dieser Stelle Ihre eigenen Regeln für gültige URI definieren.
at line 294
static protected array|boolean
parse(string $uri)
Parse-Funktion für URI
Da die Funktion \parse_url auf URL spezialisiert ist, ersetzt diese Methode diese PHP-Funktion, damit auch URI geparsed werden.
at line 342
boolean
isRelative()
Gibt true bei relativen URI zurück
at line 351
boolean
isAbsolute()
Gibt true bei absoluten URI zurück.
at line 365
boolean
isLocal()
Lokale URI
Diese Methode gibt zurück, ob die referenzierte Resource lokal oder extern ist. Eine wichtige Ausnahme gibt es mit dem Schema file. Hier wird angenommen, das es extern ist. Aus diesem Grund hat file /// Striche.
at line 374
string|null
getScheme()
Gibt das Schema zurück.
at line 383
string
getHost()
Gibt den Host zurück.
at line 397
static array
getUnsafeCharacter()
Unsichere Zeichen
Array mit unsicheren Zeichen, die in einer URL Maskiert werden müssen.
at line 406
string
getPort()
Gibt den Port zurück.
at line 419
URI
setUser(string $user)
Diese Methode setzt den Benutzernamen, der in der URI verwendet werden soll.
Aus Sicherheitsgründen, sollten jedoch keine Anmeldedaten über die URI gesendet werden.
at line 429
string|null
getUser()
Gibt den Benutzernamen zurück
at line 442
URI
setPassword(string $password)
Diese Methode setzt das Passwort, das in der URI verwendet werden soll.
Aus Sicherheitsgründen, sollten jedoch keine Anmeldedaten über die URI gesendet werden.
at line 452
string|null
getPassword()
Gibt das Passwort oder null zurück.
at line 463
URI
setPath(string $path)
Setzt den Pfad
at line 473
string|null
getPath()
Gibt den Pfad oder null zurück
at line 492
URI
setQuery(string|SimpleMap $query)
Setzt den Abfrageteil von Werten die URLCodiert sind
Wird null übergeben werden alle Queries gelöscht.
Wichtig: Das übergebene Query wird mittels URI::parseQuery() decodiert. Das heißt der übergebene Abfrageteil muss urlencoded sein. Das gilt auch für die Werte in der Map
at line 517
URI
resetQuery()
Den Queryteil einer URI zurücksetzen
at line 534
URI
setQueryValue(string $key, string $value)
Schlüssel/Wert-Paar in der URL (Query) setzen Sind mehrere identische Paare gesetzt, so werden die Werte bis auf einen entfernt
Die Werte werden ohne urlcodierung in die Query-Map eingetragen.
at line 564
URI
appendQueryValue(string $key, string $value)
Anders als \Alvine\Net\Resource\URI::setQueryValue() fügt diese Methode Werte zu der Query-Liste hinzu.
Ein mehrmahliger Aufruf hat zur Folge, dass mehrere Parameter angehängt werden.
Die Werte werden ohne urlcodierung in die Query-Map eingetragen.
at line 578
string|null
getQuery()
Gibt den Abfrageteil oder null zurück
Die Parameter werden mittels \rawurlencode codiert und stehen somit direkt für die Verwendung in der Serverkommunikation zur Verfügung.
at line 607
SimpleMap
getQueryMap()
Gibt den Abfrageteil als Map zurück Das Ergebnis ist ein Clone der Map.
WICHTIG Bei der Map können nur eindeutige Schlüssel zurückgegeben werden. Wird eine URL mit Mehrfachzuweisungen verwendet, so muss getQueryCollection verwendet werden.
Bei der URL www.example.com?a=1&a=2 ist undefiniert welcher Wert zurückgegeben wird. Das Verhalten kann sich auch jederzeit ändern.
Die Werte in der Map sind nicht urlcodiert.
at line 625
KeyValue>
getQueryCollection()
Clone der internen Collection mit den Schlüssel/Wert Objekten
Die Werte in der Map sind nicht urlcodiert.
at line 636
URI
setFragment(string $fragment)
Setzt das Fragment (den reletiven Pfad innerhalb einer Ressource. Dieser wird mit einem # abgegrenzt.
at line 646
string|null
getFragment()
Gibt das Fragment oder null zurück
at line 661
boolean
isOpaque()
Nicht hierarchische URI
Der Aufbau einer URI unterscheidet sich je nach verwendeten Schema. So ist der Aufbau einer Telefon-URI mit Schema und Nummer anders, als der Aufbau einer http-, oder file-URI. Eine hierarchisch aufgebaute URI wie http kann aus mehreren Bestandteilen bestehen, deren Reihenfolge festgelegt ist. Die URL kann dann neben dem Schema, der Authorität und dem Pfad auch einen Query String enthalten. Die isOpaque Methode liefert false, wenn die URI hierarchisch aufgebaut und true im anderen Fall.
at line 675
static boolean
validate(string $uri)
Prüfen auf generelle Gültigkeit
Diese Methode überprüft die URI, anhand spezifischer Prüfungen. Diese Methode muss von abgeleiteten Klassen überschrieben werden und eigene Regeln definieren.
at line 702
protected string
getSchemeFormat()
Aufbau der Schema-Zeichenkette
at line 742
URI
setQuerySeparator(string $separator)
Query-Trennzeichen setzen
In HTML-Webseiten muss statt einen & ein & notwendig.