Documentation

Dataset extends Map
in package

Alvine

Data

Dataset-Funktionalität ist ein Wrapper für \Alvine\Types\Map. Über das Dataset können alle Daten die in einem View Verwendung finden oder per Json an einen Client übergeben werden gesammelt werden.

Ein Dataset besteht aus einer Verknüpfung von Maps, Collections und Objekten.

Es können unterschiedliche Typen in einem Dataset enthalten sein. Werden Objekte eingehängt, so sollten diese die Methode __toString(), asJson oder toArray() implementieren.

Im folgenden ist ein Beispiel für ein Dataset zu sehen.

(new Dataset())
     ->setValue('my', new \Alvine\Types\String('world'))
     ->setValue('list', (new \Alvine\Types\Collection())
        ->append((new \Alvine\Types\Map)->setValue('name', 'Thomas')->setValue('plz', '12'))
        ->append((new \Alvine\Types\Map)->setValue('name', 'Franz')->setValue('plz', '34'))
        ->append((new \Alvine\Types\Map)->setValue('name', 'Hans')->setValue('plz', '56'))
        ->append((new \Alvine\Types\Map)->setValue('name', 'Alexander')->setValue('plz', '78')));

Constants

APIVERSION = 1: Version der API-Version der Klasse.
IDENTIFICATION = 'Alvine': Identifizierung der Alvine API
LOWERCASE = 2: Kleinbuchstaben
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.
UPPERCASE = 1: Großbuchstaben
VERSION = 2: Generelle Alvine-Version

Properties

$entrySeparator : string
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$keyValueSeparator : string
$properties : array

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: Create new map
__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: Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize() : void
__unset() : mixed: Zurücksetzen von Werten
append() : Map: Map oder Array anhängen
asArray() : array: Inhalt des Dataset als Array
asJson() : string: Json-Zeichenkette
clear() : Map: Leert alle Einträge aus der Map
containsKey() : boolean: Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.
containsValue() : boolean: Prüft ob der übergebene Wert in der Map enthalten ist.
count() : int: Ermittelt die Anzahl der Einträge in der Map
current() : mixed: Wert des aktuellen Objektes
each() : Map: Durchläuft alle Einträge der Map und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.
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.
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.
getIntersection() : Map: Teilschlüssel holen
getIntersectionGroups() : Map: Teilmengen in Gruppen
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.
getValue() : mixed: Gibt den Wert des Schlüssels in der Map zurück.
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
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.
jsonSerialize() : mixed: Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.
key() : mixed: Schlüssel des aktuellen Elements zurückgeben
next() : void: Den internen Zeiger der Map auf den nächsten Wert setzen.
normalizeKey() : Map: Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.
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.
remove() : Map: Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map
removeValue() : Map: Entfernt alle Einträge, die den übergebenen Wert haben.
rewind() : void: Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag
setEntrySeparator() : Map: Setzt das Trennzeichen für die __toString Methode
setKeyValueSeparator() : Map: Setzt das Trennzeichen für die __toString Methode
setValue() : Map: Wert setzen
toArray() : array: Werte als Array
valid() : boolean: Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
normalize() : array<string|int, mixed>: Werte überprüfen
normalizeValue() : mixed: Bearbeitung des Wertes
prepareOutput() : array: Ausgabe vorbereiten

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

IDENTIFICATION

Identifizierung der Alvine API


    public
        mixed
    IDENTIFICATION
    = 'Alvine'

LOWERCASE

Kleinbuchstaben


    public
        mixed
    LOWERCASE
    = 2

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

UPPERCASE

Großbuchstaben


    public
        mixed
    UPPERCASE
    = 1

VERSION

Generelle Alvine-Version


    public
        mixed
    VERSION
    = 2

$entrySeparator


    protected
        string
    $entrySeparator
     = ','

Trennzeichen der Key/Value Einträge

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

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

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$keyValueSeparator


    protected
        string
    $keyValueSeparator
     = ':'

Trennzeichen zwischen den Key/Value Einträge

$properties


    protected
        array
    $properties
     = []

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

__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

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

Create new map


    public
                    __construct([Map|array $map = null ]) : mixed

Creates a new map and assigns the passed key/value pairs * to the map. to the map. If the value of the array is not a simple * value, a TypeException is thrown. value, a TypeException is thrown.

Parameters

$map : Map|array = null: Eine anzuhängende map oder ein Key/Value Array

