Manager
class Manager extends Singleton
Der Persitence-Manager kümmert sich um das Speichern von Objekten in Verbindung mit der verschiedenen Storage-Providern
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. |
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
Prüfen ob das Objekt associative Eigenschaften besitzt
Prüfen ob das Objekt volatile Eigenschaften besitzt
Umgang mit Versionen
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.
Manager initialisieren
LookupTable
Registrierung für eine Klasse aufheben
Registrierung für eine Klasse aufheben
Storage-Indexfinder für Klasse
Handler für den entsprechenden Speichertyp
StandardHandler Dateisystem initialisieren
Storage indexieren
Details
in SerializableImplementation at line 125
string
serialize()
Serialisieren
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 197
boolean
hasAssociatedProperties()
Prüfen ob das Objekt associative Eigenschaften besitzt
in SerializableImplementation at line 209
boolean
hasVolatileProperties()
Prüfen ob das Objekt volatile Eigenschaften besitzt
in SerializableImplementation at line 232
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 257
unserialize(string $serialization)
Klasse deserialisieren
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 178
string
__toString()
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
echo (string) new MyObect();
in Alvine at line 212
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 223
boolean
__isset(string $name)
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
in Alvine at line 232
__unset(string $name)
Zurücksetzen von Werten
in Alvine at line 257
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 282
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 308
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 340
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 363
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 377
string
getHashCode()
deprecated
deprecated
Die Methode Alvine::getID() verwenden!
in Alvine at line 397
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(integer $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 hilreich um Platz zu sparen.
Je kürzer die ID ist, um so größer ist die Wahrscheinlichkeit einer Kollision.
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 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();
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
in SingletonImplementation at line 64
static object
getInstance()
Instanz erstellen
Erstellt ein neues Objekt. Ist bereits ein Objekt registriert, so wird dieser zurückgegeben.
at line 86
protected
__construct()
Manager initialisieren
at line 106
Manager
setLookupTabel(LookupTable $map)
Assozierungen und Referenzen speichern
at line 116
LookupTable
getLookupTable()
LookupTable
at line 130
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.
at line 143
Manager
registerIndexFinder(string $className, IndexFinder $indexer)
Einen Indexer registrieren.
at line 155
Manager
registerDefaultIndexFinder(IndexFinder $indexer)
Das Default-Indexer registrieren.
at line 166
Manager
unregisterIndexFinder(string $className)
Registrierung für eine Klasse aufheben
at line 179
Manager
registerStorage(string $className, Storage $storage)
Ein Storageobjekt registrieren.
at line 191
Manager
registerDefaultStorage(Storage $storage)
Das Default-StorageObjekt registrieren.
at line 202
Manager
unregisterStorage(string $className)
Registrierung für eine Klasse aufheben
at line 223
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.
at line 260
type
getIndexFinder(type $className)
Storage-Indexfinder für Klasse
at line 299
Storage
getPersistenceHandler(string $className, string $mode)
Handler für den entsprechenden Speichertyp
at line 350
Result
deleteObject(Alvine $object)
Objekt aus dem Storage löschen
Diese Methode löscht ein Objekt aus dem in der Konfiguration definierten Speicher.
at line 365
Result|Result
writeObject(Alvine $object)
Objekt in den definierten Speicher schreiben
Das Übergebene Objekt wird serialisiertun und in den angegebenen Speicher geschrieben.
at line 380
Manager
initPersitenceFromProperties(Properties $definition)
Manager über Konfiguration initalisieren
at line 453
protected Manager
initDefaultStorageHandler()
StandardHandler Dateisystem initialisieren
at line 479
Manager
initIndexingFromProperties(Properties $definition)
Indexierung initialisieren
at line 532
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.
at line 567
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);