ArrayQuery
class ArrayQuery extends DataQuery
Zugriff auf Arrays mittels DataQueries.
DataQueries erlauben den einfachen Zugriff auf Objekte mittels verketteter
Abfragen. Die ArrayQuery erleichtert das Erstellen von Dataqueries deren
Daten aus mehrdimmensionalen Arrays besteht.
Wichtiger Hinweis: Da PHP in den offset-Funktionen nicht
mit Referenzen arbeitet, functioniert unset($dataset[0]['col1']);
nicht. Das Verhalten ist auch im Bug-Eintrag https://bugs.php.net/bug.php?id=34783
genauer beschrieben.
$a = array();
$a[] = array('k'=>'A','i'=>'I','j'=>'K');
$a[] = array('k'=>'B','i'=>'J','j'=>'L');
$a[] = array('k'=>'C','i'=>'L','k'=>'M');
$dataquery = new \Alvine\Data\ArrayQuery($a);
$result = $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 array(2=>array('k'=>'M','i'=>'L')
Traits
Constants
VERSION |
Generelle Alvine-Version |
APIVERSION |
Version der API-Version der Klasse. |
IDENTIFICATION |
Identifizierung der Alvine API |
SERIALVERSION |
Version der Klasse (wird für die Serialisierung verwendet. Ändert sich der interne Aufbau der Klasse, so muss dieser Wert nach oben gesetzt werden. Die Serialisierung muss diesen Wert abfragen und bei Bedarf einen Wrapper für das Arbeiten mit veralteten Objekten implmenetieren. |
Properties
protected boolean | $hasAssociatedProperties | from SerializableImplementation | |
protected boolean | $hasVolatileProperties | from SerializableImplementation | |
protected array | $properties | from Alvine | |
protected string | $hash | Eindeutige ID | from Alvine |
protected DataQueryObject | $data | from DataQuery |
Methods
Serialisierung des Objekts und der Daten. In dem serialisierten Objekt werden auch Meta-Informationen zum Abgleich gespeichert.
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
Diese Methode wird in der Folge durch \unserialize aufgerufen und initialisert das neue Objekt. Diese Methode sollte so nicht selber aufgerufen werden.
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
Diese Methode wird inplizit aufgerufen wenn eine nicht definierte Eigenschaft abgefragt wird. Ist die Eigenschaft eine Anonyme-Funktion (Closure), so wird diese Funktion aufgerufen und die Klasse als Parameter übergeben.
Closure über den definierten Namen holen. Ist keine Eigenschaft mit dem Namen definiert, so wird eine BadPropertyException geworfen. Gibt es eine Eigenchaft mit dem Namen, ist diese aber kein Closure, so wird eine NotFoundException geworfen.
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
Diese Methode entfernt alle Minuszeichen aus der UUID des Hash. Wird eine Länge definiert, so wird nach dem entfernen der Minuszeichen die ersten $length Zeichen zurückgegeben.
Diese Funktion vergleicht zwei Objekte. Dazu wird von beiden der
Wert, der von Alvine::getID()
zurückgeliefert wird ermittelt und das
Ergebnis verglichen. Vererbte Klassen können diese Methode überschreiben.
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
Interne Hook für das Clonen des Objektes. Wenn das zu klonende Objekt bereits eine eindeutige ID hat, dann wird auch für das neue Objekt eine eindeutige ID erstellt.
Prüft ob das übergebene Objekt eine Instanz dieses Objektes ist. Allerdings ist darauf zu achten, das vorher definiert wurde, das das neue Objekt von Alvine abgeleitet wurde.
Erstellt neues DataQuery-Objekt
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.
Entfernt alle doppelten Objekte. Dabei wird der Inhalt der Einträge per serialize verglichen.
Implementierung des Countable-Interface. Dadurch kann count($dataquery) verwendet werden. Verwendet ->getCount()
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.
Diese Funktion gruppiert die Datenmenge und liefert ein Gruppenobjekt zurück.
Gibt die interne Datenstruktur zurück.
Details
in SerializableImplementation at line 122
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.
in SerializableImplementation at line 193
bool
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 205
bool
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 228
protected
checkAndAdjustSerialisation(array $serialization)
Umgang mit Versionen
Diese Methode überprüft ein Objekt und repariert im idealfall ältere Kopien. Kann eine alte Kopie nicht wieder hergestellt werden, so wird eine Exeption geworfen.
Diese Methode muss von den abgeleiteten Klassen überschrieben werden. In der abgeleiteten Klasse sollte die Parent-Methode aufgerufen werden.
in SerializableImplementation at line 252
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.
in Alvine at line 177
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 211
void
__set(string $name, mixed $value)
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
Diese Methode wird indirekt aufgerufen, sobald ein Wert oder eine Funktion einem Objekt zugeordnet wird, die nicht definiert wurde.
class MyObject extends Alvine {
}
$obj = new MyObject();
$obj->myValue = 4;
in Alvine at line 222
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 231
__unset(string $name)
Zurücksetzen von Werten
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;
}
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.
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;
}
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!
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();
}
in Alvine at line 376
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
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)
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.
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)) {
// ...
}
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
in DataQuery at line 199
__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();
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
at line 66
__construct(array $array)
Erstellt neues DataQuery-Objekt
in DataQuery at line 83
DataQuery
select(DataSelect $selectionObject)
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.
in DataQuery at line 121
DataQuery
where(Closure $callback)
Bedingungen
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();
in DataQuery at line 140
DataQuery
skip(integer $count)
Überspringen
Überspringe die ersten $count elemente und setzt die interne Datenmenge auf das Ergebnis
$result = $dataQuery->skip(1)->getDataObject();
in DataQuery at line 154
DataQuery
take(integer $count)
Anwenden
Setzt den Wert des DataQuery auf die Elemente 0 - $count.
in DataQuery at line 171
protected DataQuery
filter(integer $start, integer $length = 0, Closure $callback = null)
Callback-Filter
Aufruf einer Callbackfunktion und Filterung aller Elemente. Die Callbackfunktion kann z.B. eine Lambdafunktion sein.
in DataQuery at line 222
DataQuery
unique()
Entfernt alle doppelten Objekte. Dabei wird der Inhalt der Einträge per serialize verglichen.
in DataQuery at line 233
array
getDataObject()
Gibt den Inhalt des Objekts zurück.
in DataQuery at line 253
integer
getCount()
Gibt die Anzahl der Elemente zurück.
in DataQuery at line 264
integer
count()
Implementierung des Countable-Interface. Dadurch kann count($dataquery) verwendet werden. Verwendet ->getCount()
in DataQuery at line 294
Map
each(Closure $callback)
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.
$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.
in DataQuery at line 312
DataQuery
orderBy(Closure $callback)
Diese Funktion sortiert die Datenmenge
in DataQuery at line 338
DataQuery
groupBy(Closure $callback)
Diese Funktion gruppiert die Datenmenge und liefert ein Gruppenobjekt zurück.
// 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');
in DataQuery at line 357
rewind()
Implementierung des Iteration Interfaces.
Internen Zähler zurücksetzen.
in DataQuery at line 367
string
current()
Implementierung des Iteration Interfaces.
in DataQuery at line 377
string
key()
Implementierung des Iteration Interfaces.
in DataQuery at line 387
mixed
next()
Implementierung des Iteration Interfaces.
in DataQuery at line 397
boolean
valid()
Implementierung des Iteration Interfaces.
in DataQuery at line 408
offsetSet(mixed $offset, mixed $value)
Implementierung des ArrayAccess Interfaces.
in DataQuery at line 420
boolean
offsetExists(mixed $offset)
Implementierung des ArrayAccess Interfaces.
in DataQuery at line 437
boolean
offsetUnset(mixed $offset)
Implementierung des ArrayAccess Interfaces.
$dataQuery = new DataQuery();
unset($dataquery[1]);
in DataQuery at line 450
mixed
offsetGet(mixed $offset)
Implementierung des ArrayAccess Interfaces.
at line 78
array
toArray()
Gibt die interne Datenstruktur zurück.