class NodeList extends NodeList

XmlNodeList

Die Klasse XmlNodeList bildet eine XML-Node-Liste ab.

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 array $nodes from NodeList

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 das XML-Dokument als Zeichenkette zurück

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.

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

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.

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

from NodeList
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()

Erstellt ein neues NodeList-Objekt

from NodeList
__destruct()

Referenzen auflösen

from NodeList
appendNode(Node $node)

Neue Node als Kind einhängen

from NodeList
array
getNodesAsArray()

Alles Nodes als Array zurückgeben

from NodeList
rewind()

Implementierung des Iteration Interfaces.

from NodeList
string
current()

Implementierung des Iteration Interfaces.

from NodeList
string|null
key()

Implementierung des Iteration Interfaces.

from NodeList
mixes
next()

Implementierung des Iteration Interfaces.

from NodeList
boolean
valid()

Implementierung des Iteration Interfaces.

from NodeList
offsetSet(mixed $index, Node $node)

Implementierung des ArrayAccess Interfaces.

from NodeList
boolean
offsetExists(mixed $index)

Implementierung des ArrayAccess Interfaces.

from NodeList
offsetUnset(mixed $index)

Implementierung des ArrayAccess Interfaces.

from NodeList
offsetGet(mixed $index)

Implementierung des ArrayAccess Interfaces.

from NodeList
removeIndex(mixed $index)

Löscht ein Nodes aus der Liste

from NodeList
truncate()

Löscht alle Nodes

from NodeList
Node|false
getFirstNode()

Liefert die erste Node zurück

from NodeList
Node|false
getLastNode()

Liefert die letzte Node zurück

from NodeList
boolean
hasNodes()

Prüft ob Nodes verfügbar sind

from NodeList
insertAt(integer $index, Node $newNode)

Fügt eine Node an der definierten Stelle ein

from NodeList
insertBefore(Node $newNode, Node $reference)

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

from NodeList
insertAfter(Node $newNode, Node $reference)

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

from NodeList
integer
count()

Anzahl der Nodes (Implementierung des Countable-Interfaces)

from 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

from NodeList
boolean
hasChildren()

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

from NodeList
find(Constraint $constrait)

Suche nach Nodes anhand eines Constrait.

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

from NodeList
string
getXML()

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

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 52
string __toString()

Liefert das XML-Dokument als Zeichenkette zurück

Return Value

string Daten des Objekts

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

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

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

Parameters

string $name Name der Eigenschaft

Return Value

mixed Wert der Eigenschaft

Exceptions

BadPropertyException

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

in NodeList at line 220
__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();

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

in NodeList at line 46
__construct()

Erstellt ein neues NodeList-Objekt

in NodeList at line 53
__destruct()

Referenzen auflösen

in NodeList at line 67
NodeList appendNode(Node $node)

Neue Node als Kind einhängen

Parameters

Node $node Anzuhängende Node

Return Value

NodeList Dieses Objekt

in NodeList at line 77
array getNodesAsArray()

Alles Nodes als Array zurückgeben

Return Value

array Array mit den einzelnen Nodes

in NodeList at line 87
NodeList rewind()

Implementierung des Iteration Interfaces.

Internen Zähler zurücksetzen.

Return Value

NodeList

in NodeList at line 97
string current()

Implementierung des Iteration Interfaces.

Return Value

string aktuelles String-Objekt

in NodeList at line 107
string|null key()

Implementierung des Iteration Interfaces.

Null, wenn der Pointer am Ende ist

Return Value

string|null Keys

in NodeList at line 116
mixes next()

Implementierung des Iteration Interfaces.

Return Value

mixes nächster Eintrag

in NodeList at line 125
boolean valid()

Implementierung des Iteration Interfaces.

Return Value

boolean Status der Iteration

in NodeList at line 136
offsetSet(mixed $index, Node $node)

Implementierung des ArrayAccess Interfaces.

Parameters

mixed $index Index
Node $node Node

in NodeList at line 153
boolean offsetExists(mixed $index)

Implementierung des ArrayAccess Interfaces.

Parameters

mixed $index

Return Value

boolean

in NodeList at line 162
offsetUnset(mixed $index)

Implementierung des ArrayAccess Interfaces.

Parameters

mixed $index

in NodeList at line 174
Node offsetGet(mixed $index)

Implementierung des ArrayAccess Interfaces.

Parameters

mixed $index Index

Return Value

Node

in NodeList at line 202
removeIndex(mixed $index)

Löscht ein Nodes aus der Liste

Parameters

mixed $index

in NodeList at line 210
truncate()

Löscht alle Nodes

in NodeList at line 231
Node|false getFirstNode()

Liefert die erste Node zurück

Return Value

Node|false Erstes Kind oder false, wenn kein Kind verfügbar

in NodeList at line 240
Node|false getLastNode()

Liefert die letzte Node zurück

Return Value

Node|false Letztes Kind oder false, wenn kein Kind verfügbar

in NodeList at line 249
boolean hasNodes()

Prüft ob Nodes verfügbar sind

Return Value

boolean true/false

in NodeList at line 266
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.

Parameters

integer $index Definierte Stelle
Node $newNode Neue Node

Return Value

NodeList Dieses Objekt

in NodeList at line 299
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.

Parameters

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

Return Value

NodeList

in NodeList at line 323
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.

Parameters

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

Return Value

NodeList

in NodeList at line 338
integer count()

Anzahl der Nodes (Implementierung des Countable-Interfaces)

Return Value

integer Anzahl der Elemente

in NodeList at line 354
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.

Return Value

NodeList

in NodeList at line 367
boolean hasChildren()

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

Implementierung für RecursiveIterator.

Return Value

boolean

in NodeList at line 405
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";
}

Parameters

Constraint $constrait

Return Value

NodeList

in NodeList at line 445
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

Parameters

integer $position

Exceptions

OutOfBoundsException

at line 41
string getXML()

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

Die XML enthält keine Preamble.

Return Value

string XML