Handleiding:ApiBase.php
 | Deze pagina is verouderd. |
| MediaWiki bestand: ApiBase.php | |
|---|---|
| Locatie: | includes/api/ (includes/Api/ in 1.46 of later) |
| Broncode: | master • 1.44.2 • 1.43.5 • 1.39.15 |
| Classes: | MediaWiki\Api\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, 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 (
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
),
);
}
getResult()
Haalt het resultaat van de API op (zie Manual:ApiResult.php).
Hooks
De hooks die in dit bestand worden aangeroepen staan in de categorie Category:MediaWiki hooks included in ApiBase.php.
Min of meer belangrijke wijzigingen
- The class became namespaced (MediaWiki\Api\ApiBase) in MW 1.43. Extensions must update uses of this class accordingly.