Documentation

DataObject extends Alvine
in package

Alvine

Persistence

implements InstantiableFromProperties

Provider für die Datenbankoperationen

Der Provider kapselt alle Datenbankaktivitäten und führt die SQL-Statments aus. Im Provider ist die Logik für den Datenbankzugriff geregelt.

Interfaces

InstantiableFromProperties: Interface für Klassen die mittels Property-Klassen erstellbar sind

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

$connection : PDO
$dsn : string
$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$options : SimpleMap
$properties : array
$rollbackStackCounter : int: Mit Hilfe des $rollbackStackCounter wird verhindert das ein Commit durchgeführt werden kann, wenn innerhalb einer Transktion ein vorheriger Rollback aufgerufen wurde.
$transactionStackCounter : int|null: Der $transactionStackCounter sorgt dafür das Transaktion in Transaktionen möglich sind. Der Counter zählt bei startTransaction hoch und bei Commit und Rollback herunter.

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: Neues Provider-Objekt erstellen
__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
beginTransaction() : DataObject: Transaktion starten
commitTransaction() : DataObject: Transaktion commiten
connect() : Provider: Datenbankverbindung herstellen
disableTransactionStackCounter() : DataObject: Schaltet Transaktionszähler aus. Ist der Transaktionszähle größer Null, so wird der nächste Rollback oder Commit ausgeführt.
enableTransactionStackCounter() : DataObject: Schaltet Transaktionszähler an, dadurch wird ein interner Counter gesetzt und bei jedem Aufruf von beginTranaction hochgezählt und bei einem Rollback oder Commit wird der Counter heruntergezählt.
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.
execute() : Results: Transaktion, Query oder Statement ausführen
executeQuery() : Results: Ein Query ausführen
executeTransaction() : array: Transaktion ausführen
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.
getInstanceFromProperties() : DataObject: Erstellt einen neuen Provider und initialisiert die Werte über ein Property-Objekt. Die gültigen Eigenschaften sind:
getReduceRollbackStackCounter() : int: Liefert den Wert von rollbackStackCounter zurück
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.
getTransactionStackCounter() : int|null: Schaltet Transaktionszähler aus
hasAssociatedProperties() : boolean: Check if the object has associative properties
hasVolatileProperties() : boolean: Prüfen ob das Objekt volatile Eigenschaften besitzt
inTransaction() : bool: Befindet sich die Verbindung in einer Transaktion?
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.
reduceRollbackStackCounter() : DataObject: reduziert den rollbackStackCounter um einen Wert Es wird eine Exception geworfen wenn der Counter schon 0 ist
rollbackTransaction() : DataObject: Transaktion beenden
setAutoCommit() : DataObject: Auto-Commit
bindDefinition() : DataObject: Werte zuweisen
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions
createErrorResult() : ErrorResult: Fehlermeldung bauen
executePreparedStatement() : PDOStatement: PreparedStatement mit einem Record ausführen
executeStatement() : Result: Query ausführen

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

$connection


    protected
        PDO
    $connection
     = null

Datenbankverbindung

$dsn


    protected
        string
    $dsn
     = null

DSN

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

$options


    protected
        SimpleMap
    $options
     = null

Optionen

$properties


    protected
        array
    $properties
     = []

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

$rollbackStackCounter

Mit Hilfe des $rollbackStackCounter wird verhindert das ein Commit durchgeführt werden kann, wenn innerhalb einer Transktion ein vorheriger Rollback aufgerufen wurde.


    protected
        int
    $rollbackStackCounter
     = 0

$transactionStackCounter

Der $transactionStackCounter sorgt dafür das Transaktion in Transaktionen möglich sind. Der Counter zählt bei startTransaction hoch und bei Commit und Rollback herunter.


    protected
        int|null
    $transactionStackCounter

Ist der Wert null, so ist diese Funktiondeaktiviert Ist dieser Wert gleich 0 oder größer so ist die Funktion aktiviert.

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

Neues Provider-Objekt erstellen


    public
                    __construct(DataSource|URI $dsn[, SimpleMap $options = null ]) : mixed

Übder die Optionen können weitere Werte an den Treiber übergeben werden. Die Details sind http://php.net/manual/en/pdo.setattribute.php hier zu finden.

Parameters

$dsn : DataSource|URI: Datenbankschema
$options : SimpleMap = null: Optionen

__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

beginTransaction()

Transaktion starten


    public
                    beginTransaction() : DataObject

Return values

DataObject

commitTransaction()

Transaktion commiten


    public
                    commitTransaction() : DataObject

Return values

DataObject

connect()

Datenbankverbindung herstellen


    public
                    connect() : Provider

Return values

Provider —

Dieses Objekt

disableTransactionStackCounter()

