HierarchicalProperties

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.

Gibt den Inhalt der Map als Zeichenkette zurück, dabei werden die Schlüssel und Werte durch das definiertes Trennzeichen : und die einzelnen Einträge der Map durch ein Komma getrennt.

Die beiden Trennzeichen können über die entsprechenden Funktionen gesetzt werden.

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

Neues Objekt

Werte überprüfen

Diese Methode überprüft den Schlüssel und den Wert eines Arrays

Bearbeitung des Wertes

Überprüfung ob der Wert der Map ein bestimmter Type ist. Wenn nicht, wird eine TypeException geworfen. Diese Methode kann von abgeleiteten Klassen für die Bearbeitung der Werte verwendet werden.

Setzt das Trennzeichen für die __toString Methode

Setzt das Trennzeichen für die __toString Methode

Leert alle Einträge aus der Map

Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.

Prüft ob der übergebene Wert in der Map enthalten ist.

Map oder Array anhängen

Hängt an die Map weitere Einträge an. Vor dem einhängen wird die Methode Map::normalize() aufgerufen.

Wert setzen

Setzt den Wert eines Schlüssels auf den Übergebenen Wert.

Gibt den Wert des Schlüssels in der Map zurück.

Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map

Entfernt alle Einträge, die den übergebenen Wert haben.

Der Wert muss vom identischen Typ sein, da der Vergleich mittels === erfolgt.

Ermittelt die Anzahl der Einträge in der Map

Ausgabe vorbereiten

Wert des aktuellen Objektes

Schlüssel des aktuellen Elements zurückgeben

Den internen Zeiger der Map auf den nächsten Wert setzen.

Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag

Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.

Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.

Durchläuft alle Einträge der Map und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.

$map = new Alvine\types\Map(array('aaa'=>'Auto','bbb'=>'Boot','ccc'=>'Flugzeug'));
$map->each(function($k, $v) { return $v.'...'; });
// Der Filter beachtet die groß/Kleinschreibung.
$map->each(function($k, $v) { return $v.'...'; });

Die Werte werden dann jeweils um ... ergänzt: Auto... Boot... und Flugzeug ... Über den optionalen Filter können Einschränkungen auf den Schlüssel angewendet werden.

// Mit Filter auf alle Schlüssel die mit a anfangen.
$map->each(function($k, $v) { return $v.'...'; }, 'a');

Nur das Auto würde in diesem Beispiel um ... ergänzt werden. Gibt die aufgerufene Funktion null zurück, so wird keine Zuweisung durchgeführt und der ursprüngliche Wert bleibt erhalten.

Implementierung des Array-Interfaces

Implementierung des Array-Interfaces

Implementierung des Array-Interfaces

Implementierung des Array-Interfaces

Teilschlüssel holen

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Teilmengen in Gruppen

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen und gruppiert das Ergebnis zu dem gewünschten Level.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Werte als Array

Die Werte werden nicht angepasst und Maps und Collection bleiben Objekte.

toArray wandelt im Gegensatz zu asArray die Unterwerte nicht um, sondern gibt nur das Array auf oberster Ebene aus.

Json-Zeichenkette

Inhalt des Dataset als Array

asArray wandelt, anders als toArray die gesamte Struktur der Map so um, das es an tojson verwendet werden kann.

Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.

Property zurückgeben

Eigenschaft setzen. Diese Funktion ruft intern die MAP-Methode setValue auf.

Property-Datei einlesen und verarbeiten. Kommentare am Anfang und am Ende einer Datei werden als header und footer gespeichert. Eine Leerzeile zwischen Header und ersten Schlüssel trennt die Kommentare.

# Das ist ein Dateikommentar
! das auch

#Dieser Kommentar gehört zur nächsten
#Eigenschaft, da eine Leerzeile vor
#diesem Block steht.
Wert=Schlüssel
#Footerblock

Inhalt schreiben

Property-Datei mit Kommentaren und Werten in einen Stream schreiben.

$properties = new Alvine\Types\Properties();
$stream = \Alvine\IO\FileInputStream::fromCurrentPath('file.properties');
$properties->save($stream);

Neues Property-Objekt aus Stream erstellen

Eigenschaften setzen

Diese Methode setzt die Eigenschaften in einer vorhandenen Baumstruktur. Vorhandene Werte werden durch die neuen Werte ersetzt. Die Baumstruktur wird anhand der Punkte in den Schlüsseln erstellt. aus dem Schlüsselnamen a.b.c wird ein Ast a -> b -> c