Documentation

HierarchicalString extends StringList
in package

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ässt 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
// (Wichtig: der letzte Punkt wird nicht mit ausgegeben)
echo ((string)$string->addChild('4.'))."\n";     // Eine weitere Ebene     a.b.c.1.2.3.4
echo ((string)$string->parent(3))." \n";         // Drei Ebenen nach oben  a.b.c.1

$string->setSeparator('::');
echo (string)$string;
Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
see
Type
see
SimpleMap
see
TypeException
since
20110904

Table of Contents

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
$list  : array<string|int, mixed>
$properties  : array
$separator  : string

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
HierarchicalString constructor.
__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
Gespeicherte Liste als Zeichenkette zurückgeben, wenn nichts definiert wurde ist der Text UTF-8
__unserialize()  : void
__unset()  : mixed
Zurücksetzen von Werten
add()  : StringList
Neuen String an das Ende der Liste hängen
addChild()  : HierarchicalString
Neuen Untereintrag hinzufügen. Es können auch Werte mit Trennzeichen übergeben werden. In dem folgenden Beispiel werden zwei Hirarchieebenen hinzugefügt.
count()  : int
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück (Implementierung des Countable-Interfaces)
current()  : StringType
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.
explode()  : StringType
Stringliste aus einem String erstellen, als Parameter kann entweder ein String-Objekt oder ein nativer String übergeben werden.
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.
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.
getParent()  : $this
Objekt mit Elternverzeichnis
getPrefix()  : HierarchicalString
Vorsilbe des Strings holden.
getSeparator()  : string
Gibt de verwendeten Seperator zurück
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.
getSuffix()  : HierarchicalString
Nachsilbe des Strings holden.
hasAssociatedProperties()  : boolean
Check if the object has associative properties
hasVolatileProperties()  : boolean
Prüfen ob das Objekt volatile Eigenschaften besitzt
implode()  : string
Strings zusammenfassen
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()  : StringType
Implementierung des Iteration Interfaces.
length()  : int
Ermittelt die Anzahl der Strings in der Liste und gibt die Zahl zurück.
match()  : bool
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).
next()  : StringType
Implementierung des Iteration Interfaces.
offsetExists()  : bool
Implementierung des Array-Interfaces
offsetGet()  : mixed
Implementierung des Array-Interfaces
offsetSet()  : void
Implementierung des Array-Interfaces
offsetUnset()  : void
Implementierung des Array-Interfaces
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
removeChild()  : HierarchicalString
Untereintrag entfernen
rewind()  : void
Implementierung des Iteration Interfaces.
setSeparator()  : HierarchicalString
Setzt das Trennzeichen für die __toString Methode
toArray()  : array
Liste der String-Objekte zurückgeben
valid()  : boolean
Implementierung des Iteration Interfaces.
analyze()  : HierarchicalString
Interne Funktion, die eine Zeichenkette analysiert und die interne Struktur anlegt. Der bisherige Inhalt des Objektes wird überschrieben.
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions

Constants

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

Properties

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

$list

protected array<string|int, mixed> $list = []

Liste mit einzelnen String-Objekten

$properties

protected array $properties = []

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

Methods

__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

Tags
throws
NotCallableException

Exception

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

HierarchicalString constructor.

public __construct([null $string = null ][, string $separator = '.' ]) : mixed

Neue Zeichenkette anlegen und die Erweiterung festlegen. Beim ersten Erstellen eines Strings wird die interne Kodierung der Multibyte Erweiterung auf UTF-8 umgestellt.

Parameters
$string : null = null
$separator : string = '.'

__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

Tags
throws
BadPropertyException
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.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
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()

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

public __toString() : string
Return values
string —

Zeichenkette des Objekts

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

count()

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

public count() : int
Return values
int —

Anzahl der Strings in der Liste

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.

explode()

Stringliste aus einem String erstellen, als Parameter kann entweder ein String-Objekt oder ein nativer String übergeben werden.

public static explode(string|StringType $string, string $delimiter) : StringType
Parameters
$string : string|StringType

String

$delimiter : string

Trennzeichen

Return values
StringType —

Neue Stringliste

getClass()

Name der Klasse

public getClass() : string 
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
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

Tags
see
Alvine::__clone()
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

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
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

getSeparator()

Gibt de verwendeten Seperator zurück

public getSeparator() : string
Return values
string —

Separator

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

implode()

Strings zusammenfassen

public implode([string $glue = " " ]) : string
Parameters
$glue : string = " "

Trennzeichen

Return values
string —

Ergebnis

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

length()

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

public length() : int
Return values
int —

Anzahl der Strings in der Liste

match()

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

public match(HierarchicalString|string $comparable) : bool

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
$comparable : HierarchicalString|string

Filter

Return values
bool —

true, wenn der Filter übereinstimmt.

offsetExists()

Implementierung des Array-Interfaces

public offsetExists(mixed $key) : bool
Parameters
$key : mixed

Schlüssel

Return values
bool —

true/false

offsetGet()

Implementierung des Array-Interfaces

public offsetGet(string $key) : mixed
Parameters
$key : string

Schlüssel

offsetSet()

Implementierung des Array-Interfaces

public offsetSet(mixed $key, StringType $value) : void
Parameters
$key : mixed

Schlüssel

$value : StringType

String-Objekt

offsetUnset()

Implementierung des Array-Interfaces

public offsetUnset(mixed $key) : void
Parameters
$key : mixed

Schlüssel

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

rewind()

Implementierung des Iteration Interfaces.

public rewind() : void

Internen Zähler zurücksetzen.

toArray()

Liste der String-Objekte zurückgeben

public toArray() : array
Return values
array —

Liste

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

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results