class Manager extends Singleton

Der Persitence-Manager kümmert sich um das Speichern von Objekten in Verbindung mit der verschiedenen Storage-Providern

Traits

Singlton-Implementierung
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.

DEFAULTSTORAGEHANDLER

Klassenname des Default-Handlers

DEFAULTSTORAGEINDEXHANDLER

Klassenname des Default-Handlers dex Indexers

Properties

protected boolean $hasAssociatedProperties from SerializableImplementation
protected boolean $hasVolatileProperties from SerializableImplementation
protected array $properties from Alvine
protected string $hash Eindeutige ID from Alvine
static protected array $instances from SingletonImplementation
protected ObjectMap $storage
protected Observer> $storageIndexObserver
protected IndexFinder> $storageIndexFinder
protected Identity $identity
protected LookupTable $lookupTable
protected LookupTable $associatedMap

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
static object
getInstance()

Instanz erstellen

__construct()

Manager initialisieren

setLookupTabel(LookupTable $map)

Assozierungen und Referenzen speichern

getLookupTable()

LookupTable

setIdentity(Identity $identity)

Identität für SecurityContext setzen.

registerIndexFinder(string $className, IndexFinder $indexer)

Einen Indexer registrieren.

registerDefaultIndexFinder(IndexFinder $indexer)

Das Default-Indexer registrieren.

unregisterIndexFinder(string $className)

Registrierung für eine Klasse aufheben

registerStorage(string $className, Storage $storage)

Ein Storageobjekt registrieren.

registerDefaultStorage(Storage $storage)

Das Default-StorageObjekt registrieren.

unregisterStorage(string $className)

Registrierung für eine Klasse aufheben

findObject(string $className, Query $query)

Nach einem Objekt suchen

type
getIndexFinder(type $className)

Storage-Indexfinder für Klasse

getPersistenceHandler(string $className, string $mode)

Handler für den entsprechenden Speichertyp

deleteObject(Alvine $object)

Objekt aus dem Storage löschen

Rela
writeObject(Alvine $object)

Objekt in den definierten Speicher schreiben

initPersitenceFromProperties(Properties $definition)

Manager über Konfiguration initalisieren

initDefaultStorageHandler()

StandardHandler Dateisystem initialisieren

initIndexingFromProperties(Properties $definition)

Indexierung initialisieren

getObject(string $className, string $id)

Objekt aus dem Storage auslesen

indexStorage(string $className = null)

Storage indexieren

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

static object getInstance()

Instanz erstellen

Erstellt ein neues Objekt. Ist bereits ein Objekt registriert, so wird dieser zurückgegeben.

Return Value

object Neues oder registriertes Objekt

Exceptions

FrameworkException Wenn die Klasse nicht ermittelt werden kann.

at line 84
protected __construct()

Manager initialisieren

at line 104
Manager setLookupTabel(LookupTable $map)

Assozierungen und Referenzen speichern

Parameters

LookupTable $map

Return Value

Manager

at line 114
LookupTable getLookupTable()

LookupTable

Return Value

LookupTable

at line 128
Manager setIdentity(Identity $identity)

Identität für SecurityContext setzen.

Die Identität der StorageHandler wird erst mit der Methode Manager::getHandler() auf die neue Identität gesetzt.

Parameters

Identity $identity

Return Value

Manager

at line 141
Manager registerIndexFinder(string $className, IndexFinder $indexer)

Einen Indexer registrieren.

Parameters

string $className Für diese Klasse oder das Interface gilt das Storageobjekt
IndexFinder $indexer Storageobjekt

Return Value

Manager Dieses Objekt

at line 153
Manager registerDefaultIndexFinder(IndexFinder $indexer)

Das Default-Indexer registrieren.

Parameters

IndexFinder $indexer

Return Value

Manager

at line 164
Manager unregisterIndexFinder(string $className)

Registrierung für eine Klasse aufheben

Parameters

string $className Name der Klasse

Return Value

Manager Dieses Objekt

at line 177
Manager registerStorage(string $className, Storage $storage)

Ein Storageobjekt registrieren.

Parameters

string $className Für diese Klasse oder das Interface gilt das Storageobjekt
Storage $storage Storageobjekt

Return Value

Manager Dieses Objekt

at line 189
Manager registerDefaultStorage(Storage $storage)

Das Default-StorageObjekt registrieren.

Parameters

Storage $storage

Return Value

Manager

at line 200
Manager unregisterStorage(string $className)

Registrierung für eine Klasse aufheben

Parameters

string $className Name der Klasse

Return Value

Manager Dieses Objekt

at line 221
Subset findObject(string $className, Query $query)

Nach einem Objekt suchen

Die Suche erfolgt in dem in der Konfiguration definierten Indexer. Der Indexer gibt eine Ergebnismenge zurück. Diese Methode holt sich die ID des Ergebnisses und verwendet die Methode getObject um das echte Objekt zu laden.

Parameters

string $className Klassenname
Query $query Query

Return Value

Subset Ergebnismenge

Exceptions

NullException Es wurde kein Handler für den Typ gefunden
FindException Im Ergebnis wurde ein Eintrag ohne UUID oder Type gefunden. Wahrscheinlich ist der Index nicht mehr konsistent.

at line 283
type getIndexFinder(type $className)

Storage-Indexfinder für Klasse

Parameters

type $className

Return Value

type

Exceptions

NullException

at line 322
Storage getPersistenceHandler(string $className, string $mode)

Handler für den entsprechenden Speichertyp

Parameters

string $className Klassenname
string $mode Mode für die Exception

Return Value

Storage

Exceptions

NullException Nicht gefunden

at line 373
Result deleteObject(Alvine $object)

Objekt aus dem Storage löschen

Diese Methode löscht ein Objekt aus dem in der Konfiguration definierten Speicher.

Parameters

Alvine $object zu löschende Objekt

Return Value

Result

at line 388
Rela writeObject(Alvine $object)

Objekt in den definierten Speicher schreiben

Das Übergebene Objekt wird serialisiertun und in den angegebenen Speicher geschrieben.

Parameters

Alvine $object zu speicherndes Objekt

Return Value

Rela tion\SQL\Update\Result|\Alvine\Persistence\Relation\SQL\Insert\Result

at line 403
Manager initPersitenceFromProperties(Properties $definition)

Manager über Konfiguration initalisieren

Parameters

Properties $definition

Return Value

Manager

Exceptions

ConfigurationException
IOException

at line 476
protected Manager initDefaultStorageHandler()

StandardHandler Dateisystem initialisieren

Return Value

Manager

Exceptions

IOException

at line 502
Manager initIndexingFromProperties(Properties $definition)

Indexierung initialisieren

Parameters

Properties $definition

Return Value

Manager

Exceptions

ConfigurationException

at line 555
Alvine getObject(string $className, string $id)

Objekt aus dem Storage auslesen

Diese Methode liest ein Objekt aus dem in der Konfiguration definierten Speicher aus. Der Klassenname muss mit führendem \ und vollem Namensraum angegeben werden.

Parameters

string $className Name der Klasse
string $id ID des Objektes

Return Value

Alvine Gespeicherte Klasse

at line 590
Manager indexStorage(string $className = null)

Storage indexieren

Wenn keine Klasse übergeben wurde wird durch die ObjectMap des Managers durchaufen. Ansonsten wird über den Klassennamen das Storage Objekt geholt

Diese Methode kann je nach Datenmenge sehr lange laufen

$this->stroage->getValue($className);

Parameters

string $className Name der Klasse

Return Value

Manager