HierarchicalString
class HierarchicalString extends StringList
Erweiterte Funktionalität für hierarchische Zeichenketten
Mittels der Klasse HierarchicalString können Zeichenketten die hierarchische
Informationen beinhalten (z.B. durch Punktnotation) verarbeitet werden. Das
Nachfolgende Beispiel zeigt ein einfaches Beispiel.
// Neues Objekt erstellen
$string = new \Alvine\Types\HierarchicalString('a.b.c.d');
// Durch alle Teile laufen und diese Ausgeben foreach($string AS $sub) { echo $sub."::"; }
// Ausgabe: a::b::c::d::
//Über die Methoden addChild und removeChild läßt sich //die Struktur einfach bearbeiten. echo ((string)$string)."\n"; // Zeichenkette ausgeben a.b.c.d echo ((string)$string->parent())."\n"; // Eine Ebene nach oben a.b.c echo ((string)$string->addChild('1.2.3'))."\n"; // 3 Ebenen ergänzen a.b.c.1.2.3 echo ((string)$string->addChild('4.'))."\n"; // Eine weitere Ebene a.b.c.1.2.3.4 (Wichtig: der letzte Punkt wird nicht mit ausgegeben) echo ((string)$string->parent(3))." \n"; // Drei Ebenen nach oben a.b.c.1
$string->setSeparator('::'); echo (string)$string;
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. |
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 | $list | from StringList | |
protected string | $separator |
Methods
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Gespeicherte Liste als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8
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 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.
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.
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.
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.
Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multbyte Erweiterung auf UTF-8 umgestellt.
Stringliste aus einem String erstellen, als Parameter kann entweder ein String-Objekt oder ein nativer String übergeben werden.
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück.
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück (Implementierung des Countable-Interfaces)
Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Der bisherige Inhalt des Objektes wird überschrieben.
Setzt das Trennzeichen für die __toString Methode
Gibt de verwendeten Seperator zurück
Objekt mit Elternverzeichnis
Neuen Untereintrag hinzufügen. Es können auch Werte mit Trennzeichen übergeben werden. In dem folgenden Beispiel werden zwei Hirarchieebenen hinzugefügt.
Untervereintrag entfernen
Diese Methode erlaubt es, einen hierarchischen String mit einem anderen String zu vergleichen und auch ein Wildcard * einzusetzen. Werden zwei Sterne als letzte Zeichen angegeben (doppelter Wildcard) so wird auch TRUE zurückgegeben, wenn der Ursprungszeichenkette länger als der Vergleichsstring ist (mehrere Ebenen).
Vorsilbe des Strings holden.
Nachsilbe des Strings holden.
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.
at line 153
string
__toString()
Gespeicherte Liste als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8
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;
in Alvine at line 236
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;
}
in Alvine at line 261
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 287
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 319
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 342
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 356
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 376
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 395
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 421
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 442
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 Alvine at line 454
__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.
Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.
in Alvine at line 472
string
getClass()
Name der Klasse
class MyObject extends Alvine {};
$obj = new MyObject();
echo $obj->getClass();
in Alvine at line 497
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 78
__construct($string = null, $separator = '.')
Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multbyte Erweiterung auf UTF-8 umgestellt.
in StringList at line 65
static StringType
explode(string|StringType $string, string $delimiter)
Stringliste aus einem String erstellen, als Parameter kann entweder ein String-Objekt oder ein nativer String übergeben werden.
in StringList at line 79
string
implode(string $glue = "\r\n")
Strings zusammenfassen
in StringList at line 92
StringList
add(StringType $string)
Neuen String an das Ende der Liste hängen
in StringList at line 103
int
length()
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück.
in StringList at line 114
int
count()
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück (Implementierung des Countable-Interfaces)
in StringList at line 124
void
rewind()
Implementierung des Iteration Interfaces.
Internen Zähler zurücksetzen.
in StringList at line 133
StringType
current()
Implementierung des Iteration Interfaces.
in StringList at line 142
StringType
key()
Implementierung des Iteration Interfaces.
in StringList at line 151
StringType
next()
Implementierung des Iteration Interfaces.
in StringList at line 160
boolean
valid()
Implementierung des Iteration Interfaces.
in StringList at line 170
offsetUnset(mixed $key)
Implementierung des Array-Interfaces
in StringList at line 182
offsetSet(mixed $key, StringType $value)
Implementierung des Array-Interfaces
in StringList at line 199
offsetGet(string $key)
Implementierung des Array-Interfaces
in StringList at line 212
boolean
offsetExists(mixed $key)
Implementierung des Array-Interfaces
in StringList at line 223
array
toArray()
Liste der String-Objekte zurückgeben
at line 96
protected HierarchicalString
analyze(string $string)
Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Der bisherige Inhalt des Objektes wird überschrieben.
at line 117
HierarchicalString
setSeparator(string $separator)
Setzt das Trennzeichen für die __toString Methode
at line 127
string
getSeparator()
Gibt de verwendeten Seperator zurück
at line 138
HierarchicalString
getParent(integer $count = 1)
Objekt mit Elternverzeichnis
at line 176
HierarchicalString
addChild(string|StringType $child)
Neuen Untereintrag hinzufügen. Es können auch Werte mit Trennzeichen übergeben werden. In dem folgenden Beispiel werden zwei Hirarchieebenen hinzugefügt.
$dir->appendChild('verzeichnis1.verzeichnis2');
at line 200
HierarchicalString
removeChild()
Untervereintrag entfernen
at line 243
boolean
match(HierarchicalString|string $comparable)
Diese Methode erlaubt es, einen hierarchischen String mit einem anderen String zu vergleichen und auch ein Wildcard * einzusetzen. Werden zwei Sterne als letzte Zeichen angegeben (doppelter Wildcard) so wird auch TRUE zurückgegeben, wenn der Ursprungszeichenkette länger als der Vergleichsstring ist (mehrere Ebenen).
Sind beide Strings leer, so gibt die Funktion TRUE zurück.
$stringA = new HierarchicalString('a.b.c.d');
$stringB = new HierarchicalString('a.b.c.d');
$flag = !$stringA->match($stringB)); // TRUE, da der Filterwert $stringB mit $stringA übereinstimmt.
$stringB = new HierarchicalString('a.b.c.d.g'); $flag = !$stringA->match($stringB)); // FALSE, da der Filterstring länger ist.
// Einsatz von Wildcards $stringA = new HierarchicalString('a.b.c.d'); $stringB = new HierarchicalString('.b..d'); $flag = !$stringA->match($stringB)); // TRUE, da die Wildcards für jeden Wert stehen
$stringB = new HierarchicalString('.b..d.*'); $flag = !$stringA->match($stringB)); // FALSE, da der Wildcards zu lang ist.
$stringB = new HierarchicalString('a.*'); $flag = !$stringA->match($stringB)); // FALSE, da der einfache Wildcard * nur für eine Ebene steht
$stringB = new HierarchicalString('a.**'); $flag = !$stringA->match($stringB)); // TRUE, da der doppelte Wildcard ** für mehrere Ebenen steht
at line 272
HierarchicalString
getPrefix(int $level)
Vorsilbe des Strings holden.
at line 289
HierarchicalString
getSuffix(int $level)
Nachsilbe des Strings holden.