Documentation

Transaction extends Collection
in package

Alvine

Persistence

Relation

Kapselt eine Trasaktion mit einem oder meheren Queries.

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

$hasAssociatedProperties : boolean
$hash : string: Eindeutige ID
$hasVolatileProperties : boolean
$limitToClass : string
$properties : array
$rollbackOnError : boolean
$separator : string

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: Neue Transaktion
__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
append() : Collection: Objekt der Collection hinzufügen
asJson() : string: Json-Zeichenkette
checkLimitation() : Collection: Prüft ob die Collection auf die entsprechenden Klasse eingeschränkt ist, wenn nein, wird eine TypeException geworfen.
clear() : Map: Leert alle Einträge aus der Map
contains() : boolean: Prüft ob der übergebene Wert in der Collection enthalten ist.
count() : int: Ermittelt die Anzahl der Einträge in der Map
current() : mixed: Wert des aktuellen Objektes
each() : Collection: Durchläuft alle Einträge der Collection und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.
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.
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
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.
isLimitToClass() : boolean: isLimitToClass
isRollbackOnError() : boolean: Soll die Transaktion Rollbacks unterstützen
jsonSerialize() : mixed: Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.
key() : mixed: Schlüssel des aktuellen Elements zurückgeben
merge() : Collection: Hinzufügen
next() : mixed: Den internen Zeiger der Map auf den nächsten Wert setzen.
propertyExists() : boolean: Prüfen ob eine Eigenschaft als dynamische Eigenschaft verfügbar ist, die über $obj->property abgefragt werden kann.
remove() : Collection: Entfernt ein Objekt aus der Collection
rewind() : mixed: Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag
setSeparator() : Map: Setzt das Trennzeichen für die __toString Methode
toArray() : array: Werte als Array
valid() : boolean: Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.
checkAndAdjustSerialisation() : array<string|int, mixed>: Dealing with versions

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

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

$limitToClass


    protected
        string
    $limitToClass
     = null

Einschränken auf Klasse

$properties


    protected
        array
    $properties
     = []

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

$rollbackOnError


    protected
        boolean
    $rollbackOnError
     = false

$separator


    protected
        string
    $separator
     = ','

Trennzeichen für die Ausgabe

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

Neue Transaktion


    public
                    __construct([boolean $rollbackOnError = false ]) : mixed

Parameters

$rollbackOnError : boolean = false

__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

append()

Objekt der Collection hinzufügen


    public
                    append(Alvine $object) : Collection

Fügt der Collection ein weiteres Objekt hinzu. Ist das Objekt bereits eingetragen, so wird das neue Argument nicht verarbeitet. Wurde die Collection für einen Type begrenzt, so wird beim Versuch ein anderes Objekt einzutragen eine \Alvine\Types\TypeException geworfen.

Parameters

$object : Alvine: Anzuhängendes Objekt

Return values

Collection —

Dieses Objekt

asJson()

Json-Zeichenkette


    public
                    asJson() : string

Return values

string —

Json-Zeichenkette

checkLimitation()

Prüft ob die Collection auf die entsprechenden Klasse eingeschränkt ist, wenn nein, wird eine TypeException geworfen.


    public
                    checkLimitation(string $class[, bool|null $subclass = false ]) : Collection

Parameters

$class : string: Klassenname (inkl. Namespace)
$subclass : bool|null = false

Return values

Collection

clear()

Leert alle Einträge aus der Map


    public
                    clear() : Map

Return values

Map —

dieses Objekt

contains()

Prüft ob der übergebene Wert in der Collection enthalten ist.


    public
                    contains(mixed $object) : boolean

Parameters

$object : mixed: Wert der gesucht werden soll

Return values

boolean —

true ist der Wert in der Map enthalten

count()

Ermittelt die Anzahl der Einträge in der Map


    public
                    count() : int

Return values

int —

Anzahl der Einträge in der Map

current()

Wert des aktuellen Objektes


    public
                    current() : mixed

Return values

mixed —

Gibt den Wert des aktuellen Element, oder wenn leer false zurück

each()

