class Node extends Any implements Iterator, ArrayAccess, RecursiveIterator, OuterIterator

Nodes erlauben die Verwaltung von Baumstrukturen.

Von Nodes sind zum einen die XML-Klassen als auch die HTML Komponente abgeleitet.

$node = new Node();
$node->appendChild(new Node());

Die Klasse implementiert das Interface RecursiveIterator, über das die Node rekursive durchsucht werden kann.

$iteratorIterator = new \RecursiveIteratorIterator($node->getChildren(), \RecursiveIteratorIterator::SELF_FIRST, \RecursiveIteratorIterator::CATCH_GET_CHILD);
foreach($iteratorIterator as $node) {
  // ...
}

Traits

SerializableImplementation

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 string $value
protected string $tag
protected NodeList $children
protected Node $parent
protected integer $level

Methods

string
serialize()

Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.

bool
hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

bool
hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

checkAndAdjustSerialisation(array $serialization)

Umgang mit Versionen

void
unserialize(string $serialized)

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

string
__toString()

Liefert einen Zeichenkette zurück

void
__set(string $name, mixed $value)

Magischer Setter

boolean
__isset(string $name)

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

from Alvine
__unset(string $name)

Zurücksetzen von Werten

from Alvine
mixed
__get(string $name)

Über diese magische Funktion wird der Zugriff auf diese Node und die Kindelemente über den Objekt-Operator -> geregelt.

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.

from Alvine
boolean
propertyExists(string $name)

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

from Alvine
mixed
__call(string $name, array $arguments)

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

from Alvine
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).

from Alvine
string
getHashCode() deprecated

Die Methode Alvine::getID() verwenden!

from Alvine
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.

from Alvine
string
getShortID(int|null $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.

from Alvine
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.

from Alvine
Alvine
getClone(boolean $deepClone = false)

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

from Alvine
__clone()

Erstellt eine Kopie dieser Node.

string
getClass()

Name der Klasse

from Alvine
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.

from Alvine
__construct(string $name, mixed $value = null)

Erstellt ein neues Node-Objekt

__destruct()

Referenzen auflösen und GC starten

appendChild(Node $node)

Neue Node als Kind einhängen

replaceChildren(Node $search, Node $replace)

Diese Methode ersetzt die Node $search in der Liste der Kinder mit der neuen Node $replace. Ist die Node mehrfach vorhanden so wird diese mehrfach ersetzt. Die Prüfung erfolgt über die Methode Node::equals. Ist die Node nicht vorhanden, so wird diese nicht ersetzt.

getNewNodeList()

Um die richtige NodeList, für abgeleitete Klassen zu erstellen wird bei allen Methoden die Nodelist über diese interne Methode erstellt. Abgeleitete Klassen, können hier eine eigene NodeList erstellen lassen.

setValue(mixed $value)

Den Wert der Node setzen.

mixed
getValue()

Der Wert holen

string
getName()

Den Tag abfragen

setParent(Node $parent)

Die Eltern-Node einer Node setzen

unsetParent()

ElternNode entfernen

boolean
containsNode(Node $node)

Diese Methode prüft, ob die übergebene Node identisch mit dieser Node oder einem der Kinder ist.

getParent()

Die Eltern-Node abfragen

getChildren(string $name = null)

Kinder

integer
getLevel()

Da der Level im Objekt von außen gesetzt wird, kann dieser Wert von dem tatsächlichen abweichen.

setChildren(NodeList $children)

Die aktuellen Kinder werden durch die übergebenen Kinder vollständig ersetzt.

getChildNodeListByTagName(string $name)

getChildNodeListByTagName

void
rewind()

Implementierung des Iteration Interfaces.

string
current()

Implementierung des Iteration Interfaces.

string
key()

Implementierung des Iteration Interfaces.

mixes
next()

Implementierung des Iteration Interfaces.

boolean
valid()

Implementierung des Iteration Interfaces.

offsetSet(simple $index, Node $node)

Implementierung des ArrayAccess Interfaces.

boolean
offsetExists(simple $index)

Implementierung des ArrayAccess Interfaces.

offsetUnset(simple $index)

Implementierung des ArrayAccess Interfaces.

offsetGet(simple $index)

Implementierung des ArrayAccess Interfaces.

removeIndex(integer $index)

Löscht ein Kinder-Element

removeChild(Node $node)

Kind entfernen

truncate()

Löscht alle Kindelemente in dem eine neue NodeListe über die Funktion Node::getNewNodeList() erstellt wird.

getFirstChild()

Liefert das erste Kind zurück

getLastChild()

Liefert das letzte Kind zurück

boolean
hasChildNodes()

Prüft ob Kinder verfügbar sind

boolean
hasChildren()

Alias für hasChildNodes

insertAt(integer $index, Node $newNode)

Fügt ein Kind an der definierten Stelle ein

bolean
isSameNode(Node $node)

Prüft ob diese Node identisch zu der übergebenen ist

insertBefore(Node $newNode, Node $reference)

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

insertAfter(Node $newNode, Node $reference)

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

getInnerIterator()

Innerer Iterator

find(Constraint $constrait)

Suche nach Nodes anhand eines Constrait.

Details

string serialize()

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.

Return Value

string String-Repräsentation des Objektes

bool hasAssociatedProperties()

Prüfen ob das Objekt associative Eigenschaften besitzt

Return Value

bool

bool hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt

Return Value

bool

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.

Parameters

array $serialization Daten des serialisiertes Objekts

Exceptions

UnserializeException Keine Übereinstimmung

void unserialize(string $serialized)

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

Parameters

string $serialized

Return Value

void

at line 478
string __toString()

Liefert einen Zeichenkette zurück

Return Value

string Daten des Objekts

at line 345
void __set(string $name, mixed $value)

Magischer Setter

Diese Methode setzt Werte der Klasse über den Klassenoperator, dabei muss die Eigenschft identisch mit dem Tagnamen sein.

$obj = new Node('mytag');
$obj->mytag='hallo'

Parameters

string $name Name der Eigenschaft
mixed $value Wert der Eigenschaft

Return Value

void

in Alvine at line 222
boolean __isset(string $name)

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

Parameters

string $name

Return Value

boolean

in Alvine at line 231
__unset(string $name)

Zurücksetzen von Werten

Parameters

string $name

at line 319
mixed __get(string $name)

Über diese magische Funktion wird der Zugriff auf diese Node und die Kindelemente über den Objekt-Operator -> geregelt.

Anders als der Setter wird kein Value gesetzt.

Diese Methode liefert in einem Fall eine Node und im anderen Fall eine NodeList.

$obj = new Node('parent');
$obj->appendChild(new Node('child'));
// Über den Tagnamen erhält man eine Referenz auf das Objekt ($obj->parent) ist identisch zu $obj)
echo (string) $obj->parent;
// Zugriff auf die Kinder liefert NodeList zurück (beide Aufrufe sind gleichbedeutend)
echo $obj->parent->child;
echo $obj->child;

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

in Alvine at line 281
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.

Parameters

string $name Name des Closure

Return Value

Closure

Exceptions

NotFoundException
BadPropertyException

in Alvine at line 307
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;
}