__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

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.

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette


    public
                    __toString() : string

echo (string) new MyObect();

Return values

string —

Daten des Objekts

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

append()

Map oder Array anhängen


    public
                    append(Map|array $map) : Map

Hängt an die Map weitere Einträge an. Vor dem einhängen wird die Methode Map::normalize() aufgerufen.

Parameters

$map : Map|array: Eine anzuhängende map oder ein Key/Value Array

Return values

Map —

Liefert einen Zeiger auf dieses Objekt zurück

asArray()

Inhalt des Dataset als Array


    public
                    asArray() : array

asArray wandelt, anders als toArray die gesamte Struktur der Map so um, das es an tojson verwendet werden kann.

Return values

array

asJson()

Json-Zeichenkette


    public
                    asJson() : string

Return values

string —

Json-Zeichenkette

clear()

Leert alle Einträge aus der Map


    public
                    clear() : Map

Return values

Map —

dieses Objekt

containsKey()

Prüft ob es einen Eintrag mit dem Schlüssel gibt und dieser einen Wert !== null hat.


    public
                    containsKey(string $key) : boolean

Parameters

$key : string: Schlüssel

Return values

boolean —

true wenn der Schlüssel vorhanden ist

containsValue()

Prüft ob der übergebene Wert in der Map enthalten ist.


    public
                    containsValue(mixed $value) : boolean

Parameters

$value : mixed: Wert der gesucht werden soll

Return values

boolean —

true ist der Wert in der Map enthalten

count()

Ermittelt die Anzahl der Einträge in der Map


    public
                    count() : int

Return values

int —

Anzahl der Einträge in der Map

current()

Wert des aktuellen Objektes


    public
                    current() : mixed

Return values

mixed —

Gibt den Wert des aktuellen Element, oder wenn leer false zurück

each()

Durchläuft alle Einträge der Map und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.


    public
                    each(Closure $callback[, string $filter = null ]) : Map

$map = new Alvine\types\Map(array('aaa'=>'Auto','bbb'=>'Boot','ccc'=>'Flugzeug'));
$map->each(function($k, $v) { return $v.'...'; });
// Der Filter beachtet die groß/Kleinschreibung.
$map->each(function($k, $v) { return $v.'...'; });

Die Werte werden dann jeweils um ... ergänzt: Auto... Boot... und Flugzeug ... Über den optionalen Filter können Einschränkungen auf den Schlüssel angewendet werden.

// Mit Filter auf alle Schlüssel die mit a anfangen.
$map->each(function($k, $v) { return $v.'...'; }, 'a');

Nur das Auto würde in diesem Beispiel um ... ergänzt werden. Gibt die aufgerufene Funktion null zurück, so wird keine Zuweisung durchgeführt und der ursprüngliche Wert bleibt erhalten.

Parameters

$callback : Closure: Funktion die aufgerufen wird
$filter : string = null: Über einen Filter können nur ganz bestimmte Schlüsselwörter angesprochen werden.

Return values

Map

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.

getClass()

Name der Klasse


    public
                    getClass() : string

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

echo $obj->getClass();

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

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

Return values

Closure

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

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

getIntersection()

Teilschlüssel holen


    public
                    getIntersection(HierarchicalString|string $filter) : Map

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Parameters

$filter : HierarchicalString|string: Filterwert

Return values

Map —

Neues Objekt

getIntersectionGroups()

Teilmengen in Gruppen


    public
                    getIntersectionGroups(HierarchicalString|string $filter[, integer|null $level = null ]) : Map

Diese Methode holt eine Schnittmenge aus der Eigenschaftsliste mit allen Schlüsseln die zu dem Filter passen und gruppiert das Ergebnis zu dem gewünschten Level.

Diese Methode ist nicht sehr schnell und sollte mit bedacht gewählt werden.

Parameters

$filter : HierarchicalString|string: Filterwert
$level : integer|null = null: Ebenen. Wird null übergeben, wird als Ebenen die Anzahl der Teilstrings verwendet.

Return values

Map —

Neues Objekt

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

getValue()

Gibt den Wert des Schlüssels in der Map zurück.


    public
                    getValue(string $key[, mixed $default = null ]) : mixed

Parameters

$key : string: Schlüssel
$default : mixed = null: Standardwert, wenn der Schlüssel nicht gesetzt ist.

Return values

mixed —

Wert der Eigenschaft

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

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

