Documentation

DataQuery extends Alvine
in package

Alvine

Data

implements Iterator, ArrayAccess, Countable

Zugriff auf Datenobjekte.

DataQueries erlauben den einfachen Zugriff auf Objekte mittels verketteter Abfragen.

$a = array();
$a[] = array('k'=>'A');
$a[] = array('k'=>'B');
$a[] = array('k'=>'C');
$dataquery = new Alvine\Data\DataQuery(new Alvine\Data\ArrayWrapper($a));

$dataquery->where(function($k, $v) {
        return $v['k']>'D'?true:false;
    })->orderBy(function($a,$b) {
        if($a['k']==$b['k']) return 0;
        return ($a['k']<$b['k'])?1:-1;
    })->each(function($k, $b) {
        print($k.': '.$b['k']."; ");
    });
// Das Ergebnis ist 4: H; 5: G; 3: F

Interfaces

Iterator
ArrayAccess
Countable

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

$data : DataQueryObject
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$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: Erstellt neues DataQuery-Objekt
__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() : DataQuery: Ein Datenobjekt anhängen
count() : integer: Implementierung des Countable-Interface. Dadurch kann count($dataquery) verwendet werden. Verwendet ->getCount()
current() : string: Implementierung des Iteration Interfaces.
each() : Map: Durchläuft alle Einträge des DataQuery 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.
first() : DataQuery: Verwendet nur noch den ersten Datensatz
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.
getCount() : integer: Gibt die Anzahl der Elemente zurück.
getDataObject() : array<string|int, mixed>: Gibt den Inhalt des Objekts zurück.
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.
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.
groupBy() : DataQuery: Diese Funktion gruppiert die Datenmenge und liefert ein Gruppenobjekt 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.
key() : string: Implementierung des Iteration Interfaces.
last() : DataQuery: Das letzte Element im DataQuery verwenden
next() : mixed: Implementierung des Iteration Interfaces.
offsetExists() : boolean: Implementierung des ArrayAccess Interfaces.
offsetGet() : mixed: Implementierung des ArrayAccess Interfaces.
offsetSet() : void: Implementierung des ArrayAccess Interfaces.
offsetUnset() : boolean: Implementierung des ArrayAccess Interfaces.
orderBy() : DataQuery: Diese Funktion sortiert die Datenmenge
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
rewind() : void: Implementierung des Iteration Interfaces.
select() : DataQuery: Die Select-Funktion wählt einzelne Datentypen aus Wenn die Callbackfuntion keinen Wert oder null zurückgibt, dann wird dieser Wert nicht dem Dataset zugewiesen.
skip() : DataQuery: Überspringen
take() : DataQuery: Anwenden
unique() : DataQuery: Entfernt alle doppelten Objekte. Dabei wird der Inhalt der Einträge per serialize verglichen.
valid() : boolean: Implementierung des Iteration Interfaces.
where() : DataQuery: Bedingungen
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
filter() : DataQuery: Callback-Filter

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

$data


    protected
        DataQueryObject
    $data
     = null

Objektsammlung

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

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

Erstellt neues DataQuery-Objekt


    public
                    __construct([DataQueryObject $data = null ]) : mixed

Parameters

$data : DataQueryObject = null: Neues DataQueryObjekt

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

Ein Datenobjekt anhängen


    public
                    append(mixed $value) : DataQuery

Parameters

$value : mixed: Anzuhängender Wert

Return values

DataQuery —

Zeiger auf sich selbst

count()

Implementierung des Countable-Interface. Dadurch kann count($dataquery) verwendet werden. Verwendet ->getCount()


    public
                    count() : integer

Return values

integer —

Anzahl der Datenelemente

current()

Implementierung des Iteration Interfaces.


    public
                    current() : string

Return values

string —

aktuelles String-Objekt

each()

Durchläuft alle Einträge des DataQuery 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) : Map

$query = new Alvine\data\DataQuery(array('a'=>'Auto','b'=>'Boot','c'=>'Flugzeug'));
$query->each(function($k, $v) { return $v.'...'; });

Die Werte werden dann jeweils um ... ergänzt: Auto... Boot... und Flugzeug ... Wenn die Callbackfuntion keinen Wert bzw. null zurückgibt, dann wird dieser Wert nicht dem Dataset zugewiesen.

Parameters

$callback : Closure: Funktion die aufgerufen wird

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.

first()

Verwendet nur noch den ersten Datensatz


    public
                    first() : DataQuery

Return values

DataQuery —

Dieses Objekt

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

getCount()

Gibt die Anzahl der Elemente zurück.


    public
                    getCount() : integer

Return values

integer —

Anzahl der Datenelemente

getDataObject()

Gibt den Inhalt des Objekts zurück.


    public
                    getDataObject() : array<string|int, mixed>

Return values

array<string|int, mixed> —

Aktueller Inhalt als Array

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

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

groupBy()

Diese Funktion gruppiert die Datenmenge und liefert ein Gruppenobjekt zurück.


    public
                    groupBy(Closure $callback) : DataQuery


