expservices: entfernte Dienste für Erweiterungen #

Teil 8, Referenz 33. expservices ist eine mit dem Kernel ausgelieferte Erweiterung, die die Funktionen der Installation als Dienste über ezjscore anbietet: eine Klasse je Bereich (System, Caches, Einstellungen, Benutzer, Inhalte ...), aufgerufen als <root>/ezjscore/call/exp<domain>::<method>, mit der Antwort in einem einheitlichen JSON-Umschlag. Apps, Skripte und andere Server verwenden sie; eine Erweiterung kann einen eigenen Bereich hinzufügen. Die vollständige Dokumentation ist Backend-Dienste über ezjscore.

Was Sie gegenüber einer einfachen Serverfunktion gewinnen #

Einen Dienst schreiben #

Nach dem Beispiel der Dokumentation, mit Ihrem Bereich:

<?php
class expMyExtServices extends expServiceBase
{
    public static $services = array(
        'itemName' => array( 'summary' => 'The name of one item',
            'access' => array( 'myext', 'read' ), 'write' => false,
            'args' => array( 'item_id' => 'int' ), 'returns' => 'id, name' ),
    );

    public static function itemName( $args )
    {
        self::guard( __FUNCTION__ );
        $item = myExtItem::fetch( self::arg( $args, 0, 'int' ) );
        if ( !$item )
        {
            throw new expServiceException( 'No such item', 404 );
        }
        return self::ok( array( 'id' => (int)$item->attribute( 'id' ), 'name' => $item->attribute( 'name' ) ) );
    }
}

Registrieren Sie ihn in settings/ezjscore.ini.append.php Ihrer Erweiterung:

[ezjscServer_expmyext]
Class=expMyExtServices

und erzeugen Sie die Autoloads neu. Aufgerufen wird er als <root>/ezjscore/call/expmyext::itemName::42.

Codes von expServiceException: 400 (Argumente), 401 (Anmeldung nötig), 403 (verweigert), 404 (nicht gefunden), 409 (Konflikt), 422 (ungültig).

Sicherheit #

• Jeder Dienst deklariert seinen Zugriff; 'public' nur für das, was anonyme Besucher wissen dürfen.
• Schreibzugriffe erfolgen per POST mit dem Formular-Token oder mit einem API-Token und werden im Audit-Log festgehalten.
• Die ezjscore-Richtlinie ezjscore/call gilt weiterhin (Referenz der ezjscore-Serverfunktionen).
• Geben Sie nie Passwörter, Tokens oder personenbezogene Daten zurück, die ein Aufrufer nicht braucht.

Demomodus. Im Demomodus (EXP_DEMO_MODE=1) verweigern die Passwortmethoden Administratoren: requireAcceptablePassword() wirft HTTP 403 mit expDemoMode::refusalText(), und expaccount.forgotRequest erzeugt für einen Administrator keinen Schlüssel. Ein eigener Dienst, der Passwörter ändert, sollte zuerst expDemoMode::protectsPassword() fragen. Demomodus für Entwickler.

Verwandte Seiten #

• Zurück: Das Hilfesystem für Erweiterungen
• Weiter: Glossar für Erweiterungsentwickler
• Backend-Dienste über ezjscore
• API-Schlüssel
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.