Schaltet Transaktionszähler aus. Ist der Transaktionszähle größer Null, so wird der nächste Rollback oder Commit ausgeführt.


    public
                    disableTransactionStackCounter() : DataObject

Return values

DataObject

enableTransactionStackCounter()

Schaltet Transaktionszähler an, dadurch wird ein interner Counter gesetzt und bei jedem Aufruf von beginTranaction hochgezählt und bei einem Rollback oder Commit wird der Counter heruntergezählt.


    public
                    enableTransactionStackCounter() : DataObject

Ein Rollback oder Commit wird nur bei einem internen Counterwert von 0 durchgeführt.

Return values

DataObject

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.

execute()

Transaktion, Query oder Statement ausführen


    public
                    execute(string $query) : Results

Parameters

$query : string: \Alvine\Persistence\Relation\Transaction| \Alvine\Persistence\Relation\Statement| \Alvine\Persistence\Relation\Query

Return values

Results

executeQuery()

Ein Query ausführen


    public
                    executeQuery(Query $query) : Results

Parameters

$query : Query

Return values

Results

executeTransaction()

Transaktion ausführen


    public
                    executeTransaction(Transaction $transaction) : array

Parameters

$transaction : Transaction

Return values

array

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

getInstanceFromProperties()

Erstellt einen neuen Provider und initialisiert die Werte über ein Property-Objekt. Die gültigen Eigenschaften sind:


    public
            static        getInstanceFromProperties(Properties $properties) : DataObject

uri URI von MySql in der Form mysql://[username:password@]host1[:port1]/db/table

Parameters

$properties : Properties: Eigenschaften

Return values

DataObject

getReduceRollbackStackCounter()

Liefert den Wert von rollbackStackCounter zurück


    public
                    getReduceRollbackStackCounter() : int

Return values

int

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

getTransactionStackCounter()

Schaltet Transaktionszähler aus


    public
                    getTransactionStackCounter() : int|null

Return values

int|null

hasAssociatedProperties()

Check if the object has associative properties


    public
                    hasAssociatedProperties() : boolean

Return values

boolean

hasVolatileProperties()

Prüfen ob das Objekt volatile Eigenschaften besitzt


    public
                    hasVolatileProperties() : boolean

Return values

boolean

inTransaction()

Befindet sich die Verbindung in einer Transaktion?


    public
                    inTransaction() : bool

Return values

bool

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

reduceRollbackStackCounter()

reduziert den rollbackStackCounter um einen Wert Es wird eine Exception geworfen wenn der Counter schon 0 ist


    public
                    reduceRollbackStackCounter() : DataObject

Return values

DataObject

rollbackTransaction()

Transaktion beenden


    public
                    rollbackTransaction() : DataObject

Return values

DataObject

setAutoCommit()

Auto-Commit


    public
                    setAutoCommit(bool $flag) : DataObject

Parameters

$flag : bool

Return values

DataObject

bindDefinition()

Werte zuweisen


    protected
                    bindDefinition(PDOStatement $preparedStatement, Definition $definition, Record $record) : DataObject

Parameters

$preparedStatement : PDOStatement
$definition : Definition
$record : Record

Return values

DataObject

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>

createErrorResult()

Fehlermeldung bauen


    protected
                    createErrorResult(type $pdoStatement[, type $statement = null ][, type $record = null ]) : ErrorResult

Parameters

$pdoStatement : type
$statement : type = null
$record : type = null

Return values

ErrorResult

executePreparedStatement()

PreparedStatement mit einem Record ausführen


    protected
                    executePreparedStatement(mixed $statement[, Record $record = null ]) : PDOStatement

Parameters

$statement : mixed
$record : Record = null

Return values

PDOStatement

executeStatement()

Query ausführen


    protected
                    executeStatement(Stament $statement[, Record $record = null ]) : Result

Parameters

$statement : Stament
$record : Record = null

Return values

Result —

Ergebnis

DataObject extends Alvine in package Alvine Persistence implements InstantiableFromProperties

Tags

Table of Contents

Interfaces

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$connection

$dsn

$hasAssociatedProperties

$hash

$hasVolatileProperties

$options

$properties

$rollbackStackCounter

$transactionStackCounter

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__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

beginTransaction()

Return values

commitTransaction()

Tags

Return values

connect()

Return values

disableTransactionStackCounter()

Tags

Return values

enableTransactionStackCounter()

Return values

equals()

Parameters

Return values

execute()

Parameters

Tags

Return values

executeQuery()

Parameters

Return values

executeTransaction()

Parameters

Tags

Return values

getClass()

Tags

Return values

getClone()

DataObject extends Alvine
in package

Alvine

Persistence

implements InstantiableFromProperties