Documentation

Manager extends Singleton
in package

The Persistence Manager takes care of the storage of objects in connection with various storage providers

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine
since
20160601

Table of Contents

Constants

APIVERSION  = 1
Version der API-Version der Klasse.
DEFAULTSTORAGEHANDLER  = '\\default'
Klassenname des Default-Handlers
DEFAULTSTORAGEINDEXHANDLER  = '\\default'
Klassenname des Default-Handlers dex Indexers
IDENTIFICATION  = 'Alvine'
Identifizierung der Alvine API
SERIALVERSION  = 1
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.
VERSION  = 2
Generelle Alvine-Version

Properties

$associatedMap  : LookupTable
$hasAssociatedProperties  : boolean
$hash  : string
Eindeutige ID
$hasVolatileProperties  : boolean
$identity  : Identity
$instances  : array
$lookupTable  : LookupTable
$properties  : array
$storage  : ObjectMap
$storageIndexFinder  : ObjectMap<string|int, IndexFinder>
$storageIndexObserver  : ObjectMap<string|int, Observer>

Methods

__call()  : mixed
Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.
__clone()  : mixed
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.
__get()  : mixed
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.
__isset()  : boolean
Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.
__serialize()  : array<string|int, mixed>
Serialization of the object and data. In the serialized object also stores meta-information for matching.
__set()  : void
Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.
__toString()  : string
Standardumwandlung des Inhalts der Klasse in eine Zeichenkette
__unserialize()  : void
__unset()  : mixed
Zurücksetzen von Werten
deleteObject()  : Result
Objekt aus dem Storage löschen
equals()  : boolean
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.
findObject()  : Subset
Nach einem Objekt suchen
getClass()  : string
Name der Klasse
getClone()  : Alvine
Diese Methode gibt ein geklontes Objekt von sich selber zurück.
getClosure()  : Closure
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.
getHashCode()  : string
Die Methode Alvine::getID() verwenden!
getID()  : string
Diese Methode gibt eine eindeutige ID des Objektes zurück. Bei der ID handelt es sich um eine Zeichenkette in der Form einer UUID.
getIndexFinder()  : IndexFinder
Storage-Indexfinder für Klasse
getInstance()  : object
Instanz erstellen
getLookupTable()  : LookupTable
LookupTable
getObject()  : Alvine
Objekt aus dem Storage auslesen
getPersistenceHandler()  : Storage
Handler für den entsprechenden Speichertyp
getShortID()  : string
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.
hasAssociatedProperties()  : boolean
Check if the object has associative properties
hasVolatileProperties()  : boolean
Prüfen ob das Objekt volatile Eigenschaften besitzt
indexStorage()  : Manager
Storage indexieren
initIndexingFromProperties()  : Manager
Indexierung initialisieren
initPersitenceFromProperties()  : Manager
Manager über Konfiguration initalisieren
isCallable()  : bool
Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).
isInstanceOf()  : boolean
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.
propertyExists()  : boolean
Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
registerDefaultIndexFinder()  : Manager
Das Default-Indexer registrieren.
registerDefaultStorage()  : Manager
Das Default-StorageObjekt registrieren.
registerIndexFinder()  : Manager
Einen Indexer registrieren.
registerStorage()  : Manager
Ein Storageobjekt registrieren.
setIdentity()  : Manager
Identität für SecurityContext setzen.
setLookupTabel()  : Manager
setLookupTable()  : Manager
Save associations and references
unregisterIndexFinder()  : Manager
Registrierung für eine Klasse aufheben
unregisterStorage()  : Manager
Registrierung für eine Klasse aufheben
writeObject()  : ObjectStorage
Objekt in den definierten Speicher schreiben
__construct()  : mixed
Initialize manager
checkAndAdjustSerialisation()  : array<string|int, mixed>
Dealing with versions
initDefaultStorageHandler()  : Manager
StandardHandler Dateisystem initialisieren

Constants

APIVERSION

Version der API-Version der Klasse.

public mixed APIVERSION = 1

DEFAULTSTORAGEHANDLER

Klassenname des Default-Handlers

public mixed DEFAULTSTORAGEHANDLER = '\\default'

DEFAULTSTORAGEINDEXHANDLER

Klassenname des Default-Handlers dex Indexers

public mixed DEFAULTSTORAGEINDEXHANDLER = '\\default'

IDENTIFICATION

Identifizierung der Alvine API

