\rex_article_service

Summary

Methods
Properties
Constants
addArticle()
editArticle()
deleteArticle()
_deleteArticle()
articleStatus()
statusTypes()
nextStatus()
prevStatus()
newArtPrio()
article2category()
category2article()
article2startarticle()
copyMeta()
copyArticle()
moveArticle()
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

addArticle()

addArticle(array  $data) : string

Erstellt einen neuen Artikel.

Parameters

array $data

Array mit den Daten des Artikels

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

editArticle()

editArticle(int  $articleId, int  $clang, array  $data) : string

Bearbeitet einen Artikel.

Parameters

int $articleId

Id des Artikels der verändert werden soll

int $clang

Id der Sprache

array $data

Array mit den Daten des Artikels

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

deleteArticle()

deleteArticle(int  $articleId) : string

Löscht einen Artikel und reorganisiert die Prioritäten verbleibender Geschwister-Artikel.

Parameters

int $articleId

Id des Artikels die gelöscht werden soll

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

_deleteArticle()

_deleteArticle(int  $id) : string

Löscht einen Artikel.

Parameters

int $id

ArtikelId des Artikels, der gelöscht werden soll

Throws

\rex_api_exception

Returns

string —

Eine Statusmeldung

articleStatus()

articleStatus(int  $articleId, int  $clang, int|null  $status = null) : int

Ändert den Status des Artikels.

Parameters

int $articleId

Id des Artikels die gelöscht werden soll

int $clang

Id der Sprache

int|null $status

Status auf den der Artikel gesetzt werden soll, oder NULL wenn zum nächsten Status weitergeschaltet werden soll

Throws

\rex_api_exception

Returns

int —

Der neue Status des Artikels

statusTypes()

statusTypes() : array

Gibt alle Stati zurück, die für einen Artikel 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 —

newArtPrio()

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

Berechnet die Prios der Artikel 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 —

article2category()

article2category(int  $artId) : bool

Konvertiert einen Artikel in eine Kategorie.

Parameters

int $artId

Artikel ID des Artikels, der in eine Kategorie umgewandelt werden soll

Returns

bool —

TRUE bei Erfolg, sonst FALSE

category2article()

category2article(int  $artId) : bool

Konvertiert eine Kategorie in einen Artikel.

Parameters

int $artId

Artikel ID der Kategorie, die in einen Artikel umgewandelt werden soll

Returns

bool —

TRUE bei Erfolg, sonst FALSE

article2startarticle()

article2startarticle(int  $neuId) : bool

Konvertiert einen Artikel zum Startartikel der eigenen Kategorie.

Parameters

int $neuId

Artikel ID des Artikels, der Startartikel werden soll

Returns

bool —

TRUE bei Erfolg, sonst FALSE

copyMeta()

copyMeta(int  $fromId, int  $toId, int  $fromClang = 1, int  $toClang = 1, array  $params = []) : bool

Kopiert die Metadaten eines Artikels in einen anderen Artikel.

Parameters

int $fromId

ArtikelId des Artikels, aus dem kopiert werden (Quell ArtikelId)

int $toId

ArtikelId des Artikel, in den kopiert werden sollen (Ziel ArtikelId)

int $fromClang

ClangId des Artikels, aus dem kopiert werden soll (Quell ClangId)

int $toClang

ClangId des Artikels, in den kopiert werden soll (Ziel ClangId)

array $params

Array von Spaltennamen, welche kopiert werden sollen

Returns

bool —

TRUE bei Erfolg, sonst FALSE

copyArticle()

copyArticle(int  $id, int  $toCatId) : bool|int

Kopieren eines Artikels von einer Kategorie in eine andere.

Parameters

int $id

ArtikelId des zu kopierenden Artikels

int $toCatId

KategorieId in die der Artikel kopiert werden soll

Returns

bool|int —

FALSE bei Fehler, sonst die Artikel Id des neue kopierten Artikels

moveArticle()

moveArticle(int  $id, int  $fromCatId, int  $toCatId) : bool

Verschieben eines Artikels von einer Kategorie in eine Andere.

Parameters

int $id

ArtikelId des zu verschiebenden Artikels

int $fromCatId

KategorieId des Artikels, der Verschoben wird

int $toCatId

KategorieId in die der Artikel verschoben werden soll

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 —