1. class
  2. Alvine
  3. \
  4. Persistence
  5. \
  6. Provider
  7. \
  8. Redis
  9. \
  10. DataObject

DataObject

class DataObject extends DataObjectImplementation

Redis-Provider

Der Provider kapselt das Managment für die Arbeit mit einer Redis-Installation

Beispiel: redis://example.com:65432/

Properties

protected Redis $connection
protected int $expiration

Methods

__construct(DataSource $uri)

Erstellt einen neuen Provider. Die URI muss in der Form redis://[host]:[port] übergeben werden.

__destruct()

Resourcen freigeben

DataObject
delete(string $id)

Löscht ein Objekt

string
read(string $id)

Liest Objekt

setExpiration(integer $seconds)

Setzt die Lebenszeit der Speicherung. Im Gegensatz zu den anderen Providern speichert der Redis-Provider die Daten nur flüchtig.

Provider
write(string $id, string $data)

Schreibt ein Objekt

Provider
update(string $id, string $data)

Objekt aktuallisieren

static DataObject
getInstanceFromProperties(Properties $properties)

Neue Instanz erstellen

Details

at line 61
__construct(DataSource $uri)

Erstellt einen neuen Provider. Die URI muss in der Form redis://[host]:[port] übergeben werden.

Beispiel: redis://example.com:65432

Parameters

DataSource $uri \Alvine\Net\Resource\URI $uri Datenquelle

at line 84
__destruct()

Resourcen freigeben

at line 107
DataObject delete(string $id)

Löscht ein Objekt

Löscht ein Objekt anhand seiner ID. Ist kein Objekt vorhanden, so wird eine ObjectNotFoundException geworfen. Bestimmte Provider können noch andere Providerspezifische Exceptions werfen.

Parameters

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

Return Value

DataObject Dieses Objekt

Exceptions

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

at line 129
string read(string $id)

Liest Objekt

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 (z.B. UUID)

Return Value

string Objekt als serialisierter String

Exceptions

ObjectNotFoundException Wenn das Objekt nicht existiert

at line 143
setExpiration(integer $seconds)

Setzt die Lebenszeit der Speicherung. Im Gegensatz zu den anderen Providern speichert der Redis-Provider die Daten nur flüchtig.

Parameters

integer $seconds Lebensdauer

at line 161
Provider 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

Provider Dieses Objekt

Exceptions

DataObjectException Bei Problemen mit dem Schreiben

at line 185
Provider update(string $id, string $data)

Objekt aktuallisieren

Ä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

Provider Dieses Objekt

Exceptions

DataObjectException Bei Problemen mit dem Schreiben

at line 208
static DataObject getInstanceFromProperties(Properties $properties)

Neue Instanz erstellen

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

uri URI des Redis in der Form redis://host1[:port1]

Parameters

Properties $properties Eigenschaften

Return Value

DataObject Neues Objekt