Manual:ApiBase.php/af

Die"' klas'"implementeer baie basiese API-funksies,en is die basis van alle API-klasse.Die klasfunksies word in verskillende funksiesareas verdeel:


 *  'Moduleparameters' : Afgeleide klasse kan  definieer om te spesifiseer watter parameters om te verwag, hoe om dit te ontleed en te valideer.
 *  'Profiling' : verskillende metodes om die verskillende take en tydskoste te hou
 *  'Selfdokumentasie' : kode om die API toe te laat om sy eie staat te dokumenteer

getAllowedParams
Spesifiseer watter parameters toegelaat word en watter vereistes daaraan gestel moet word. Kyk na die dokumentasie aan die bokant van vir die konstante PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED en PARAM_RANGE_ENFOR. Die moontlike tipes parameters is NULL, string, heelgetal, limiet, Boole, tydstempel, gebruiker of oplaai. 'N "Gebruiker" -parameter is 'n gebruikersnaam wat bekragtig word met. Vir Boole-parameters is 'n standaardwaarde van iets anders as 'onwaar' nie toegelaat nie.

Voorbeeld"

getResultProperties en getFinalResultProperties
TODO:Beskryf wat hierdie dinge doen

getResult
kry die API-resultaat (sien Handleiding:ApiResult.php).

Hooks


Haken wat van heirdie lêer genoem word, word gelys in die MediaWiki-hake ingesluit in ApiBase.phpkategorie.

Sien ook

 * API Implementeringsstrategie