Documentation

NodeList extends NodeList
in package

Alvine

Xml

XmlNodeList

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

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
SERIALVERSION = 1: 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.
VERSION = 2: Generelle Alvine-Version

Properties

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$nodes : array
$properties : array

Methods

__call() : mixed: Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone() : mixed: 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.
__construct() : mixed: Erstellt ein neues NodeList-Objekt
__destruct() : mixed: Referenzen auflösen
__get() : mixed: 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.
__isset() : boolean: Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize() : array<string|int, mixed>: Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set() : void: Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString() : string: Liefert das XML-Dokument als Zeichenkette zurück
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
appendNode() : NodeList: Neue Node als Kind einhängen
count() : integer: Anzahl der Nodes (Implementierung des Countable-Interfaces)
current() : string: Implementierung des Iteration Interfaces.
equals() : boolean: 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.
find() : NodeList: Suche nach Nodes anhand eines Constrait.
getChildren() : NodeList: 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
getClass() : string: Name der Klasse
getClone() : Alvine: Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure() : Closure: 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.
getFirstNode() : Node|false: Liefert die erste Node zurück
getHashCode() : string: Die Methode Alvine::getID() verwenden!
getID() : string: Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getLastNode() : Node|false: Liefert die letzte Node zurück
getNodesAsArray() : array: Alles Nodes als Array zurückgeben
getShortID() : string: 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.
getXML() : string: Gibt Nodes, inkl. der Kinder zurück, als Linefeed wird \n verwendet.
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasChildren() : boolean: Hat die aktuelle (current) Node in der Liste Kinder?
hasNodes() : boolean: Prüft ob Nodes verfügbar sind
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
insertAfter() : NodeList: Fügt eine neue Node nach einer bestimmten Node ein.
insertAt() : NodeList: Fügt eine Node an der definierten Stelle ein
insertBefore() : NodeList: Fügt eine neue Node vor einer bestimmten Node ein.
isCallable() : bool: Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isInstanceOf() : boolean: 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.
key() : string|null: Implementierung des Iteration Interfaces.
next() : mixes: Implementierung des Iteration Interfaces.
offsetExists() : boolean: Implementierung des ArrayAccess Interfaces.
offsetGet() : Node: Implementierung des ArrayAccess Interfaces.
offsetSet() : void: Implementierung des ArrayAccess Interfaces.
offsetUnset() : void: Implementierung des ArrayAccess Interfaces.
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
removeIndex() : mixed: Löscht ein Nodes aus der Liste
rewind() : NodeList: Implementierung des Iteration Interfaces.
seek() : void: 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.
truncate() : mixed: Löscht alle Nodes
valid() : boolean: Implementierung des Iteration Interfaces.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

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.


    public
        mixed
    SERIALVERSION
    = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$hash

Eindeutige ID


    protected
        string
    $hash
     = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$nodes


    protected
        array
    $nodes
     = []

Liste mit Nodes

$properties


    protected
        array
    $properties
     = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

__call()

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


    public
                    __call(string $name, array $arguments) : mixed

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

$name : string: Funktionsname
$arguments : array: Argumente

Return values

mixed —

Ergebnis des Callbacks

__clone()

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.


    public
                    __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__construct()

Erstellt ein neues NodeList-Objekt


    public
                    __construct() : mixed

__destruct()

Referenzen auflösen


    public
                    __destruct() : mixed

__get()

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.


    public
                    __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

$name : string: Name der Eigenschaft

Return values

mixed —

Wert der Eigenschaft

__isset()

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


    public
                    __isset(string $name) : boolean

Parameters

$name : string

Return values

boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.


    public
                    __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Return values

array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.


    public
                    __set(string $name, mixed $value) : void

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

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

Return values

void

__toString()

Liefert das XML-Dokument als Zeichenkette zurück


    public
                    __toString() : string

Return values

string —

Zeichenkette

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

appendNode()

Neue Node als Kind einhängen


    public
                    appendNode(Node $node) : NodeList

Parameters

$node : Node: Anzuhängende Node

Return values

NodeList —

Dieses Objekt

count()

Anzahl der Nodes (Implementierung des Countable-Interfaces)


    public
                    count() : integer

Return values

integer —

Anzahl der Elemente

current()

Implementierung des Iteration Interfaces.


    public
                    current() : string

Return values

string —

aktuelles String-Objekt

equals()

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.


    public
                    equals(Alvine $object) : boolean

class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}

Parameters

$object : Alvine: Objekt das überprüft werden soll

Return values

boolean —

true wenn beide Objekte identisch sind.

find()

Suche nach Nodes anhand eines Constrait.


    public
                    find(Constraint $constrait) : NodeList

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