public mixed IDENTIFICATION = 'Alvine'

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.

public mixed SERIALVERSION = 1

https://php.watch/versions/8.1/serializable-deprecated

VERSION

Generelle Alvine-Version

public mixed VERSION = 2

Properties

$hash

Eindeutige ID

protected string $hash = null

Die ID wird erst über die Methode \Alvine\Core\Alvine::getID() bei Bedarf ermittelt, deshalb müssen auch abgeleitete Klassen nicht direkt auf den Wert zugreifen, sondern den Wert über getID() holen.

Hash-Wert des Objekts (UUID)

$properties

protected array $properties = []

Liste mit dynamischen Eigenschaften die über __get und __set bearbeitet werden können.

Methods

__call()

Ein Closures das dem Objekt übergeben wurde, kann entweder als Property oder als Funktion aufgerufen werden.

public __call(string $name, array $arguments) : mixed

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
$name : string

Funktionsname

$arguments : array

Argumente

Tags
throws
NotCallableException

Exception

Return values
mixed —

Ergebnis des Callbacks

__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.

public __clone() : mixed

Alvine-Objekte werden rekursive geclont, so das ein vollständiger Clone vorhanden ist.

__get()

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.

public __get(string $name) : mixed

Vor der Abfrage sollte, damit keine Exception geworfen wird, die Existenz der Eigenschaft geprüft werden.

if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Tags
throws
BadPropertyException
Return values
mixed —

Wert der Eigenschaft

__isset()

Wird aufgerufen, wenn isset() auf ein internes Property angewendet wird.

public __isset(string $name) : boolean
Parameters
$name : string
Return values
boolean

__serialize()

Serialization of the object and data. In the serialized object also stores meta-information for matching.

public __serialize() : array<string|int, mixed>

If a derived class is not to be serializable, then this * method must be overridden and throw an exception. this method must be overridden and throw an exception.

Properties starting with volatile or associated. are handled separately. Properties with prefix volatile are not serialized. For properties with the prefix associated, only the * ID of the object is serialized. ID of the object is serialized. If no object is stored in the property is stored in the property, a TypeException is thrown.

Tags
see
https://php.watch/versions/8.1/serializable-deprecated
Return values
array<string|int, mixed>

__set()

Jede von der Alvine-Klasse abgeleitete Klasse besitzt die Fähigkeit beliebige Werte und Lambda-Funktionen an das Objekt zu hängen.

public __set(string $name, mixed $value) : void

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
$name : string

Name der Eigenschaft

$value : mixed

Wert der Eigenschaft

Return values
void

__toString()

Standardumwandlung des Inhalts der Klasse in eine Zeichenkette

public __toString() : string 
echo (string) new MyObect();
Return values
string —

Daten des Objekts

__unset()

Zurücksetzen von Werten

public __unset(string $name) : mixed
Parameters
$name : string

deleteObject()

Objekt aus dem Storage löschen

public deleteObject(Alvine $object) : Result

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

Parameters
$object : Alvine

zu löschende Objekt

Return values
Result

equals()

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.

public equals(Alvine $object) : boolean 
class MyObject extends Alvine };

$objA = new MyObject();
$objB = new MyObject();

if($objA->equals($objB)) {
  // ...
}
Parameters
$object : Alvine

Objekt das überprüft werden soll

Return values
boolean —

true wenn beide Objekte identisch sind.

findObject()

Nach einem Objekt suchen

public findObject(string $className, Query $query) : Subset

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
$className : string

Klassenname

$query : Query

Query

Tags
throws
NullException

Es wurde kein Handler für den Typ gefunden

throws
FindException

Im Ergebnis wurde ein Eintrag ohne UUID oder Type gefunden. Wahrscheinlich ist der Index nicht mehr konsistent.

Return values
Subset —

Ergebnismenge

getClass()

Name der Klasse

public getClass() : string 
class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();
Tags
see
ClassType::getNormalizedName
Return values
string —

Klassenname

getClone()

Diese Methode gibt ein geklontes Objekt von sich selber zurück.

public getClone([boolean $deepClone = false ]) : Alvine

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
$deepClone : boolean = false

Clone aller enthaltenen Objekte

Tags
see
Alvine::__clone()
Return values
Alvine

getClosure()

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.

public getClosure(string $name) : Closure
Parameters
$name : string

Name des Closure

Tags
throws
NotFoundException
throws
BadPropertyException
Return values
Closure

