1. interface
  2. Alvine
  3. \
  4. Persistence
  5. \
  6. DataObject

DataObject

interface DataObject implements InstantiableFromProperties

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.

Methods

static object
getInstanceFromProperties(Properties $properties)

Erstellt ein neues Objekt und initialisiert Werte aus einer Eigenschaftsklasse

from InstantiableFromProperties
DataObject
delete(string $id)

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.

string
read(string $id)

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.

DataObject
write(string $id, string $data)

Schreibt ein Objekt

DataObject
insert(string $id, string $data)

Neues Objekt einfügen

DataObject
update(string $id, string $data)

Objekt aktualisieren

boolean
exists(string $id)

Existenz prüfen

DataObject
each(Closure $callback)

Durchläuft alle Einträge des DataObject und ruft die entsprechende Funktion auf. Als Parameter muss er gleiche Wert wie bei read übergeben werden.

Details

in InstantiableFromProperties at line 39
static object getInstanceFromProperties(Properties $properties)

Erstellt ein neues Objekt und initialisiert Werte aus einer Eigenschaftsklasse

Parameters

Properties $properties Eigenschaften

Return Value

object Ein Objekt

at line 48
DataObject delete(string $id)

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.

Parameters

string $id ID des Objektes

Return Value

DataObject Dieses Objekt

Exceptions

DataObjectException Wenn Fehler beim Löschen auftritt
ObjectNotFoundException Wenn es kein Objekt mit dieser ID gibt

at line 61
string read(string $id)

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.

Parameters

string $id ID des Objekts

Return Value

string Objekt als serialisierter String

Exceptions

ObjectNotFoundException Wenn das Objekt nicht existiert

at line 75
DataObject write(string $id, string $data)

Schreibt ein Objekt

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

string $id ID des Objekts (z.B. UUID)
string $data Zu speichernde Daten (serialisiertes Objekt)

Return Value

DataObject Dieses Objekt

at line 90
DataObject insert(string $id, string $data)

Neues Objekt einfügen

Fügt die serialisierten Daten eines Objekts mit der angegebenen ID ein. Ist diese ID bereits vorhanden, so wird eine ObjectAlreadyExistsException geworfen.

Parameters

string $id ID des Objekts (z.B. UUID)
string $data Zu speichernde Daten (serialisiertes Objekt)

Return Value

DataObject Dieses Objekt

at line 106
DataObject update(string $id, string $data)

Objekt aktualisieren

Ändert die serialisierten Daten im Speicherbereich. Wird die übergebene ID nicht gefunden, so wird eine ObjectNotFoundException geworfen.

Parameters

string $id ID des Objekts (z.B. UUID)
string $data Zu speichernde Daten (serialisiertes Objekt)

Return Value

DataObject Dieses Objekt

at line 117
boolean exists(string $id)

Existenz prüfen

Prüfen ob die ID existiert und lesbar ist.

Parameters

string $id ID des Objekts (z.B. UUID)

Return Value

boolean true, wenn die ID exitiert und lesbar ist, sonst false

at line 135
DataObject each(Closure $callback)

Durchläuft alle Einträge des DataObject und ruft die entsprechende Funktion auf. Als Parameter muss er gleiche Wert wie bei read übergeben werden.

// @var \string $id ist die ID des Datensatzes
$dataobject->each(function ($id) {
    // ...
});

Parameters

Closure $callback Funktion die aufgerufen wird

Return Value

DataObject Dieses Objekt