\rex_category_service

Funktionensammlung für die Strukturverwaltung.

Summary

Methods
Properties
Constants
addCategory()
editCategory()
deleteCategory()
categoryStatus()
statusTypes()
nextStatus()
prevStatus()
copyCategory()
newCatPrio()
moveCategory()
No public properties found
No constants found
reqKey()
No protected properties found
N/A
No private methods found
No private properties found
N/A

Methods

addCategory()

addCategory(int  $categoryId, array  $data) : string

Erstellt eine neue Kategorie.

Parameters

int $categoryId

KategorieId in der die neue Kategorie erstellt werden soll

array $data

Array mit den Daten der Kategorie

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

editCategory()

editCategory(int  $categoryId, int  $clang, array  $data) : string

Bearbeitet einer Kategorie.

Parameters

int $categoryId

Id der Kategorie die verändert werden soll

int $clang

Id der Sprache

array $data

Array mit den Daten der Kategorie

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

deleteCategory()

deleteCategory(int  $categoryId) : string

Löscht eine Kategorie und reorganisiert die Prioritäten verbleibender Geschwister-Kategorien.

Parameters

int $categoryId

Id der Kategorie die gelöscht werden soll

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

categoryStatus()

categoryStatus(int  $categoryId, int  $clang, int|null  $status = null) : int

Ändert den Status der Kategorie.

Parameters

int $categoryId

Id der Kategorie die gelöscht werden soll

int $clang

Id der Sprache

int|null $status

Status auf den die Kategorie gesetzt werden soll, oder NULL wenn zum nächsten Status weitergeschaltet werden soll

Throws

\rex_api_exception

Returns

int —

Der neue Status der Kategorie

statusTypes()

statusTypes() : array

Gibt alle Stati zurück, die für eine Kategorie gültig sind.

Returns

array —

Array von Stati

nextStatus()

nextStatus(mixed  $currentStatus) : mixed

Parameters

mixed $currentStatus

Returns

mixed —

prevStatus()

prevStatus(mixed  $currentStatus) : mixed

Parameters

mixed $currentStatus

Returns

mixed —

copyCategory()

copyCategory(int  $fromCat, int  $toCat) : mixed

Kopiert eine Kategorie in eine andere.

Parameters

int $fromCat

KategorieId der Kategorie, die kopiert werden soll (Quelle)

int $toCat

KategorieId der Kategorie, IN die kopiert werden soll (Ziel)

Returns

mixed —

newCatPrio()

newCatPrio(int  $parentId, int  $clang, int  $newPrio, int  $oldPrio) : mixed

Berechnet die Prios der Kategorien in einer Kategorie neu.

Parameters

int $parentId

KategorieId der Kategorie, die erneuert werden soll

int $clang

ClangId der Kategorie, die erneuert werden soll

int $newPrio

Neue PrioNr der Kategorie

int $oldPrio

Alte PrioNr der Kategorie

Returns

mixed —

moveCategory()

moveCategory(int  $fromCat, int  $toCat) : bool

Verschieben einer Kategorie in eine andere.

Parameters

int $fromCat

KategorieId der Kategorie, die verschoben werden soll (Quelle)

int $toCat

KategorieId der Kategorie, IN die verschoben werden soll (Ziel)

Returns

bool —

TRUE bei Erfolg, sonst FALSE

reqKey()

reqKey(array  $array, string  $keyName) : mixed

Checks whether the required array key $keyName isset.

Parameters

array $array

The array

string $keyName

The key

Throws

\rex_api_exception

Returns

mixed —