Documentation

ObjectStorage extends ObjectStorage
in package

Alvine

Persistence

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.

Constants

APIVERSION = 1: Version der API-Version der Klasse.
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

$dataObject : Provider
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$manager : Manager
$observerList : array: Liste mit Observern die nicht gehasht werden können.
$properties : array
$securityContext : Entity
$state : State

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.
__construct() : mixed: Erstellt ein neues Storage-Objekt und weisst einen Provider zu.
__destruct() : mixed: Löscht den Provider explizit aus dem Objekt durch ein unset
__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
attachObserver() : void: Fügt einen Beobachter hinzu
deleteObject() : Result: Löscht ein Objekt aus dem Speicher.
deleteObjectByID() : Result: 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.
detachObserver() : void: Diese methode entfernt einen Beobachter von der Liste der Beobachter
eachObject() : ObjectStorage: Für relationale Datenbanken steht diese Methode nicht zur Verfügung.
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.
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.
getObject() : type: Objekt holen
getObjectByID() : Alvine: Sucht ein Objekt anhand der Objekt-ID und gibt dieses zurück. Abgeleitete Klassen können weitere Methoden implementieren.
getSecurityContext() : SecurityContext: Security-Context
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.
getState() : State: Status zurückgeben
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasSecurityContext() : boolean: Prüfen ob der SecurityContext gesetzt ist
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
indexObjectByID() : ObjectStorage: Indexiert ein Objekt
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.
notifyObservers() : int: Beobachter informieren
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
removeSecurityContext() : ObjectStorage: SecurityContext entfernen
setManager() : ObjectStorage: Merken welchem Manager der Händler zugewiesen ist.
setSecurityContext() : ObjectStorage: Wird der Context gesetzt, so werden alle Anfragen im Rahmen des Contextes ausgeführt.
writeObject() : Result: Schreibt ein Objekt. Ist das Objekt noch nicht vorhanden, so wird es angelegt, ansonsten neu geschrieben.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
deleteAssociatedObjects() : ObjectStorage: Gebundene Objekte löschen
executeDeleteQuery() : type
executeInsertQuery() : type
executeSelectQuery() : type: Select ausführen
executeUpdateQuery() : type
initAssociatedObjects() : ObjectStorage: Gebundene Objekte lesen und initialisieren
writeAssociatedObjects() : ObjectStorage: Gebundene Objekte schreiben

APIVERSION

Version der API-Version der Klasse.


    public
        mixed
    APIVERSION
    = 1

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

$dataObject


    protected
        Provider
    $dataObject
     = null

Provider

$hasAssociatedProperties


    protected
        boolean
    $hasAssociatedProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

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

$hasVolatileProperties


    protected
        boolean
    $hasVolatileProperties
     = null

(nur initialisiert, wenn Serialisierung erfolgte)

$manager


    protected
        Manager
    $manager

$observerList

Liste mit Observern die nicht gehasht werden können.


    protected
        array
    $observerList
     = array()

$properties


    protected
        array
    $properties
     = []

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

$securityContext


    protected
        Entity
    $securityContext

Kontext

$state


    protected
        State
    $state
     = null

Aktuelles Status-Objekt

__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

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.

__construct()

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


    public
                    __construct(DataObject $dataObject) : mixed

Parameters

$dataObject : DataObject

__destruct()

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


    public
                    __destruct() : mixed

__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

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.

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

__unserialize()


    public
                    __unserialize(array<string|int, mixed> $serialized) : void

Parameters

$serialized : array<string|int, mixed>

__unset()

Zurücksetzen von Werten


    public
                    __unset(string $name) : mixed

Parameters

$name : string

attachObserver()

Fügt einen Beobachter hinzu


    public
                    attachObserver(Observer $observer) : void

Parameters

$observer : Observer: Beobachter

Return values

void

deleteObject()

Löscht ein Objekt aus dem Speicher.


    public
                    deleteObject(DataInstance $object) : Result

Parameters

$object : DataInstance

Return values

Result

deleteObjectByID()

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.


    public
                    deleteObjectByID([string|null $id = null ][, string|null $class = null ]) : Result

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

Parameters

$id : string|null = null
$class : string|null = null

Return values

Result

detachObserver()

Diese methode entfernt einen Beobachter von der Liste der Beobachter


    public
                    detachObserver(Observer $observer) : void

Parameters

$observer : Observer: Beobachter

Return values

void

eachObject()

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


    public
                    eachObject(Closure $callback) : ObjectStorage

