Documentation

rex_article_service
in package

Table of Contents

Methods

_deleteArticle()  : string
Löscht einen Artikel.
addArticle()  : string
Erstellt einen neuen Artikel.
article2category()  : bool
Konvertiert einen Artikel in eine Kategorie.
article2startarticle()  : bool
Konvertiert einen Artikel zum Startartikel der eigenen Kategorie.
articleStatus()  : int
Ändert den Status des Artikels.
category2article()  : bool
Konvertiert eine Kategorie in einen Artikel.
copyArticle()  : bool|int
Kopieren eines Artikels von einer Kategorie in eine andere.
copyMeta()  : bool
Kopiert die Metadaten eines Artikels in einen anderen Artikel.
deleteArticle()  : string
Löscht einen Artikel und reorganisiert die Prioritäten verbleibender Geschwister-Artikel.
editArticle()  : string
Bearbeitet einen Artikel.
moveArticle()  : bool
Verschieben eines Artikels von einer Kategorie in eine Andere.
newArtPrio()  : void
Berechnet die Prios der Artikel in einer Kategorie neu.
nextStatus()  : int
prevStatus()  : int
statusTypes()  : array<int, array{: string, : string, : string}>
Gibt alle Stati zurück, die für einen Artikel gültig sind.
reqKey()  : void
Checks whether the required array key $keyName isset.

Methods

_deleteArticle()

Löscht einen Artikel.

public static _deleteArticle(int $id) : string
Parameters
$id : int

ArtikelId des Artikels, der gelöscht werden soll

Tags
throws
rex_api_exception
Return values
string

Eine Statusmeldung

addArticle()

Erstellt einen neuen Artikel.

public static addArticle(array<string|int, mixed> $data) : string
Parameters
$data : array<string|int, mixed>

Array mit den Daten des Artikels

Tags
throws
rex_api_exception
Return values
string

Eine Statusmeldung

article2category()

Konvertiert einen Artikel in eine Kategorie.

public static article2category(int $artId) : bool
Parameters
$artId : int

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

Return values
bool

TRUE bei Erfolg, sonst FALSE

article2startarticle()

Konvertiert einen Artikel zum Startartikel der eigenen Kategorie.

public static article2startarticle(int $neuId) : bool
Parameters
$neuId : int

Artikel ID des Artikels, der Startartikel werden soll

Return values
bool

TRUE bei Erfolg, sonst FALSE

articleStatus()

Ändert den Status des Artikels.

public static articleStatus(int $articleId, int $clang[, int|null $status = null ]) : int
Parameters
$articleId : int

Id des Artikels die gelöscht werden soll

$clang : int

Id der Sprache

$status : int|null = null

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

Tags
throws
rex_api_exception
Return values
int

Der neue Status des Artikels

category2article()

Konvertiert eine Kategorie in einen Artikel.

public static category2article(int $artId) : bool
Parameters
$artId : int

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

Return values
bool

TRUE bei Erfolg, sonst FALSE

copyArticle()

Kopieren eines Artikels von einer Kategorie in eine andere.

public static copyArticle(int $id, int $toCatId) : bool|int
Parameters
$id : int

ArtikelId des zu kopierenden Artikels

$toCatId : int

KategorieId in die der Artikel kopiert werden soll

Return values
bool|int

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

copyMeta()

Kopiert die Metadaten eines Artikels in einen anderen Artikel.

public static copyMeta(int $fromId, int $toId[, int $fromClang = 1 ][, int $toClang = 1 ][, array<string|int, mixed> $params = [] ]) : bool
Parameters
$fromId : int

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

$toId : int

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

$fromClang : int = 1

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

$toClang : int = 1

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

$params : array<string|int, mixed> = []

Array von Spaltennamen, welche kopiert werden sollen

Return values
bool

TRUE bei Erfolg, sonst FALSE

deleteArticle()

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

public static deleteArticle(int $articleId) : string
Parameters
$articleId : int

Id des Artikels die gelöscht werden soll

Tags
throws
rex_api_exception
Return values
string

Eine Statusmeldung

editArticle()

Bearbeitet einen Artikel.

public static editArticle(int $articleId, int $clang, array<string|int, mixed> $data) : string
Parameters
$articleId : int

Id des Artikels der verändert werden soll

$clang : int

Id der Sprache

$data : array<string|int, mixed>

Array mit den Daten des Artikels

Tags
throws
rex_api_exception
Return values
string

Eine Statusmeldung

moveArticle()

Verschieben eines Artikels von einer Kategorie in eine Andere.

public static moveArticle(int $id, int $fromCatId, int $toCatId) : bool
Parameters
$id : int

ArtikelId des zu verschiebenden Artikels

$fromCatId : int

KategorieId des Artikels, der Verschoben wird

$toCatId : int

KategorieId in die der Artikel verschoben werden soll

Return values
bool

TRUE bei Erfolg, sonst FALSE

newArtPrio()

Berechnet die Prios der Artikel in einer Kategorie neu.

public static newArtPrio(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
int

prevStatus()

public static prevStatus(mixed $currentStatus) : int
Parameters
$currentStatus : mixed
Return values
int

statusTypes()

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

Tags
throws
rex_api_exception

        
On this page

Search results