class ObjectStorage extends ObjectStorage

Implementierung einer generellen RelationalObjectStorage-Klasse für Objekte die in einer relationalen Datenbank gespeichert werden sollen.

Observer können generell für die Schreib und Löschaktionen registrieren und werden über das Observable-Interface informiert.

Traits

Implementierung des Observer-Patterns
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 State $state from ObserveableImplementation
protected array $observerList Liste mit Observern die nicht gehasht werden können. from ObserveableImplementation
protected Provider $dataObject from Storage
protected Entity $securityContext from Storage
protected Manager $manager from Storage

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

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

from Alvine
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
getState()

Status zurückgeben

void
attachObserver(Observer $observer)

Fügt einen Beobachter hinzu

void
detachObserver(Observer $observer)

Diese methode entfernt einen Beobachter von der Liste der Beobachter

int
notifyObservers()

Beobachter informieren

__construct(DataObject $dataObject)

Erstellt ein neues Storage-Objekt und weisst einen Provider zu.

__destruct()

Löscht den Provider explizit aus dem Objekt durch ein unset

from Storage
setManager(Manager $manager)

Merken welchem Manager der Händler zugewiesen ist.

from Storage
setSecurityContext(SecurityContext $context)

Wird der Context gesetzt, so werden alle Anfragen im Rahmen des Contextes ausgeführt.

from Storage
getSecurityContext()

Security-Context

from Storage
boolean
hasSecurityContext()

Prüfen ob der SecurityContext gesetzt ist

from Storage
removeSecurityContext()

SecurityContext entfernen

from Storage
getObjectByID(string|null $id = null, string|null $class = null)

Sucht ein Objekt anhand der Objekt-ID und gibt dieses zurück. Abgeleitete Klassen können weitere Methoden implementieren.

deleteObjectByID(string $id = null, string $class = null)

Löscht ein Objekt aus dem Speicher. Sind Observer registriert, so werden diese Informiert und können über die Methode ObjectStorage::getStatus() die letzte Operation holen. In diesem Fall die ID des Objektes.

deleteObject(Alvine $object)

Löscht ein Objekt aus dem Speicher.

writeObject(Alvine $object)

Schreibt ein Objekt. Ist das Objekt noch nicht vorhanden, so wird es angelegt, ansonsten neu geschrieben.

eachObject(Closure $callback)

Für relationale Datenbanken steht diese Methode nicht zur Verfügung.

indexObjectByID($id, $class = null)

Indexiert ein Objekt

initAssociatedObjects(Alvine $object)

Gebundene Objekte lesen und initialisieren

deleteAssociatedObjects(Alvine $object)

Gebundene Objekte löschen

writeAssociatedObjects(Alvine $object)

Gebundene Objekte schreiben

type
executeInsertQuery(InstanceHelper $helper)

No description

type
executeUpdateQuery(InstanceHelper $helper)

No description

type
executeSelectQuery(InstanceHelper $helper)

Select ausführen

type
executeDeleteQuery(InstanceHelper $helper)

No description

type
getObject(Alvine $object)

Objekt holen

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 Alvine at line 177
string __toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

echo (string) new MyObect();

Return Value

string Daten des Objekts

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

State getState()

Status zurückgeben

Return Value

State Aktuelles Status-Objekt

void attachObserver(Observer $observer)

Fügt einen Beobachter hinzu

Parameters

Observer $observer Beobachter

Return Value

void

void detachObserver(Observer $observer)

Diese methode entfernt einen Beobachter von der Liste der Beobachter

Parameters

Observer $observer Beobachter

Return Value

void

int notifyObservers()

Beobachter informieren

Diese Methode ruft bei allen angemeldeten Beobachtern die Methode update() auf.

Return Value

int Anzahl der Benachrichtigungen

at line 45
__construct(DataObject $dataObject)

Erstellt ein neues Storage-Objekt und weisst einen Provider zu.

Parameters

DataObject $dataObject DataObject

Exceptions

TypeException

in Storage at line 68
__destruct()

Löscht den Provider explizit aus dem Objekt durch ein unset

in Storage at line 82
ObjectStorage setManager(Manager $manager)

Merken welchem Manager der Händler zugewiesen ist.

Parameters

Manager $manager

Return Value

ObjectStorage

in Storage at line 96
ObjectStorage setSecurityContext(SecurityContext $context)

Wird der Context gesetzt, so werden alle Anfragen im Rahmen des Contextes ausgeführt.

Parameters

SecurityContext $context

Return Value

ObjectStorage

in Storage at line 106
SecurityContext getSecurityContext()

Security-Context

Return Value

SecurityContext

in Storage at line 115
boolean hasSecurityContext()

