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

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 $list from StringList
protected string $separator

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

Gespeicherte Liste als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8

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

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.

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

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.

string
implode(string $glue = "\r\n")

Strings zusammenfassen

add(StringType $string)

Neuen String an das Ende der Liste hängen

int
length()

Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück.

int
count()

Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück (Implementierung des Countable-Interfaces)

void
rewind()

Implementierung des Iteration Interfaces.

current()

Implementierung des Iteration Interfaces.

key()

Implementierung des Iteration Interfaces.

next()

Implementierung des Iteration Interfaces.

boolean
valid()

Implementierung des Iteration Interfaces.

offsetUnset(mixed $key)

Implementierung des Array-Interfaces

offsetSet(mixed $key, StringType $value)

Implementierung des Array-Interfaces

offsetGet(string $key)

Implementierung des Array-Interfaces

boolean
offsetExists(mixed $key)

Implementierung des Array-Interfaces

array
toArray()

Liste der String-Objekte zurückgeben

analyze(string $string)

Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Der bisherige Inhalt des Objektes wird überschrieben.

setSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

string
getSeparator()

Gibt de verwendeten Seperator zurück

getParent(integer $count = 1)

Objekt mit Elternverzeichnis

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.

removeChild()

Untervereintrag entfernen

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).

getPrefix(int $level)

Vorsilbe des Strings holden.

getSuffix(int $level)

Nachsilbe des Strings holden.

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

Gespeicherte Liste als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8

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 Alvine at line 475
__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 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

at line 77
__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.

Parameters

$string
$separator

in StringList at line 64
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.

Parameters

string|StringType $string String
string $delimiter Trennzeichen

Return Value

StringType Neue Stringliste

in StringList at line 78
string implode(string $glue = "\r\n")

Strings zusammenfassen

Parameters

string $glue Trennzeichen

Return Value

string Ergebnis

in StringList at line 91
StringList add(StringType $string)

Neuen String an das Ende der Liste hängen

Parameters

StringType $string String

Return Value

StringList Diese Stringliste

in StringList at line 102
int length()

Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück.

Return Value

int Anzahl der Strings in der Liste

in StringList at line 113
int count()

Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück (Implementierung des Countable-Interfaces)

Return Value

int Anzahl der Strings in der Liste

in StringList at line 123
void rewind()

Implementierung des Iteration Interfaces.

Internen Zähler zurücksetzen.

Return Value

void

in StringList at line 132
StringType current()

Implementierung des Iteration Interfaces.

Return Value

StringType aktuelles String-Objekt

in StringList at line 141
StringType key()

Implementierung des Iteration Interfaces.

Return Value

StringType Aktueller Schlüssel

in StringList at line 150
StringType next()

Implementierung des Iteration Interfaces.

Return Value

StringType nächste Zeichenkette

in StringList at line 159
boolean valid()

Implementierung des Iteration Interfaces.

Return Value

boolean Status der Iteration

in StringList at line 169
offsetUnset(mixed $key)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel

in StringList at line 181
offsetSet(mixed $key, StringType $value)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel
StringType $value String-Objekt

in StringList at line 198
offsetGet(string $key)

Implementierung des Array-Interfaces

Parameters

string $key Schlüssel

in StringList at line 211
boolean offsetExists(mixed $key)

Implementierung des Array-Interfaces

Parameters

mixed $key Schlüssel

Return Value

boolean true/false

in StringList at line 222
array toArray()

Liste der String-Objekte zurückgeben

Return Value

array Liste

at line 95
protected HierarchicalString analyze(string $string)

Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Der bisherige Inhalt des Objektes wird überschrieben.

Parameters

string $string Ebenen

Return Value

HierarchicalString Dieses Objekt

at line 116
HierarchicalString setSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

Parameters

string $separator Trennzeichen

Return Value

HierarchicalString Dieses Objekt

at line 126
string getSeparator()

Gibt de verwendeten Seperator zurück

Return Value

string Separator

at line 137
HierarchicalString getParent(integer $count = 1)

Objekt mit Elternverzeichnis

Parameters

integer $count Anzahl der Verzeichnisse, die nach oben gegangen werden soll.

Return Value

HierarchicalString Dieses Objekt mit Elternverzeichnis

at line 175
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');

Parameters

string|StringType $child Untereintrag

Return Value

HierarchicalString Dieses Objekt

at line 199
HierarchicalString removeChild()

Untervereintrag entfernen

Return Value

HierarchicalString Dieses Objekt

at line 242
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

Parameters

HierarchicalString|string $comparable Filter

Return Value

boolean true, wenn der Filter übereinstimmt.

at line 271
HierarchicalString getPrefix(int $level)

Vorsilbe des Strings holden.

Parameters

int $level Anzahl der Ebenen die als Prefix zurückgemeldet werden sollen

Return Value

HierarchicalString Alle

at line 288
HierarchicalString getSuffix(int $level)

Nachsilbe des Strings holden.

Parameters

int $level Anzahl der Ebenen die als Prefix zurückgemeldet werden sollen

Return Value

HierarchicalString Alle