Handbuch:ApiBase.php

This page is a translated version of the page Manual:ApiBase.php and the translation is 100% complete.

Die ApiBase-Klasse implementiert viele grundlegende API-Funktionen und ist die Basis aller API-Klassen. Die Klassen-Funktionen werden in unterschiedliche Funktionsbereiche unterteilt:

  • Modulparameter: Abgeleitete Klassen können getAllowedParams() definieren, um anzugeben, welche Parameter erwartet werden und wie diese geparst und validiert werden.
  • Profilerstellung: Unterschiedliche Methoden, die es ermöglichen, verschiedene Aufgaben und deren Zeitaufwand zu verfolgen.
  • Selbstdokumentation: Code, der es der API erlaubt, ihren eigenen Status zu dokumentieren.

Funktionen

getAllowedParams()

Legt fest, welche Parameter erlaubt sind und welche Anforderungen an sie gestellt werden müssen. Siehe die Dokumentation oben auf includes/api/ApiBase.php für die Konstanten PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED und PARAM_RANGE_ENFORCE. Die möglichen Parametertypen sind NULL, string, integer, limit, boolean, timestamp, user und upload. Ein "user"-Parameter ist ein Benutzername der durch Title::makeTitleSafe() validiert wird. Für boolesche Parameter ist ein anderer Standardwert als 'false' nicht erlaubt.

Beispiel:

// Title parameter.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ApiBase::PARAM_TYPE => 'string',
                        ApiBase::PARAM_REQUIRED => true
                ),
        );
}

getResultProperties() und getFinalResultProperties()

Zu erledigen: Beschreiben, was diese tun

getResult()

Erhält das API-Ergebnis (siehe Handbuch:ApiResult.php).

Hooks

Aus dieser Datei aufgerufene Hooks werden in der Kategorie Category:MediaWiki hooks included in ApiBase.php aufgelistet.

Siehe auch