NodeList

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.

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.

Liefert das XML-Dokument als Zeichenkette zurück

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

Erstellt eine Kopie dieser Node.

Auch alle Kinder der Nodes weden dabei kopiert.

Das Klonen setzt den Index der Nodes neu.

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 NodeList-Objekt

Referenzen auflösen

Neue Node als Kind einhängen

Alles Nodes als Array zurückgeben

Implementierung des Iteration Interfaces.

Internen Zähler zurücksetzen.

Implementierung des Iteration Interfaces.

Implementierung des Iteration Interfaces.

Null, wenn der Pointer am Ende ist

Implementierung des Iteration Interfaces.

Implementierung des Iteration Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Löscht ein Nodes aus der Liste

Löscht alle Nodes

Liefert die erste Node zurück

Liefert die letzte Node zurück

Prüft ob Nodes verfügbar sind

Fügt eine Node an der definierten Stelle ein

Diese Methode ändert bestehende Index und verändert den internen Zeiger auf die NodeList. Dies ist insbesondere dann wichtig, wenn diese Methode innerhalb von foreach zum Einsatz kommt.

Fügt eine neue Node vor einer bestimmten Node ein.

Diese Methode ändert bestehende Index und verändert den internen Zeiger auf die NodeList. Dies ist insbesondere dann wichtig, wenn diese Methode innerhalb von foreach zum Einsatz kommt.

Fügt eine neue Node nach einer bestimmten Node ein.

Diese Methode ändert bestehende Index und verändert den internen Zeiger auf die NodeList. Dies ist insbesondere dann wichtig, wenn diese Methode innerhalb von foreach zum Einsatz kommt.

Anzahl der Nodes (Implementierung des Countable-Interfaces)

Liste der Nodes der aktuellen (current) Node Vor dem Aufruf dieser Methode muss mit NodeList::hasChildren geprüft werden ob die aktuelle Node Kinder hat

Implementierung für RecursiveIterator.

Ist die Liste Leer so wird eine leere neue NodeList zurückgegeben.

Hat die aktuelle (current) Node in der Liste Kinder?

Implementierung für RecursiveIterator.

Suche nach Nodes anhand eines Constrait.

Diese Methode verändert den internen Zeiger auf die NodeList. Dies ist insbesondere dann wichtig, wenn diese Methode innerhalb von foreach zum Einsatz kommt.

Das nachfolgende Beispiel gibt eine NodeList mit der Node id3 und der Node id6 aus.

$nodeList = new NodeList();
$div = new \Alvine\Types\Node('id1', 'value1');
$div->appendChild(new \Alvine\Types\Node('id2', 'value2'));
$div->appendChild(new \Alvine\Types\Node('id3', 'value3'));
$nodeList->appendNode($div);

$div = new \Alvine\Types\Node('id4', 'value1');
$div->appendChild(new \Alvine\Types\Node('id5', 'value2'));
$div->appendChild(new \Alvine\Types\Node('id6', 'value3'));
$nodeList->appendNode($div);

$find = $nodeList->find(new Alvine\Types\Node\Constraint\Value('value3'));
foreach($find AS $n) {
    echo $n->getName()."\n";
}

Position des internen Zeigers setzen. Die erste Position ist die 0, falls die Indexe nicht numerisch sind (ArrayAccess) so ist die Position unterschiedlich zum Index.

Biespiel mit alphanumerischem Index

Pos  Index
  0  0
  1  abc
  2  1
  3  2
  4  index0

$obj->seek(2); // auf Position 2 setzen
echo $obj->key(); // Ausgabe 1

$obj->seek(4); // auf Position 2 setzen
echo $obj->key(); // Ausgabe index0

Implementierung des SeekableIterator Interfaces

Gibt Nodes, inkl. der Kinder zurück, als Linefeed wird \n verwendet.

Die XML enthält keine Preamble.