Handbuch:ApiBase.php

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

Outdated translations are marked like this.

MediaWiki-Datei: ApiBase.php

Speicherort:

includes/api/ (includes/Api/ in 1.46 or later)

Quellcode:

master • 1.44.2 • 1.43.5 • 1.39.15

Klassen:

MediaWiki\Api\ApiBase

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 $apiBase 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. See the documentation at the top of includes/api/ApiBase.php for the constants PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, PARAM_RANGE_ENFORCE. The possible types of parameters are NULL, string, integer, limit, boolean, timestamp, user, or upload. A "user" parameter is a username that is validated using Title::makeTitleSafe(). For boolean parameters, a default value of anything other than false is not allowed.

Beispiel:

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

getResult()

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

Hooks

APIGetAllowedParams

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

Notable changes

The class became namespaced (MediaWiki\Api\ApiBase) in MW 1.43. Extensions must update uses of this class accordingly.

Siehe auch