Element
class Element extends Node
Element
Die Klasse Element bildet eine XML-Element ab und ist von Node abgeleitet.
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. |
NODE |
Node ist ein Node |
ELEMENT |
Node ist ein Element |
DOCUMENT |
Node ist ein Dokument |
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 | from Node | |
protected string | $tag | from Node | |
protected NodeList | $children | from Node | |
protected Node | $parent | from Node | |
protected integer | $level | from Node | |
protected integer | $type | from Node | |
protected AttributeMap | $attributes | from Node |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Diese Methode setzt Werte der Klasse über den Klassenoperator
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Über diese magische Funktion wird der Zugriff auf diese Node und die Kindelemente über den Objekt-Operator -> geregelt.
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.
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 Node-Objekt
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.
Diese Methode prüft, ob die übergebene Node identisch mit dieser Node oder einem der Kinder ist.
Da der Level im Objekt von außen gesetzt wird, kann dieser Wert von dem tatsächlichen abweichen.
Die aktuellen Kinder werden durch die übergebenen Kinder vollständig ersetzt.
Löscht alle Kindelemente in dem eine neue NodeListe über die Funktion Node::getNewNodeList() erstellt wird.
Diese Methode analysiert und setzt für das Objekt eine XML-Zeichenkette.
Erstellt eine Node aus einer XML-Zeichenkette
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.
in Node at line 373
string
__toString()
Liefert das XML-Dokument als Zeichenkette zurück
in Node at line 342
void
__set(string $name, mixed $value)
Diese Methode setzt Werte der Klasse über den Klassenoperator
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 Node at line 324
mixed
__get(string $name)
Über diese magische Funktion wird der Zugriff auf diese Node und die Kindelemente über den Objekt-Operator -> geregelt.
Je nach Name unterscheidet sich die Wirkungsweise.
$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;
// auf die XML-Zeichenkette kann mit dem Schlüsselwort xml zugegriffen werden.
echo $obj->xml;
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
in Node at line 531
__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();
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 45
__construct(string $tag = null, mixed $value = '', array|null|AttributeMap $attributes = null)
Erstellt ein neues Node-Objekt
in Node at line 96
__destruct()
Referenzen auflösen und GC starten
in Node at line 131
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.
in Node at line 182
protected NodeList
getNewNodeList()
Nodelist
Eigene Nodelist mit erweiterten Funktionen für die Kindelemente bereitstellen
in Node at line 176
mixed
getValue()
Der Wert holen
in Node at line 185
string
getName()
Den Tag abfragen
in Node at line 235
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.
in Node at line 268
NodeList
getChildren(string $name = null)
Kinder
Die Kinder der Node abfragen. Wird ein Tag angegeben, so werden nur Kinder mit diesem Tag zurückgegeben.
in Node at line 282
integer
getLevel()
Da der Level im Objekt von außen gesetzt wird, kann dieser Wert von dem tatsächlichen abweichen.
in Node at line 294
Node
setChildren(NodeList $children)
Die aktuellen Kinder werden durch die übergebenen Kinder vollständig ersetzt.
in Node at line 372
protected NodeList
getChildNodeListByTagName(string $name)
getChildNodeListByTagName
Erstellt eine NodeList mit allen Kindelemente der ersten Ebene, die den entsprechenden Tagnamen besitzen.
in Node at line 394
void
rewind()
Implementierung des Iteration Interfaces.
Internen Zähler zurücksetzen.
in Node at line 403
string
current()
Implementierung des Iteration Interfaces.
in Node at line 412
string
key()
Implementierung des Iteration Interfaces.
in Node at line 421
mixes
next()
Implementierung des Iteration Interfaces.
in Node at line 430
boolean
valid()
Implementierung des Iteration Interfaces.
in Node at line 440
offsetSet(simple $index, Node $node)
Implementierung des ArrayAccess Interfaces.
in Node at line 451
boolean
offsetExists(simple $index)
Implementierung des ArrayAccess Interfaces.
in Node at line 460
offsetUnset(simple $index)
Implementierung des ArrayAccess Interfaces.
in Node at line 489
removeIndex(integer $index)
Löscht ein Kinder-Element
in Node at line 518
Node
truncate()
Löscht alle Kindelemente in dem eine neue NodeListe über die Funktion Node::getNewNodeList() erstellt wird.
in Node at line 564
boolean
hasChildNodes()
Prüft ob Kinder verfügbar sind
in Node at line 573
boolean
hasChildren()
Alias für hasChildNodes
in Node at line 585
Node
insertAt(integer $index, Node $newNode)
Fügt ein Kind an der definierten Stelle ein
in Node at line 598
bolean
isSameNode(Node $node)
Prüft ob diese Node identisch zu der übergebenen ist
in Node at line 610
Node
insertBefore(Node $newNode, Node $reference)
Fügt eine neue Node vor einer bestimmten Node ein.
in Node at line 623
Node
insertAfter(Node $newNode, Node $reference)
Fügt eine neue Node nach einer bestimmten Node ein.
in Node at line 658
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"; }
in Node at line 125
integer
getType()
Gibt den Typ der Node zurück
in Node at line 134
string
getTag()
Alias auf getName
in Node at line 158
string
getAttributeValue(string $name)
Den Wert eines Attributes abfragen
in Node at line 191
AttributeMap
getAttributes()
AttributeMap
in Node at line 202
string
getXML()
getXML
Gibt XML, inkl. der Kinder zurück, als Linefeed wird \n verwendet.
in Node at line 255
Document
setXML(string $xml, string $encoding = null)
Diese Methode analysiert und setzt für das Objekt eine XML-Zeichenkette.
in Node at line 271
static Document
getNodeFromString(string $tag, string $xml, string $encoding = null)
Erstellt eine Node aus einer XML-Zeichenkette
in Node at line 299
protected string
getElementClass(string $tag)
Element
Abgeleitete Klassen können diese Methode überschreiben und anhand des Tags prüfen, welche von Node abgeleitete Klasse für die Objekte die mittels Node::parseXMLStruct() verwendet werden soll.
protected function getElementClass($tag) {
if($tag==='myTag') return '\MyTagClass';
retrun '\Alvine\Xml\Element'
}
Tritt der Tag myTag auf, so ist die Node nicht vom Type Element, sondern vom Typ MyTagClass. MyTagClass muss von Element abgeleitet sein.
in Node at line 393
protected Parser
getParser()
Liefert ein neues Parser Objekt zurück
Diese Funktion wird bei XML Elementen überschrieben und kann zum Beispiel für das setzten eines Namespaces verwendet werden
Wenn die Node die Methode getInjectedParser implementiert hat, wird diese aufgerufen.
protected function getParser(){
return (new \Alvine\Xml\Parser())->addSearchNamespace('\Alvine\Payment\Amazon\Element\');
}