1. class
  2. Alvine
  3. \
  4. Application
  5. \
  6. Data
  7. \
  8. Generic

Generic

class Generic extends Dataset

Diese Klasse stellt eine Standardstruktur für Daten und Metadaten bereit.

Die verwendeten Schlüssel und Strukturen erlauben es so eine einheitliche Datenstrukturierung vorzunehmen.

Constants

KEY_UUID

ID des Objektes (falls nicht bereits in den Daten enthalten)
KEY_SYS

Metadaten
KEY_DATA

Hauptschlüssel
KEY_UPDATED

Letztes Änderungsdatum
KEY_STATUS_MESSAGE

Status - Nachricht
KEY_STATUS_CODE

Status - Code
KEY_CREATED

Erstelldatum
KEY_LOCATION

URL für einen Javascript Redirect
KEY_ERROR

Dehler
KEY_VALIDATION

Validierungsdaten
KEY_LINKS

Links
KEY_PAGINATION

Pagination

Properties

protected array $statusCodes

Methods

__construct(type $map = null)

Neues Generic Konstrukt

Map
initSysAndGetReference()

Sys-Schlüssel initialisieren

Generic
setDataset(Dataset $dataset)

DAtaset setzen

Generic
setUUID(string|UUID $uuid)

ID des Objektes (falls nicht bereits in den Daten enthalten)

Generic
setLocation(string|URI $location)

Location für redirect

string
getLocation()

Location für redirect

Generic
setUpdated(DateTime $data)

Letztes Änderungsdatum

Generic
setCreated(DateTime $data)

Erstelldatum

Generic
setValidation(Validation $validation)

Validierung

Generic
setLinks(Links $links)

Linkstruktur

Generic
setStatus(StatusCode $status)

HTTP Status

integer
getStatusCode()

HTTP StatusCode des Reports

Generic
setError(Error $error)

Fehler

Error
getError()

Fehlerobject

Generic
setPagination(Pagination $pagination)

Pagination

$this
initFromContainer(Container $container)

Struktur von einem Container initialisieren

Generic
initFromSubset(Subset $subset)

Daten von einem Subset übernehmen

Generic
copySysTo(Map $map, boolean $overwrite = false)

Sys-Datenstruktur dieses Objektes in die im Parameter definierte Map ($map) kopieren.

Map
setValue(string $key, mixed $value)

Funktion erweitert die Standardfunktion so, das Statuscodes gesammelt werden.

Generic
initSummaryStatus(int $defaultCode = null)

No description

Details

at line 110
__construct(type $map = null)

Neues Generic Konstrukt

Parameters

type $map

at line 125
protected Map initSysAndGetReference()

Sys-Schlüssel initialisieren

Return Value

Map

at line 140
Generic setDataset(Dataset $dataset)

DAtaset setzen

Parameters

Dataset $dataset

Return Value

Generic

at line 152
Generic setUUID(string|UUID $uuid)

ID des Objektes (falls nicht bereits in den Daten enthalten)

Parameters

string|UUID $uuid

Return Value

Generic

at line 170
Generic setLocation(string|URI $location)

Location für redirect

Parameters

string|URI $location

Return Value

Generic

at line 190
string getLocation()

Location für redirect

Return Value

string Location

at line 208
Generic setUpdated(DateTime $data)

Letztes Änderungsdatum

Diese Funktion setzt nicht den Status des Dokuments

Parameters

DateTime $data

Return Value

Generic

at line 223
Generic setCreated(DateTime $data)

Erstelldatum

Diese Funktion setzt nicht den Status des Dokuments

Parameters

DateTime $data

Return Value

Generic

at line 237
Generic setValidation(Validation $validation)

Validierung

Parameters

Validation $validation

Return Value

Generic

Linkstruktur

Parameters

Links $links

Return Value

Generic

at line 265
Generic setStatus(StatusCode $status)

HTTP Status

Parameters

StatusCode $status

Return Value

Generic

at line 281
integer getStatusCode()

HTTP StatusCode des Reports

Return Value

integer | null

at line 297
Generic setError(Error $error)

Fehler

Parameters

Error $error

Return Value

Generic

at line 312
Error getError()

Fehlerobject

Return Value

Error | null

at line 328
Generic setPagination(Pagination $pagination)

Pagination

Parameters

Pagination $pagination

Return Value

Generic

at line 342
$this initFromContainer(Container $container)

Struktur von einem Container initialisieren

Parameters

Container $container

Return Value

$this

at line 377
Generic initFromSubset(Subset $subset)

Daten von einem Subset übernehmen

Parameters

Subset $subset

Return Value

Generic

at line 399
Generic copySysTo(Map $map, boolean $overwrite = false)

Sys-Datenstruktur dieses Objektes in die im Parameter definierte Map ($map) kopieren.

Ist $overwrite=true so werden die bestehenden Werte in $map überschrieben.

Parameters

Map $map
boolean $overwrite

Return Value

Generic

at line 426
Map setValue(string $key, mixed $value)

Funktion erweitert die Standardfunktion so, das Statuscodes gesammelt werden.

Parameters

string $key Schlüssel in der Map. Wenn der Wert bereits gesetzt wurde, wird er überschrieben.
mixed $value Wert des Eintrages (muss ein einfacher Typ sein)

Return Value

Map Liefert einen Zeiger auf dieses Objekt zurück

at line 448
Generic initSummaryStatus(int $defaultCode = null)

Parameters

int $defaultCode

Return Value

Generic