Documentation

DataObjectImplementation
in package
implements DataObject

AbstractYes

Basisklasse für DataObjects

Tags
category

Framework

author

schukai GmbH [email protected]

license

http://alvine.io/license/ Licence

link

Alvine

since
20110904

Table of Contents

Interfaces

DataObject
Schnittstelle für den Datenzugriff

Methods

each()  : DataObject
Alle Datensätze durchlaufen und abarbeiten. Wird diese Methode nicht explizit implementiert, so unterstützt der Provider dies nicht.
exists()  : boolean
Existenz prüfen
insert()  : DataObject
Neues Objekt einfügen

Methods

each()

Alle Datensätze durchlaufen und abarbeiten. Wird diese Methode nicht explizit implementiert, so unterstützt der Provider dies nicht.

public each(Closure $callback) : DataObject

ACHTUNG: Diese Methode kann sehr lange laufen.

// @var \string $id ist die ID des Datensatzes
$dataobject->each(function ($id) {
    // ...
});
Parameters
$callback : Closure
Tags
throws
UnsupportedException
Return values
DataObject

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

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
throws
ObjectAlreadyExistsException

Das Objekt existiert nicht.

Return values
DataObject

Dieses Objekt


        
On this page

Search results