jsonSerialize()

Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.


    public
                    jsonSerialize() : mixed

Return values

mixed

key()

Schlüssel des aktuellen Elements zurückgeben


    public
                    key() : mixed

Return values

mixed —

Gibt den Schlüssel des aktuellen Elements, oder wenn leer false zurück

next()

Den internen Zeiger der Map auf den nächsten Wert setzen.


    public
                    next() : void

Return values

void

normalizeKey()

Wandelt die Schlüssel in Großbuchstaben oder Kleinbuchstaben um.


    public
                    normalizeKey(int $mode) : Map

Parameters

$mode : int: Map::LOWERCASE oder Map::UPPERCASE

Return values

Map —

Dieses Objekt

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(mixed $key) : mixed

Parameters

$key : mixed: Schlüssel

offsetSet()

Implementierung des Array-Interfaces


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

Parameters

$key : mixed: Schlüssel
$value : mixed: Wert

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

remove()

Löscht den Eintrag mit dem übergebenen Schlüssel aus der Map


    public
                    remove(string $key) : Map

Parameters

$key : string

Return values

Map —

Dieses Objekt

removeValue()

Entfernt alle Einträge, die den übergebenen Wert haben.


    public
                    removeValue(simple $value) : Map

Der Wert muss vom identischen Typ sein, da der Vergleich mittels === erfolgt.

Parameters

$value : simple

Return values

Map —

Dieses Objekt

rewind()

Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag


    public
                    rewind() : void

setEntrySeparator()

Setzt das Trennzeichen für die __toString Methode


    public
                    setEntrySeparator(string $separator) : Map

Parameters

$separator : string: Trennzeichen

Return values

Map —

dieses Objekt

setKeyValueSeparator()

Setzt das Trennzeichen für die __toString Methode


    public
                    setKeyValueSeparator(string $separator) : Map

Parameters

$separator : string: Trennzeichen

Return values

Map —

dieses Objekt

setValue()

Wert setzen


    public
                    setValue(string $key, mixed $value) : Map

Setzt den Wert eines Schlüssels auf den Übergebenen Wert.

Parameters

$key : string: Schlüssel in der Map. Wenn der Wert bereits gesetzt wurde, wird er überschrieben.
$value : mixed: Wert des Eintrages (muss ein einfacher Typ sein)

Return values

Map —

Liefert einen Zeiger auf dieses Objekt zurück

toArray()

Werte als Array


    public
                    toArray() : array

Die Werte werden nicht angepasst und Maps und Collection bleiben Objekte.

toArray wandelt im Gegensatz zu asArray die Unterwerte nicht um, sondern gibt nur das Array auf oberster Ebene aus.

Return values

array —

Werte

valid()

Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.


    public
                    valid() : boolean

Return values

boolean —

true wenn das aktuelle Element gültig ist

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

Return values

array<string|int, mixed>

normalize()

Werte überprüfen


    protected
                    normalize(array $array) : array<string|int, mixed>

Diese Methode überprüft den Schlüssel und den Wert eines Arrays

Parameters

$array : array: zu überprüfendes Array

Return values

array<string|int, mixed>

normalizeValue()

Bearbeitung des Wertes


    protected
                    normalizeValue(string $key, mixed $value) : mixed

Überprüfung ob der Wert der Map ein bestimmter Type ist. Wenn nicht, wird eine TypeException geworfen. Diese Methode kann von abgeleiteten Klassen für die Bearbeitung der Werte verwendet werden.

Parameters

$key : string: Schlüssel für Zugriff
$value : mixed: zu überprüfender Wert

Return values

mixed —

$value Rückgabewert.

prepareOutput()

Ausgabe vorbereiten


    protected
            static        prepareOutput(array $properties) : array

Parameters

$properties : array: Schlüssel/Werte

Return values

array —

Ausgabe

Dataset extends Map in package Alvine Data

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

LOWERCASE

SERIALVERSION

UPPERCASE

VERSION

Properties

$entrySeparator

$hasAssociatedProperties

$hash

$hasVolatileProperties

$keyValueSeparator

$properties

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

append()

Parameters

Return values

asArray()

Return values

asJson()

Return values

clear()

Return values

containsKey()

Parameters

Return values

containsValue()

Parameters

Return values

count()

Return values

current()

Return values

each()

Parameters

Return values

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

Dataset extends Map
in package

Alvine

Data