$constrait : Constraint

Return values

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


    public
                    getChildren() : NodeList

Implementierung für RecursiveIterator.

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

Return values

NodeList

getClass()

Name der Klasse


    public
                    getClass() : string

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

echo $obj->getClass();

Return values

string —

Klassenname

getClone()

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


    public
                    getClone([boolean $deepClone = false ]) : Alvine

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

$deepClone : boolean = false: Clone aller enthaltenen Objekte

Return values

Alvine

getClosure()

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.


    public
                    getClosure(string $name) : Closure

Parameters

$name : string: Name des Closure

Return values

Closure

getFirstNode()

Liefert die erste Node zurück


    public
                    getFirstNode() : Node|false

Return values

Node|false —

Erstes Kind oder false, wenn kein Kind verfügbar

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

Return values

string —

Hashwert des Objektes

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.


    public
                    getID() : string

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 values

string —

UUID des Objektes

getLastNode()

Liefert die letzte Node zurück


    public
                    getLastNode() : Node|false

Return values

Node|false —

Letztes Kind oder false, wenn kein Kind verfügbar

getNodesAsArray()

Alles Nodes als Array zurückgeben


    public
                    getNodesAsArray() : array

Return values

array —

Array mit den einzelnen Nodes

getShortID()

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.


    public
                    getShortID([int|null $length = null ]) : string

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

$length : int|null = null

Return values

string

getXML()

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


    public
                    getXML() : string

Die XML enthält keine Preamble.

Return values

string —

XML

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasChildren()

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


    public
                    hasChildren() : boolean

Implementierung für RecursiveIterator.

Return values

boolean

hasNodes()

Prüft ob Nodes verfügbar sind


    public
                    hasNodes() : boolean

Return values

boolean —

true/false

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

insertAfter()

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


    public
                    insertAfter(Node $newNode, Node $reference) : NodeList

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

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

Return values

NodeList

insertAt()

Fügt eine Node an der definierten Stelle ein


    public
                    insertAt(integer $index, Node $newNode) : NodeList

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

$index : integer: Definierte Stelle
$newNode : Node: Neue Node

Return values

NodeList —

Dieses Objekt

insertBefore()

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


    public
                    insertBefore(Node $newNode, Node $reference) : NodeList

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

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

Return values

NodeList

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).


    public
                    isCallable(string $name) : bool

if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}

Parameters

$name : string: Name der Methode

Return values

bool —

Ergebnis

isInstanceOf()

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.


    public
                    isInstanceOf(object $object) : boolean

if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object

Parameters

$object : object

Return values

boolean

key()

Implementierung des Iteration Interfaces.


    public
                    key() : string|null

Null, wenn der Pointer am Ende ist

Return values

string|null —

Keys

next()

Implementierung des Iteration Interfaces.


    public
                    next() : mixes

Return values

mixes —

nächster Eintrag

offsetExists()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetExists(mixed $index) : boolean

Parameters

$index : mixed

Return values

boolean

offsetGet()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetGet(mixed $index) : Node

Parameters

$index : mixed: Index

Return values

Node

offsetSet()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetSet(mixed $index, Node $node) : void

Parameters

$index : mixed: Index
$node : Node: Node

offsetUnset()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetUnset(mixed $index) : void

Parameters

$index : mixed

propertyExists()

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


    public
                    propertyExists(string $name) : boolean

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}

Parameters

$name : string: Name der Eigenschaft

Return values

boolean

removeIndex()

Löscht ein Nodes aus der Liste


    public
                    removeIndex(mixed $index) : mixed

Parameters

$index : mixed

rewind()

Implementierung des Iteration Interfaces.


    public
                    rewind() : NodeList

Internen Zähler zurücksetzen.

Return values

NodeList

seek()

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.


    public
                    seek(integer $position) : void

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

$position : integer

truncate()

Löscht alle Nodes


    public
                    truncate() : mixed

valid()

Implementierung des Iteration Interfaces.


    public
                    valid() : boolean

Return values

boolean —

Status der Iteration

checkAndAdjustSerialisation()

Dealing with versions


    protected
                    checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters

$serialization : array: Daten des serialisiertes Objekts

Return values

array<string|int, mixed>

NodeList extends NodeList in package Alvine Xml

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$nodes

$properties

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

__destruct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

appendNode()

Parameters

Return values

count()

Return values

current()

Return values

equals()

Parameters

Return values

find()

Parameters

Return values

getChildren()

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getFirstNode()

Return values

getHashCode()

Tags

Return values

getID()

Return values

getLastNode()

Return values

NodeList extends NodeList
in package

Alvine

Xml