DataObject
extends
InstantiableFromProperties
in
Schnittstelle für den Datenzugriff
Das DataObjectinterface definiert die Methoden, für den Zugriff auf ein Speicherrepositorium. Notwendige Methoden sind das Hinzufügen, das Löschen und das Ändern eines Objektes.
Tags
Table of Contents
Methods
- delete() : DataObject
- Löscht ein Objekt anhand seiner ID. Ist kein Objekt vorhanden, so wird eine ObjectNotFoundException geworfen. Bestimmte DataObject können noch andere providerspezifische Exceptions werfen.
- each() : DataObject
- Durchläuft alle Einträge des DataObject und ruft die entsprechende Funktion auf. Als Parameter muss er gleiche Wert wie bei read übergeben werden.
- exists() : boolean
- Existenz prüfen
- getInstanceFromProperties() : object
- Erstellt ein neues Objekt und initialisiert Werte aus einer Eigenschaftsklasse
- insert() : DataObject
- Neues Objekt einfügen
- read() : string
- Diese Methode sucht ein Objekt anhand einer ID und gibt die gespeicherten Daten zurück. Ist unter dieser ID kein Objekt gespeichert, so wird eine ObjectNotFoundException geworfen.
- update() : DataObject
- Objekt aktualisieren
- write() : DataObject
- Schreibt ein Objekt
Methods
delete()
Löscht ein Objekt anhand seiner ID. Ist kein Objekt vorhanden, so wird eine ObjectNotFoundException geworfen. Bestimmte DataObject können noch andere providerspezifische Exceptions werfen.
public
delete(string $id) : DataObject
Parameters
- $id : string
-
ID des Objektes
Tags
Return values
DataObject —Dieses Objekt
each()
Durchläuft alle Einträge des DataObject und ruft die entsprechende Funktion auf. Als Parameter muss er gleiche Wert wie bei read übergeben werden.
public
each(Closure $callback) : DataObject
// @var \string $id ist die ID des Datensatzes
$dataobject->each(function ($id) {
// ...
});
Parameters
- $callback : Closure
-
Funktion die aufgerufen wird
Return values
DataObject —Dieses Objekt
exists()
Existenz prüfen
public
exists(string $id) : boolean
Prüfen ob die ID existiert und lesbar ist.
Parameters
- $id : string
-
ID des Objekts (z.B. UUID)
Return values
boolean —true, wenn die ID exitiert und lesbar ist, sonst false
getInstanceFromProperties()
Erstellt ein neues Objekt und initialisiert Werte aus einer Eigenschaftsklasse
public
static getInstanceFromProperties(Properties $properties) : object
Parameters
- $properties : Properties
-
Eigenschaften
Return values
object —Ein Objekt
insert()
Neues Objekt einfügen
public
insert(string $id, string $data) : DataObject
Fügt die serialisierten Daten eines Objekts mit der angegebenen ID ein. Ist diese ID bereits vorhanden, so wird eine ObjectAlreadyExistsException geworfen.
Parameters
- $id : string
-
ID des Objekts (z.B. UUID)
- $data : string
-
Zu speichernde Daten (serialisiertes Objekt)
Tags
Return values
DataObject —Dieses Objekt
read()
Diese Methode sucht ein Objekt anhand einer ID und gibt die gespeicherten Daten zurück. Ist unter dieser ID kein Objekt gespeichert, so wird eine ObjectNotFoundException geworfen.
public
read(string $id) : string
Parameters
- $id : string
-
ID des Objekts
Tags
Return values
string —Objekt als serialisierter String
update()
Objekt aktualisieren
public
update(string $id, string $data) : DataObject
Ändert die serialisierten Daten im Speicherbereich. Wird die übergebene ID nicht gefunden, so wird eine ObjectNotFoundException geworfen.
Parameters
- $id : string
-
ID des Objekts (z.B. UUID)
- $data : string
-
Zu speichernde Daten (serialisiertes Objekt)
Tags
Return values
DataObject —Dieses Objekt
write()
Schreibt ein Objekt
public
write(string $id, string $data) : DataObject
Schreibt die Daten eines serialisierten Objekts. Wenn bereits ein Objekt unter dieser ID vorhanden ist, so wird dieses Objekt ohne Prüfung überschrieben, ansonsten wird die ID neu angelegt.
Parameters
- $id : string
-
ID des Objekts (z.B. UUID)
- $data : string
-
Zu speichernde Daten (serialisiertes Objekt)
Return values
DataObject —Dieses Objekt