Parameters

$callback : Closure: Funktion die aufgerufen wird

Return values

ObjectStorage

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.

getClass()

Name der Klasse


    public
                    getClass() : string

class MyObject extends Alvine };
$obj = new MyObject();

echo $obj->getClass();

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

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

Return values

Closure

getHashCode()

Die Methode Alvine::getID() verwenden!


    public
                    getHashCode() : string

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

getObject()

Objekt holen


    public
                    getObject(DataInstance $object) : type

Parameters

$object : DataInstance

Return values

type

getObjectByID()

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


    public
                    getObjectByID([string|integer|SimpleMap $id = null ][, string $class = null ]) : Alvine

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

$id : string|integer|SimpleMap = null
$class : string = null: Klasse Muss vom Type Model sein

Return values

Alvine —

Das gesucht Objekt

getSecurityContext()

Security-Context


    public
                    getSecurityContext() : SecurityContext

Return values

SecurityContext

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

getState()

Status zurückgeben


    public
                    getState() : State

Return values

State —

Aktuelles Status-Objekt

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasSecurityContext()

Prüfen ob der SecurityContext gesetzt ist


    public
                    hasSecurityContext() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

indexObjectByID()

Indexiert ein Objekt


    public
                    indexObjectByID(string $id[, string|null $class = null ]) : ObjectStorage

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

Parameters

$id : string: die zu indexierende Objekt-ID
$class : string|null = null

Return values

ObjectStorage —

Dieses Objekt

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

notifyObservers()

Beobachter informieren


    public
                    notifyObservers() : int

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

Return values

int —

Anzahl der Benachrichtigungen

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

removeSecurityContext()

SecurityContext entfernen


    public
                    removeSecurityContext() : ObjectStorage

Return values

ObjectStorage

setManager()

Merken welchem Manager der Händler zugewiesen ist.


    public
                    setManager(Manager $manager) : ObjectStorage

Parameters

$manager : Manager

Return values

ObjectStorage

setSecurityContext()

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


    public
                    setSecurityContext(SecurityContext $context) : ObjectStorage

Parameters

$context : SecurityContext

Return values

ObjectStorage

writeObject()

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


    public
                    writeObject(Alvine $object) : Result

Parameters

$object : Alvine

Return values

Result

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

Return values

array<string|int, mixed>

deleteAssociatedObjects()

Gebundene Objekte löschen


    protected
                    deleteAssociatedObjects(Alvine $object) : ObjectStorage

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

Parameters

$object : Alvine

Return values

ObjectStorage

executeDeleteQuery()


    protected
                    executeDeleteQuery(InstanceHelper $helper) : type

Parameters

$helper : InstanceHelper

Return values

type

executeInsertQuery()


    protected
                    executeInsertQuery(InstanceHelper $helper) : type

Parameters

$helper : InstanceHelper

Return values

type

executeSelectQuery()

Select ausführen


    protected
                    executeSelectQuery(InstanceHelper $helper) : type

Parameters

$helper : InstanceHelper

Return values

type

executeUpdateQuery()


    protected
                    executeUpdateQuery(InstanceHelper $helper) : type

Parameters

$helper : InstanceHelper

Return values

type

initAssociatedObjects()

Gebundene Objekte lesen und initialisieren


    protected
                    initAssociatedObjects(Alvine $object) : ObjectStorage

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

Parameters

$object : Alvine

Return values

ObjectStorage

writeAssociatedObjects()

Gebundene Objekte schreiben


    protected
                    writeAssociatedObjects(Alvine $object) : ObjectStorage

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

Parameters

$object : Alvine

Return values

ObjectStorage

ObjectStorage extends ObjectStorage in package Alvine Persistence

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$dataObject

$hasAssociatedProperties

$hash

$hasVolatileProperties

$manager

$observerList

$properties

$securityContext

$state

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

Tags

__destruct()

__get()

Parameters

Tags

Return values

__isset()

Parameters

Return values

__serialize()

Tags

Return values

__set()

Parameters

Return values

__toString()

Return values

__unserialize()

Parameters

Tags

__unset()

Parameters

attachObserver()

Parameters

Return values

deleteObject()

Parameters

Tags

Return values

deleteObjectByID()

Parameters

Tags

Return values

detachObserver()

Parameters

Return values

eachObject()

Parameters

Return values

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Parameters

ObjectStorage extends ObjectStorage
in package

Alvine

Persistence