Manual:ApiBase.php

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

MediaWiki bestand: ApiBase.php
Locatie:	includes/api/
Broncode:	master • 1.41.1 • 1.40.3 • 1.39.7
Classes:	ApiBase

De class ApiBase implementeert veel basis API-functies, het is de basis van alle API-classes. De class-functies worden op diverse gebieden van functionaliteit verdeeld:

Module parameters: Afgeleide classes kunnen getAllowedParams() definiëren om te specificeren welke parameters worden verwacht, hoe ze te verwerken en te valideren.
Profiling: verschillende methoden voor het toestaan tabs op verschillende taken te houden en de benodigde tijd
Self-documentation: code op de API toe te staan de eigen status te documenteren

Functies

getAllowedParams()

Specificeer welke parameters zijn toegestaan en welke vereisten er aan gesteld kunnen worden. Zie de documentatie bovenaan includes/api/ApiBase.php voor de constanten PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED en PARAM_RANGE_ENFORCE. De mogelijke parametertypes zijn NULL, string, integer, limit, boolean, timestamp, user en upload. Een parameter "user" is een gebruikersnaam die gevalideerd is met Title::makeTitleSafe(). Voor parameters van het type boolean, een standaardwaarde anders dan 'false' is niet toegestaan.

Voorbeeld:

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

getResultProperties() en getFinalResultProperties()

TODO: Beschrijf wat deze doen

getResult()

Haalt het resultaat van de API op (zie Manual:ApiResult.php ).

Hooks

APIGetAllowedParams

De hooks die in dit bestand worden aangeroepen staan in de categorie Category:MediaWiki hooks included in ApiBase.php .

Zie ook