// Ausgangsarray
// 14=>'Hans', 12=>'Sepp', 52=>'Sepp', 21=>'Johann'

$group = $this->object->groupBy(function($k,$v) {
     return $k<18?'Minderjährig':'Erwachsen';
 });

$group['Minderjährig'] = array(14=>'Hans', '12'=>'Sepp');
$group['Erwachsen'] = array(21=>'Johann', '52'=>'Marta');

Parameters

$callback : Closure: Sortierfunktion

Return values

DataQuery —

Referenz auf dieses Objekt

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

key()

Implementierung des Iteration Interfaces.


    public
                    key() : string

Return values

string —

Keys

last()

Das letzte Element im DataQuery verwenden


    public
                    last() : DataQuery

Return values

DataQuery —

Dieses Objekt

next()

Implementierung des Iteration Interfaces.


    public
                    next() : mixed

Return values

mixed —

nächster Eintrag

offsetExists()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetExists(mixed $offset) : boolean

Parameters

$offset : mixed: Schlüssel

Return values

boolean —

Ergebnis

offsetGet()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetGet(mixed $offset) : mixed

Parameters

$offset : mixed: Schlüssel

Return values

mixed —

Wert

offsetSet()

Implementierung des ArrayAccess Interfaces.


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

Parameters

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

offsetUnset()

Implementierung des ArrayAccess Interfaces.


    public
                    offsetUnset(mixed $offset) : boolean

$dataQuery = new DataQuery();
unset($dataquery[1]);

Parameters

$offset : mixed: Schlüssel

Return values

boolean —

Immer true

orderBy()

Diese Funktion sortiert die Datenmenge


    public
                    orderBy(type $callback) : DataQuery

Parameters

$callback : type: Sortierfunktion

Return values

DataQuery —

Referenz auf dieses Objekt

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.

select()

Die Select-Funktion wählt einzelne Datentypen aus Wenn die Callbackfuntion keinen Wert oder null zurückgibt, dann wird dieser Wert nicht dem Dataset zugewiesen.


    public
                    select(DataSelect $selectionObject) : DataQuery

Parameters

$selectionObject : DataSelect: Objekt mit der Spaltenauswahl

Return values

DataQuery —

Referenz auf dieses Objekt

skip()

Überspringen


    public
                    skip(integer $count) : DataQuery

Überspringe die ersten $count elemente und setzt die interne Datenmenge auf das Ergebnis

$result = $dataQuery->skip(1)->getDataObject();

Parameters

$count : integer: Anzahl der Positionen

Return values

DataQuery —

Neues Objekt

take()

Anwenden


    public
                    take(integer $count) : DataQuery

Setzt den Wert des DataQuery auf die Elemente 0 - $count.

Parameters

$count : integer: Anzahl der Elemente

Return values

DataQuery —

Dieses Objekt

unique()

Entfernt alle doppelten Objekte. Dabei wird der Inhalt der Einträge per serialize verglichen.


    public
                    unique() : DataQuery

Return values

DataQuery —

Zeiger auf sich selbst

valid()

Implementierung des Iteration Interfaces.


    public
                    valid() : boolean

Return values

boolean —

Status der Iteration

where()

Bedingungen


    public
                    where(function $callback) : DataQuery

Reduziert die im DataQuery gespeicherten Einträge um die, die nicht mit der where-Bedingung übereinstimmen.

$query = new Alvine\Data\DataQuery(array('a','b','c'));
print_r($query->where(function($k, $v){ return $v=='a'; }));
// Gibt ein DataQuery Objekt mit dem Eintrag 'a' zurück.

// Ein Möglicher Aufruf zusammen mit einem ArrayWrapper-Objekt
// würde die Zeile mit Index 0 aus dem Ergebnis herausfiltern
// und im Ergebnis nur die Zeilen n-$count enthalten.
$result = $this->object->where(function($k, $v) {
              if($k==0) return false;
              return true;
          })->getDataObject();

Parameters

$callback : function: Funktion mit Filter

Return values

DataQuery —

Gefiltertes Objekt

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>

filter()

Callback-Filter


    protected
                    filter(integer $start[, integer $length = 0 ][, Closure $callback = null ]) : DataQuery

Aufruf einer Callbackfunktion und Filterung aller Elemente. Die Callbackfunktion kann z.B. eine Lambdafunktion sein.

Parameters

$start : integer: erster Eintrag
$length : integer = 0: letzer Eintrag, wenn <1 dann alle
$callback : Closure = null: Callbackfunktion

Return values

DataQuery —

Zeiger auf sich selbst.

DataQuery extends Alvine in package Alvine Data implements Iterator, ArrayAccess, Countable

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$data

$hasAssociatedProperties

$hash

$hasVolatileProperties

$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

count()

Return values

current()

Return values

each()

Parameters

Return values

equals()

Parameters

Return values

first()

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

Tags

Return values

getCount()

Return values

getDataObject()

Return values

getHashCode()

Tags

Return values

getID()

DataQuery extends Alvine
in package

Alvine

Data

implements Iterator, ArrayAccess, Countable