Element

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.

Prüfen ob das Objekt associative Eigenschaften besitzt

Prüfen ob das Objekt volatile Eigenschaften besitzt

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.

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

Liefert das XML-Dokument als Zeichenkette zurück

Diese Methode setzt Werte der Klasse über den Klassenoperator

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

Zurücksetzen von Werten

Ü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;

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.

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

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!

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();
}

Die Methode Alvine::getID() verwenden!

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)

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.

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

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

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)

Name der Klasse

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

echo $obj->getClass();

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

Erstellt ein neues Node-Objekt

Referenzen auflösen und GC starten

Neue Node als Kind einhängen

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.

Nodelist

Eigene Nodelist mit erweiterten Funktionen für die Kindelemente bereitstellen

Den Wert der Node setzen.

Der Wert holen

Den Tag abfragen

Die Eltern-Node einer Node setzen

ElternNode entfernen

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.

Die Eltern-Node abfragen

Kinder

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

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.

getChildNodeListByTagName

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

Implementierung des Iteration Interfaces.

Internen Zähler zurücksetzen.

Implementierung des Iteration Interfaces.

Implementierung des Iteration Interfaces.

Implementierung des Iteration Interfaces.

Implementierung des Iteration Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Implementierung des ArrayAccess Interfaces.

Löscht ein Kinder-Element

Kind entfernen

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

Liefert das erste Kind zurück

Liefert das letzte Kind zurück

Prüft ob Kinder verfügbar sind

Alias für hasChildNodes

Fügt ein Kind an der definierten Stelle ein

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

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

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

Innerer Iterator

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";
}

Gibt den Typ der Node zurück

Alias auf getName

Ein Attribut setzen

Den Wert eines Attributes abfragen

Attribut entfernen

AttributeMap

getXML

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

Diese Methode analysiert und setzt für das Objekt eine XML-Zeichenkette.

Erstellt eine Node aus einer XML-Zeichenkette

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.

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\\');
}