URI

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.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.

Ausgabe der URI

Ausgabe zur Weiterverarbeitung als String.

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;

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

Zurücksetzen von Werten

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;
}

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.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

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!

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();
}

Die Methode Alvine::getID() verwenden!

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)

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 hilfreich um Platz zu sparen.

Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision mit anderen Hash vergleichbarer Objekte.

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)) {
  // ...
}

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

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.

Name der Klasse

class MyObject extends Alvine {};
$obj = new MyObject();

echo $obj->getClass();

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

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.

Autorität beginnt mit einem Doppelschrägstrich

Query-Parsen und in Map zerlegen

Die Queryparameter werden mit rawurldecode decodiert. Pluszeichen werden genauso wie %20 in leerzeichen geändert.

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.

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.

Gibt true bei relativen URI zurück

Gibt true bei absoluten URI zurück.

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, da es zwei Striche hat.

Gibt das Schema zurück.

Gibt den Host zurück.

Unsichere Zeichen

Array mit unsicheren Zeichen, die in einer URL Maskiert werden müssen.

Gibt den Port zurück.

Diese Methode setzt den Benutzernamen, der in der URI verwendet werden soll.

Aus Sicherheitsgründen, sollten jedoch keine Anmeldedaten über die URI gesendet werden.

Gibt den Benutzernamen zurück

Diese Methode setzt das Passwort, das in der URI verwendet werden soll.

Aus Sicherheitsgründen, sollten jedoch keine Anmeldedaten über die URI gesendet werden.

Gibt das Passwort oder null zurück.

Setzt den Pfad

Gibt den Pfad oder null zurück

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

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

Die Werte werden ohne urlcodierung in die Query-Map eingetragen.

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.

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.

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.

Clone der internen Collection mit den Schlüssel/Wert Objekten

Die Werte in der Map sind nicht urlcodiert.

Setzt das Fragment (den reletiven Pfad innerhalb einer Ressource. Dieser wird mit einem # abgegrenzt.

Gibt das Fragment oder null zurück

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.

"A URI is opaque if, and only if, it is absolute and its scheme-specific part does not begin with a slash character ('/'). An opaque URI has a scheme, a scheme-specific part, and possibly a fragment; all other components are undefined."

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.

Aufbau der Schema-Zeichenkette

Query-Trennzeichen setzen

In HTML-Webseiten muss statt einen & ein & notwendig.

Spezifische URI aus Directory

Spezifische URI aus Datei