Api

/**
 * Beispiel einer einfachen rex_api_function Implementierung
 *
 * Über diese API-Funktion kann der Name einer Kategorie ausgegeben werden, deren ID mit übergeben wird.
 * Falls die Kategorie nicht existiert, wird eine Fehlermeldung erzeugt.
 * Aufruf: index.php?rex-api-call=demo&category_id=XX
 */
class rex_api_demo extends rex_api_function
{
    public function execute()
    {
        // Hier wird die Kategorie anhand einer übergebenen ID ausgelesen
        $category_id = rex_request('category_id', 'int');
        $category = rex_category::get($category_id);

        // Falls die Kategorie nicht existiert, wird eine Fehlermeldung ausgelöst
        if (!$category instanceof rex_category) {
          throw new rex_api_exception('Kategorie existiert nicht!');
        }

        // Existiert die Kategorie, wird eine Meldung mit dem Namen der Kategorie zurückgegeben
        return new rex_api_result(true, 'Der Kategorie-Name lautet: '.$category->getName());
    }
}

// Explizite Registrierung einer API-Funktion
rex_api_function::register('my-api', MyNamespace\MyApiClass::class);

// Aufruf über die registrierte Bezeichnung
// index.php?rex-api-call=my-api

<?php
namespace MyAddon\Api;

class UserManager extends \rex_api_function
{
    public function execute()
    {
        $action = rex_request('action', 'string');

        switch ($action) {
            case 'activate':
                return $this->activateUser();
            case 'deactivate':
                return $this->deactivateUser();
            default:
                throw new \rex_api_exception('Invalid action');
        }
    }

    private function activateUser()
    {
        // Benutzer aktivieren
        return new \rex_api_result(true, 'User activated');
    }

    private function deactivateUser()
    {
        // Benutzer deaktivieren
        return new \rex_api_result(true, 'User deactivated');
    }
}

// Registrierung in der boot.php
rex_api_function::register('user-manager', MyAddon\Api\UserManager::class);

index.php?rex-api-call=user-manager&action=activate&user_id=5

// Funktioniert nur innerhalb von rex_api_function
// Gibt Namen der Funktion und ein CSRF Token zurück  
$url_params = rex_api_function::getUrlParams();

// Funktioniert nur innerhalb von rex_api_function
// Gibt den Namen der Funktion und ein CSRF-Token als verstecktes <input> feld zurück
echo rex_api_function::getHiddenFields();

$result = new rex_api_result($status, $message);

// Der Status ist bei Erfolg 'true'
$status = $result->isSuccessfull()

// Gibt die Nachricht ohne zusätzliche Formatierung aus
echo $result->getMessage();

// Gibt die Nachricht anhand des Parameters $status formatiert aus
// Erfolgsmeldungen werden mit rex_view::success() formatiert,
// Fehlschläge werden mit rex_view::error() formatiert
echo $result->getFormattedMessage();

// Falls die Rückmeldung einen zusätzlichen Request erfordert, um z.B. Low-Level-Änderungen zu übernehmen, kann ein
// Flag gesetzt werden:
$result->setRequiresReboot($requires_reboot);

// Der Flag kann so abgefragt werden:
$result->requiresReboot();

// Ergebnis kodieren
// Wandelt die Daten eines rex_api_result Objektes in einen JSON-String
$json = $result->toJSON();

// Ergebnis dekodieren
// Wandelt ein JSON kodiertes Ergebnis zurück in ein rex_api_result Objekt.
$result = rex_api_result::fromJSON($json);

$slice = rex_article_slice::getArticleSliceById($slice_id);
if ($slice) {
    $status = $slice->getStatus();
    // Status: 1 = online, 0 = offline
}

// Nur online Slices eines Artikels abrufen
$slices = rex_article_slice::getSlicesForArticle($article_id, $clang, $revision, true);

// Nur online Slices eines bestimmten Modultyps abrufen
$slices = rex_article_slice::getSlicesForArticleOfType($article_id, $module_id, $clang, $revision, true);

// Erstes online Slice für einen Artikel finden
$slice = rex_article_slice::getFirstSliceForArticle($article_id, $clang, $revision, true);

// Erstes online Slice für einen Ctype finden
$slice = rex_article_slice::getFirstSliceForCtype($ctype, $article_id, $clang, $revision, true);

// Nächstes/Vorheriges online Slice abrufen
$nextSlice = $slice->getNextSlice(true);
$prevSlice = $slice->getPreviousSlice(true);