NodeList
class NodeList extends Any implements Iterator, ArrayAccess, Countable, RecursiveIterator, SeekableIterator
Mit der Nodelist können Nodes die auf der gleichen Ebene liegen zusammengefasst werden. Die NodeList bildet auch die Grundlage für die Kindelemente des Baums.
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. |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
protected array | $nodes |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Liefert eine 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.
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.
Erstellt eine Kopie dieser Node.
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 NodeList-Objekt
Referenzen auflösen
Alles Nodes als Array zurückgeben
Implementierung des Iteration Interfaces.
Implementierung des Iteration Interfaces.
Implementierung des Iteration Interfaces.
Implementierung des Iteration 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
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
Hat die aktuelle (current) Node in der Liste Kinder?
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.
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 187
string
__toString()
Liefert eine Zeichenkette zurück
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
at line 222
__clone()
Erstellt eine Kopie dieser Node.
Auch alle Kinder der Nodes weden dabei kopiert.
Das Klonen setzt den Index der Nodes neu.
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 48
__construct()
Erstellt ein neues NodeList-Objekt
at line 55
__destruct()
Referenzen auflösen
at line 79
array
getNodesAsArray()
Alles Nodes als Array zurückgeben
at line 89
NodeList
rewind()
Implementierung des Iteration Interfaces.
Internen Zähler zurücksetzen.
at line 99
string
current()
Implementierung des Iteration Interfaces.
at line 109
string|null
key()
Implementierung des Iteration Interfaces.
Null, wenn der Pointer am Ende ist
at line 118
mixes
next()
Implementierung des Iteration Interfaces.
at line 127
boolean
valid()
Implementierung des Iteration Interfaces.
at line 138
offsetSet(mixed $index, Node $node)
Implementierung des ArrayAccess Interfaces.
at line 155
boolean
offsetExists(mixed $index)
Implementierung des ArrayAccess Interfaces.
at line 164
offsetUnset(mixed $index)
Implementierung des ArrayAccess Interfaces.
at line 176
Node
offsetGet(mixed $index)
Implementierung des ArrayAccess Interfaces.
at line 204
removeIndex(mixed $index)
Löscht ein Nodes aus der Liste
at line 212
truncate()
Löscht alle Nodes
at line 233
Node|false
getFirstNode()
Liefert die erste Node zurück
at line 242
Node|false
getLastNode()
Liefert die letzte Node zurück
at line 251
boolean
hasNodes()
Prüft ob Nodes verfügbar sind
at line 268
NodeList
insertAt(integer $index, Node $newNode)
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.
at line 301
NodeList
insertBefore(Node $newNode, Node $reference)
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.
at line 325
NodeList
insertAfter(Node $newNode, Node $reference)
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.
at line 340
integer
count()
Anzahl der Nodes (Implementierung des Countable-Interfaces)
at line 356
NodeList
getChildren()
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.
at line 369
boolean
hasChildren()
Hat die aktuelle (current) Node in der Liste Kinder?
Implementierung für RecursiveIterator.
at line 407
NodeList
find(Constraint $constrait)
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"; }
at line 447
seek(integer $position)
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