Durchläuft alle Einträge der Collection und ruft die entsprechende Funktion auf. Besonders in Zusammenhang mit den anonymen Funktionen lassen sich so sehr effiziente Konvertierungen durchführen.


    public
                    each(Closure $callback) : Collection

$map = new Alvine\types\Collection();
$map->each(function($object) { $v.'...'; });

Anders als bei den anderen Each-Funktionen kann man in einer Collection keinen Wert zurückgeben, da es sich hierbei um Objekte handelt.

Parameters

$callback : Closure: Funktion die aufgerufen wird

Return values

Collection

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

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

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

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

isLimitToClass()

isLimitToClass


    public
                    isLimitToClass(string $class[, bool $subclass = false ]) : boolean

Diese Methode prüft, ob die Collection auf einen Typ eingeschränkt ist und gibt false, bzw true zurück.

Parameters

$class : string: Klassenname (inkl. Namespace)
$subclass : bool = false

Return values

boolean

isRollbackOnError()

Soll die Transaktion Rollbacks unterstützen


    public
                    isRollbackOnError() : boolean

Return values

boolean

jsonSerialize()

Implementierung des JsonSerializable Interfaces. Ein Dataset gibt auf oberster Ebene immer ein Array zurück.


    public
                    jsonSerialize() : mixed

Return values

mixed

key()

Schlüssel des aktuellen Elements zurückgeben


    public
                    key() : mixed

Return values

mixed —

Gibt den Schlüssel des aktuellen Elements, oder wenn leer false zurück

merge()

Hinzufügen


    public
                    merge(Collection $collection) : Collection

Diese Methode fügt dieser Collection mehrer Objekte die in einer übergebenen Collection gesammelt sind an. Dabei wird der Typ der einzelnen Objekte in der übergebenen Collection geprüft, sofern dieser für diese Collection vorgegeben wurde.

Die Objekte sind im Anschluß sowohl in der übergeben als auch in dieser Collection enthalten.

Parameters

$collection : Collection: Anzufügende Objekte

Return values

Collection —

Dieses Objekt

next()

Den internen Zeiger der Map auf den nächsten Wert setzen.


    public
                    next() : mixed

Return values

mixed —

Gibt das nächste Element, oder wenn leer false zurück

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

remove()

Entfernt ein Objekt aus der Collection


    public
                    remove(Alvine $object) : Collection

Parameters

$object : Alvine: Zu entfernendes Objekt

Return values

Collection —

Dieses Objekt

rewind()

Zurücksetzen des internen Zeigers der Map auf den ersten Eintrag


    public
                    rewind() : mixed

Return values

mixed —

Gibt das erste Element, oder wenn leer false zurück

setSeparator()

Setzt das Trennzeichen für die __toString Methode


    public
                    setSeparator(string $separator) : Map

Parameters

$separator : string: Trennzeichen

Return values

Map —

dieses Objekt

toArray()

Werte als Array


    public
                    toArray() : array

Die Werte werden nicht angepasst und Maps und Collection bleiben Objekte.

toArray wandelt im Gegensatz zu asArray die Unterwerte nicht um, sondern gibt nur das Array auf oberster Ebene aus.

Return values

array —

Werte

valid()

Prüft ob der interne Zeiger auf ein gültiges Element der Map zeigt.


    public
                    valid() : boolean

Return values

boolean —

true wenn das aktuelle Element gültig ist

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>

Transaction extends Collection in package Alvine Persistence Relation

Tags

Table of Contents

Constants

Properties

Methods

Constants

APIVERSION

IDENTIFICATION

SERIALVERSION

VERSION

Properties

$hasAssociatedProperties

$hash

$hasVolatileProperties

$limitToClass

$properties

$rollbackOnError

$separator

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

append()

Parameters

Tags

Return values

asJson()

Return values

checkLimitation()

Parameters

Tags

Return values

clear()

Return values

contains()

Parameters

Return values

count()

Return values

current()

Return values

each()

Parameters

Return values

equals()

Parameters

Return values

getClass()

Tags

Return values

getClone()

Parameters

Tags

Return values

getClosure()

Transaction extends Collection
in package

Alvine

Persistence

Relation