class Records extends Collection

Sammelklasse für Werte eines Statements

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 string $limitToClass from Collection
protected string $separator from Collection

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

Gibt den Inhalt der Map als Zeichenkette zurück, dabei werden die Schlüssel und Werte durch das definiertes Trennzeichen : und die einzelnen Einträge der Map durch ein Komma getrennt.

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

Neue Transaktion

boolean
isLimitToClass(string $class)

isLimitToClass

checkLimitation(string $class)

Prüft ob die Collection auf die entsprechenden Klasse eingeschränkt ist, wenn nein, wird eine TypeException geworfen.

Map
setSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

Map
clear()

Leert alle Einträge aus der Map

array
toArray()

Werte als Array

boolean
contains(Alvine $object)

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

append(Alvine $object)

Objekt der Collection hinzufügen

merge(Collection $collection)

Hinzufügen

remove(Alvine $object)

Entfernt ein Objekt aus der Collection

int
count()

Ermittelt die Anzahl der Einträge in der Map

mixed
current()

Wert des aktuellen Objektes

mixed
key()

Schlüssel des aktuellen Elements zurückgeben

mixed
next()

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

mixed
rewind()

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

boolean
valid()

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

each(Closure $callback)

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

mixed
jsonSerialize()

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

string
asJson()

Json-Zeichenkette

static Records
getInstanceFromArray(array $array)

Erstellt ein Objekt aus einem Array. Das Array muss zwei Ebenen besitzen. Die erste Ebene steht für jeweils ein Statement und die zweite Ebene enthält die entsprechendne Werte als Key/Values.

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

in Collection at line 245
string __toString()

Gibt den Inhalt der Map als Zeichenkette zurück, dabei werden die Schlüssel und Werte durch das definiertes Trennzeichen : und die einzelnen Einträge der Map durch ein Komma getrennt.

Die beiden Trennzeichen können über die entsprechenden Funktionen gesetzt werden.

Return Value

string Daten des Objekts

See also

setKeyValueSeparator
setEntrySeparator

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

Neue Transaktion

in Collection at line 92
boolean isLimitToClass(string $class)

isLimitToClass

Diese Methode prüft, ob die Collection auf einen Typ eingeschränkt ist und gibt false, bzw true zurück.

Parameters

string $class Klassenname (inkl. Namespace)

Return Value

boolean

in Collection at line 108
Collection checkLimitation(string $class)

Prüft ob die Collection auf die entsprechenden Klasse eingeschränkt ist, wenn nein, wird eine TypeException geworfen.

Parameters

string $class Klassenname (inkl. Namespace)

Return Value

Collection

Exceptions

TypeException

in Collection at line 123
Map setSeparator(string $separator)

Setzt das Trennzeichen für die __toString Methode

Parameters

string $separator Trennzeichen

Return Value

Map dieses Objekt

in Collection at line 133
Map clear()

Leert alle Einträge aus der Map

Return Value

Map dieses Objekt

in Collection at line 150
array toArray()

Werte als 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 Value

array Werte

in Collection at line 161
boolean contains(Alvine $object)

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

Parameters

Alvine $object Wert der gesucht werden soll

Return Value

boolean true ist der Wert in der Map enthalten

in Collection at line 182
Collection append(Alvine $object)

Objekt der Collection hinzufügen

Fügt der Collection ein weiteres Objekt hinzu. Ist das Objekt bereits eingetragen, so wird das neue Argument nicht verarbeitet. Wurde die Collection für einen Type begrenzt, so wird beim Versuch ein anderes Objekt einzutragen eine \Alvine\Types\TypeException geworfen.

Parameters

Alvine $object Anzuhängendes Objekt

Return Value

Collection Dieses Objekt

Exceptions

TypeException Fehlerhafter Typ

in Collection at line 207
Collection merge(Collection $collection)

Hinzufügen

Diese Methode fügt dieser Collection mehrer Objekte die in einer übergebenen Collection gesammelt sind an. Dabei wird der Typ der einzelnen Objekte in der übergebenen Collection geprüft, sofern dieser für diese Collection vorgegeben wurde.

Die Objekte sind im Anschluß sowohl in der übergeben als auch in dieser Collection enthalten.

Parameters

Collection $collection Anzufügende Objekte

Return Value

Collection Dieses Objekt

Exceptions

TypeException Fehlerhafter Typ

in Collection at line 219
Collection remove(Alvine $object)

Entfernt ein Objekt aus der Collection

Parameters

Alvine $object Zu entfernendes Objekt

Return Value

Collection Dieses Objekt

in Collection at line 229
int count()

Ermittelt die Anzahl der Einträge in der Map

Return Value

int Anzahl der Einträge in der Map

in Collection at line 260
mixed current()

Wert des aktuellen Objektes

Return Value

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

in Collection at line 269
mixed key()

Schlüssel des aktuellen Elements zurückgeben

Return Value

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

in Collection at line 278
mixed next()

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

Return Value

mixed Gibt das nächste Element, oder wenn leer false zurück

in Collection at line 287
mixed rewind()

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

Return Value

mixed Gibt das erste Element, oder wenn leer false zurück

in Collection at line 297
boolean valid()

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

Return Value

boolean true wenn das aktuelle Element gültig ist

in Collection at line 318
Collection each(Closure $callback)

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

$map = new Alvine\types\Collection();
$map->each(function($object) { $v.'...'; });

Anders als bei den anderen Each-Funktionen kann man in einer Collection keinen Wert zurückgeben, da es sich hierbei um Objekte handelt.

Parameters

Closure $callback Funktion die aufgerufen wird

Return Value

Collection

in Collection at line 335
mixed jsonSerialize()

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

Return Value

mixed

in Collection at line 344
string asJson()

Json-Zeichenkette

Return Value

string Json-Zeichenkette

at line 60
static Records getInstanceFromArray(array $array)

Erstellt ein Objekt aus einem Array. Das Array muss zwei Ebenen besitzen. Die erste Ebene steht für jeweils ein Statement und die zweite Ebene enthält die entsprechendne Werte als Key/Values.

[
  ['a'=>'b'],
  ['a'=>'b'],
  ['a'=>'b']
]

Parameters

array $array

Return Value

Records