Manual:ApiBase.php/de

Die  -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  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.

getAllowedParams
Legt fest, welche Parameter erlaubt sind und welche Anforderungen an sie gestellt werden müssen. Siehe die Dokumentation oben auf 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  validiert wird. Für boolesche Parameter ist ein anderer Standardwert als 'false' nicht erlaubt.

Beispiel:



getResultProperties und getFinalResultProperties
Zu erledigen: Beschreiben, was diese tun

getResult
Erhält das API-Ergebnis (siehe ).

Hooks


Aus dieser Datei aufgerufene Hooks werden in der Kategorie aufgelistet.



Siehe auch

 * API-Implementationsstrategie