Parameters

string $name Name der Eigenschaft

Return Value

boolean

in Alvine at line 339
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!

Parameters

string $name Funktionsname
array $arguments Argumente

Return Value

mixed Ergebnis des Callbacks

Exceptions

NotCallableException Exception

in Alvine at line 362
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();
}

Parameters

type $name Name der Methode

Return Value

boolean Ergebnis

in Alvine at line 376
string getHashCode() deprecated

deprecated 20140611

Die Methode Alvine::getID() verwenden!

Return Value

string Hashwert des Objektes

in Alvine at line 396
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)

Return Value

string UUID des Objektes

in Alvine at line 416
string getShortID(int|null $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 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.

Parameters

int|null $length

Return Value

string

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

Parameters

Alvine $object Objekt das überprüft werden soll

Return Value

boolean true wenn beide Objekte identisch sind.

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

Parameters

boolean $deepClone Clone aller enthaltenen Objekte

Return Value

Alvine

See also

Alvine::__clone

at line 529
__clone()

Erstellt eine Kopie dieser Node.

Auch alle Kinder weden dabei kopiert.

Das Klonen setzt den internen Zeiger auf der Liste neu (wichtig innerhalb eines Iterators)

in Alvine at line 493
string getClass()

Name der Klasse

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

echo $obj->getClass();

Return Value

string Klassenname

See also

ClassType::getNormalizedName

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

Parameters

object $object

Return Value

boolean

at line 85
__construct(string $name, mixed $value = null)

Erstellt ein neues Node-Objekt

Parameters

string $name Name
mixed $value Wert

at line 94
__destruct()

Referenzen auflösen und GC starten

at line 111
Node appendChild(Node $node)

Neue Node als Kind einhängen

Parameters

Node $node Anzuhängende Node

Return Value

Node Dieses Objekt

at line 129
Node replaceChildren(Node $search, Node $replace)

Diese Methode ersetzt die Node $search in der Liste der Kinder mit der neuen Node $replace. Ist die Node mehrfach vorhanden so wird diese mehrfach ersetzt. Die Prüfung erfolgt über die Methode Node::equals. Ist die Node nicht vorhanden, so wird diese nicht ersetzt.

Parameters

Node $search Zu ersetzende Node
Node $replace Neue Node

Return Value

Node Dieses Objekt

at line 153
protected NodeList getNewNodeList()

Um die richtige NodeList, für abgeleitete Klassen zu erstellen wird bei allen Methoden die Nodelist über diese interne Methode erstellt. Abgeleitete Klassen, können hier eine eigene NodeList erstellen lassen.

Return Value

NodeList Neue NodeList zur internen Verwendung

at line 164
Node setValue(mixed $value)

Den Wert der Node setzen.

Parameters

mixed $value Wert

Return Value

Node Dieses Objekt

at line 174
mixed getValue()

Der Wert holen

Return Value

mixed Wert

at line 183
string getName()

Den Tag abfragen

Return Value

string Tag

at line 194
Node setParent(Node $parent)

Die Eltern-Node einer Node setzen

Parameters

Node $parent

Return Value

Node Diese Node

at line 213
Node unsetParent()

ElternNode entfernen

Return Value

Node

at line 233
boolean containsNode(Node $node)

Diese Methode prüft, ob die übergebene Node identisch mit dieser Node oder einem der Kinder ist.

Diese Methode arbeitet anders als andere Methoden dieser Klasse rekursive.

Als Vergleichsfunktion wird Node::equals() verwendet.

Parameters

Node $node Node

Return Value

boolean Ergebnis

at line 251
Node getParent()

Die Eltern-Node abfragen

Return Value

Node Eltern-Node

at line 266
NodeList getChildren(string $name = null)

Kinder

Die Kinder der Node abfragen. Wird ein Tag angegeben, so werden nur Kinder mit diesem Tag zurückgegeben.

Parameters

string $name Name des Tags

Return Value

NodeList Array mit den einzelnen Nodes

at line 280
integer getLevel()

Da der Level im Objekt von außen gesetzt wird, kann dieser Wert von dem tatsächlichen abweichen.

Return Value

integer Level

at line 292
Node setChildren(NodeList $children)

Die aktuellen Kinder werden durch die übergebenen Kinder vollständig ersetzt.

Parameters

NodeList $children Neue Kinder

Return Value

Node Diese Node

at line 370
protected NodeList getChildNodeListByTagName(string $name)

getChildNodeListByTagName

Erstellt eine NodeList mit allen Kindelemente der ersten Ebene, die den entsprechenden Tagnamen besitzen.

Parameters

string $name Name des Tag

Return Value

NodeList Ergebnisliste

at line 392
void rewind()

Implementierung des Iteration Interfaces.

Internen Zähler zurücksetzen.

Return Value

void

at line 401
string current()

Implementierung des Iteration Interfaces.

Return Value

string aktuelles String-Objekt

at line 410
string key()

Implementierung des Iteration Interfaces.

Return Value

string Keys

at line 419
mixes next()

Implementierung des Iteration Interfaces.

Return Value

mixes nächster Eintrag

at line 428
boolean valid()

Implementierung des Iteration Interfaces.

Return Value

boolean Status der Iteration

at line 438
offsetSet(simple $index, Node $node)

Implementierung des ArrayAccess Interfaces.

Parameters

simple $index Index
Node $node Node

at line 449
boolean offsetExists(simple $index)

Implementierung des ArrayAccess Interfaces.

Parameters

simple $index Index

Return Value

boolean true/false

at line 458
offsetUnset(simple $index)

Implementierung des ArrayAccess Interfaces.

Parameters

simple $index Index

at line 469
Node offsetGet(simple $index)

Implementierung des ArrayAccess Interfaces.

Parameters

simple $index Index

Return Value

Node

at line 487
removeIndex(integer $index)

Löscht ein Kinder-Element

Parameters

integer $index

at line 498
Node removeChild(Node $node)

Kind entfernen

Parameters

Node $node

Return Value

Node

at line 516
Node truncate()

Löscht alle Kindelemente in dem eine neue NodeListe über die Funktion Node::getNewNodeList() erstellt wird.

Return Value

Node

at line 544
Node getFirstChild()

Liefert das erste Kind zurück

Return Value

Node Erstes Kind

at line 553
Node getLastChild()

Liefert das letzte Kind zurück

Return Value

Node Letztes Kind

at line 562
boolean hasChildNodes()

Prüft ob Kinder verfügbar sind

Return Value

boolean true/false

at line 571
boolean hasChildren()

Alias für hasChildNodes

Return Value

boolean true/false

at line 583
Node insertAt(integer $index, Node $newNode)

Fügt ein Kind an der definierten Stelle ein

Parameters

integer $index Definierte Stelle
Node $newNode Neue Node

Return Value

Node dieses Objekt

at line 596
bolean isSameNode(Node $node)

Prüft ob diese Node identisch zu der übergebenen ist

Parameters

Node $node Node

Return Value

bolean true/false

at line 608
Node insertBefore(Node $newNode, Node $reference)

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

Parameters

Node $newNode Eine Node vor einer anderen einfügen
Node $reference Node, vor der die neue Node eingefügt werden soll

Return Value

Node Diese Node

at line 621
Node insertAfter(Node $newNode, Node $reference)

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

Parameters

Node $newNode Eine Node vor einer anderen einfügen
Node $reference Node, vor der die neue Node eingefügt werden soll

Return Value

Node Diese Node

at line 631
NodeList getInnerIterator()

Innerer Iterator

Return Value

NodeList

at line 656
NodeList find(Constraint $constrait)

Suche nach Nodes anhand eines Constrait.

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

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

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

Parameters

Constraint $constrait

Return Value

NodeList