Prüfen ob der SecurityContext gesetzt ist

Return Value

boolean

in Storage at line 124
ObjectStorage removeSecurityContext()

SecurityContext entfernen

Return Value

ObjectStorage

at line 213
Alvine getObjectByID(string|null $id = null, string|null $class = null)

Sucht ein Objekt anhand der Objekt-ID und gibt dieses zurück. Abgeleitete Klassen können weitere Methoden implementieren.

Wichtig: Der Klassenname muss vom Type \Alvine\Persistence\ModelInstance sein.

Ist im Modell die Konstante OBJECT_ID gesetzt, so wird die ID als integer und nicht als String eingetragen. Das ist für die weitere Verarbeitung wichtig.

Parameters

string|null $id
string|null $class

Return Value

Alvine Das gesucht Objekt

Exceptions

ObjectNotFoundException Objekt nicht gefunden
UnserializeException Beim unserialize ist ein Problem aufgetreten

at line 259
ObjectStorage deleteObjectByID(string $id = null, string $class = null)

Löscht ein Objekt aus dem Speicher. Sind Observer registriert, so werden diese Informiert und können über die Methode ObjectStorage::getStatus() die letzte Operation holen. In diesem Fall die ID des Objektes.

Wichtig: Der Klassenname muss vom Type \Alvine\Persistence\ModelInstance sein.

Parameters

string $id
string $class

Return Value

ObjectStorage Dieses Objekt

Exceptions

DeleteForbiddenException
ObjectNotFoundException Objekt nicht gefunden
UnserializeException Beim unserialize ist ein Problem aufgetreten

at line 281
ObjectStorage deleteObject(Alvine $object)

Löscht ein Objekt aus dem Speicher.

Parameters

Alvine $object Objekt das gelöscht werden soll

Return Value

ObjectStorage Dieses Objekt

Exceptions

DeleteForbiddenException
TypeException

at line 317
ObjectStorage writeObject(Alvine $object)

Schreibt ein Objekt. Ist das Objekt noch nicht vorhanden, so wird es angelegt, ansonsten neu geschrieben.

Parameters

Alvine $object

Return Value

ObjectStorage Dieses Objekt

Exceptions

BadPropertyException
WriteForbiddenException
TypeException

at line 383
ObjectStorage eachObject(Closure $callback)

Für relationale Datenbanken steht diese Methode nicht zur Verfügung.

Parameters

Closure $callback Funktion die aufgerufen wird

Return Value

ObjectStorage

in ObjectStorage at line 230
ObjectStorage indexObjectByID($id, $class = null)

Indexiert ein Objekt

Das Objekt wird erst aus dem Storage geladen. Wenn es gefunden wurde, werden die angschlossenen Beobachter informiert

Parameters

$id
$class

Return Value

ObjectStorage Dieses Objekt

in ObjectStorage at line 247
protected ObjectStorage initAssociatedObjects(Alvine $object)

Gebundene Objekte lesen und initialisieren

Für diese Funktion muss dem SorageObjekt ein StorageManager zugewiesen sein.

Parameters

Alvine $object

Return Value

ObjectStorage

in ObjectStorage at line 278
protected ObjectStorage deleteAssociatedObjects(Alvine $object)

Gebundene Objekte löschen

Für diese Funktion muss dem SorageObjekt ein StorageManager zugewiesen sein.

Parameters

Alvine $object

Return Value

ObjectStorage

in ObjectStorage at line 307
protected ObjectStorage writeAssociatedObjects(Alvine $object)

Gebundene Objekte schreiben

Diese Funktion setzt den Aufruf von ObjectStorage::setManager voraus. Istkein Manager definiert macht diese Funktion nichts.

Parameters

Alvine $object

Return Value

ObjectStorage

at line 60
protected type executeInsertQuery(InstanceHelper $helper)

Parameters

InstanceHelper $helper

Return Value

type

Exceptions

ObjectNotFoundException

at line 81
protected type executeUpdateQuery(InstanceHelper $helper)

Parameters

InstanceHelper $helper

Return Value

type

Exceptions

ObjectNotFoundException

at line 104
protected type executeSelectQuery(InstanceHelper $helper)

Select ausführen

Parameters

InstanceHelper $helper

Return Value

type

Exceptions

ObjectNotFoundException

at line 124
protected type executeDeleteQuery(InstanceHelper $helper)

Parameters

InstanceHelper $helper

Return Value

type

Exceptions

ObjectNotFoundException

at line 147
type getObject(Alvine $object)

Objekt holen

Parameters

Alvine $object

Return Value

type

Exceptions

ObjectNotFoundException
FormatException
TypeException