getHashCode()

Die Methode Alvine::getID() verwenden!

public getHashCode() : string
Tags
deprecated
20140611
Return values
string —

Hashwert des Objektes

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.

public getID() : string

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 values
string —

UUID des Objektes

getInstance()

Instanz erstellen

public static getInstance() : object

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

Tags
throws
FrameworkException

Wenn die Klasse nicht ermittelt werden kann.

Return values
object —

Neues oder registriertes Objekt

getObject()

Objekt aus dem Storage auslesen

public getObject(string $className, string $id) : Alvine

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
$className : string

Name der Klasse

$id : string

ID des Objektes

Tags
throws
ObjectNotFoundException

Objekt nicht gefunden

throws
UnserializeException

Beim unserialize ist ein Problem aufgetreten

throws
TypeException

Wenn das gefundene Objekt vom Typ $className abweicht

throws
NullException

Wenn kein Objekt gefunden wird

Return values
Alvine —

Gespeicherte Klasse

getPersistenceHandler()

Handler für den entsprechenden Speichertyp

public getPersistenceHandler(string $className, string $mode) : Storage
Parameters
$className : string

Klassenname

$mode : string

Mode für die Exception

Tags
throws
NullException

Nicht gefunden

Return values
Storage

getShortID()

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.

public getShortID([int|null $length = null ]) : string

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
$length : int|null = null
Return values
string

indexStorage()

Storage indexieren

public indexStorage([string $className = null ]) : Manager

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
$className : string = null

Name der Klasse

Tags
throws
NullException

Wenn kein Storage über die Klasse gefunden wird

Return values
Manager

isCallable()

Mit dieser Methode kann geprüft werden, ob eine Methode aufrufbar ist. Das gilt für echte und eingehängte DI-Methoden (Lambda).

public isCallable(string $name) : bool 
if($obj->isCallable('myfunction')) {
  $obj->myfunction();
}
Parameters
$name : string

Name der Methode

Return values
bool —

Ergebnis

isInstanceOf()

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.

public isInstanceOf(object $object) : boolean 
if($obj instanceof Alvine &&
   $obj->isInstanceOf($object)) { };

Die Prüfung entspricht

$this instanceof $object
Parameters
$object : object
Return values
boolean

propertyExists()

Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.

public propertyExists(string $name) : boolean 
if($obj->propertyExists('myproperty')) {
  $value = $obj->myproperty;
}
Parameters
$name : string

Name der Eigenschaft

Return values
boolean

registerIndexFinder()

Einen Indexer registrieren.

public registerIndexFinder(string $className, IndexFinder $indexer) : Manager
Parameters
$className : string

Für diese Klasse oder das Interface gilt das Storageobjekt

$indexer : IndexFinder

Storageobjekt

Return values
Manager —

Dieses Objekt

registerStorage()

Ein Storageobjekt registrieren.

public registerStorage(string $className, Storage $storage) : Manager
Parameters
$className : string

Für diese Klasse oder das Interface gilt das Storageobjekt

$storage : Storage

Storageobjekt

Return values
Manager —

Dieses Objekt

setIdentity()

Identität für SecurityContext setzen.

public setIdentity(Identity $identity) : Manager

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

Parameters
$identity : Identity
Return values
Manager

unregisterIndexFinder()

Registrierung für eine Klasse aufheben

public unregisterIndexFinder(string $className) : Manager
Parameters
$className : string

Name der Klasse

Return values
Manager —

Dieses Objekt

unregisterStorage()

Registrierung für eine Klasse aufheben

public unregisterStorage(string $className) : Manager
Parameters
$className : string

Name der Klasse

Return values
Manager —

Dieses Objekt

writeObject()

Objekt in den definierten Speicher schreiben

public writeObject(Alvine $object) : ObjectStorage

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

Parameters
$object : Alvine
Return values
ObjectStorage

__construct()

Initialize manager

protected __construct() : mixed

checkAndAdjustSerialisation()

Dealing with versions

protected checkAndAdjustSerialisation(array $serialization) : array<string|int, mixed>

This method checks an object and ideally repairs older copies. If an old copy cannot be restored be restored, an exception is thrown.

This method must be overridden by the derived classes. be overridden. In the derived class, * the parent method should be called. the parent method should be called.

Parameters
$serialization : array

Daten des serialisiertes Objekts

Tags
throws
UnserializeException

Keine Übereinstimmung

Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results