rex_category_service
in package
Funktionensammlung für die Strukturverwaltung.
Table of Contents
Methods
- addCategory() : string
- Erstellt eine neue Kategorie.
- categoryStatus() : int
- Ändert den Status der Kategorie.
- copyCategory() : void
- Kopiert eine Kategorie in eine andere.
- deleteCategory() : string
- Löscht eine Kategorie und reorganisiert die Prioritäten verbleibender Geschwister-Kategorien.
- editCategory() : string
- Bearbeitet einer Kategorie.
- moveCategory() : bool
- Verschieben einer Kategorie in eine andere.
- newCatPrio() : void
- Berechnet die Prios der Kategorien in einer Kategorie neu.
- nextStatus() : int
- prevStatus() : int
- statusTypes() : array<int, array{: string, : string, : string}>
- Gibt alle Stati zurück, die für eine Kategorie gültig sind.
- reqKey() : void
- Checks whether the required array key $keyName isset.
Methods
addCategory()
Erstellt eine neue Kategorie.
public
static addCategory(int $categoryId, array<string|int, mixed> $data) : string
Parameters
- $categoryId : int
-
KategorieId in der die neue Kategorie erstellt werden soll
- $data : array<string|int, mixed>
-
Array mit den Daten der Kategorie
Tags
Return values
string —Eine Statusmeldung
categoryStatus()
Ändert den Status der Kategorie.
public
static categoryStatus(int $categoryId, int $clang[, int|null $status = null ]) : int
Parameters
- $categoryId : int
-
Id der Kategorie die gelöscht werden soll
- $clang : int
-
Id der Sprache
- $status : int|null = null
-
Status auf den die Kategorie gesetzt werden soll, oder NULL wenn zum nächsten Status weitergeschaltet werden soll
Tags
Return values
int —Der neue Status der Kategorie
copyCategory()
Kopiert eine Kategorie in eine andere.
public
static copyCategory(int $fromCat, int $toCat) : void
Parameters
- $fromCat : int
-
KategorieId der Kategorie, die kopiert werden soll (Quelle)
- $toCat : int
-
KategorieId der Kategorie, IN die kopiert werden soll (Ziel)
deleteCategory()
Löscht eine Kategorie und reorganisiert die Prioritäten verbleibender Geschwister-Kategorien.
public
static deleteCategory(int $categoryId) : string
Parameters
- $categoryId : int
-
Id der Kategorie die gelöscht werden soll
Tags
Return values
string —Eine Statusmeldung
editCategory()
Bearbeitet einer Kategorie.
public
static editCategory(int $categoryId, int $clang, array<string|int, mixed> $data) : string
Parameters
- $categoryId : int
-
Id der Kategorie die verändert werden soll
- $clang : int
-
Id der Sprache
- $data : array<string|int, mixed>
-
Array mit den Daten der Kategorie
Tags
Return values
string —Eine Statusmeldung
moveCategory()
Verschieben einer Kategorie in eine andere.
public
static moveCategory(int $fromCat, int $toCat) : bool
Parameters
- $fromCat : int
-
KategorieId der Kategorie, die verschoben werden soll (Quelle)
- $toCat : int
-
KategorieId der Kategorie, IN die verschoben werden soll (Ziel)
Return values
bool —TRUE bei Erfolg, sonst FALSE
newCatPrio()
Berechnet die Prios der Kategorien in einer Kategorie neu.
public
static newCatPrio(int $parentId, int $clang, int $newPrio, int $oldPrio) : void
Parameters
- $parentId : int
-
KategorieId der Kategorie, die erneuert werden soll
- $clang : int
-
ClangId der Kategorie, die erneuert werden soll
- $newPrio : int
-
Neue PrioNr der Kategorie
- $oldPrio : int
-
Alte PrioNr der Kategorie
nextStatus()
public
static nextStatus(mixed $currentStatus) : int
Parameters
- $currentStatus : mixed
Return values
intprevStatus()
public
static prevStatus(mixed $currentStatus) : int
Parameters
- $currentStatus : mixed
Return values
intstatusTypes()
Gibt alle Stati zurück, die für eine Kategorie gültig sind.
public
static statusTypes() : array<int, array{: string, : string, : string}>
Return values
array<int, array{: string, : string, : string}> —Array von Stati
reqKey()
Checks whether the required array key $keyName isset.
protected
static reqKey(array<string|int, mixed> $array, string $keyName) : void
Parameters
- $array : array<string|int, mixed>
-
The array
- $keyName : string
-
The key