Manuel:ApiBase.php
 | Cette page est obsolète. |
| Fichier MediaWiki : ApiBase.php | |
|---|---|
| Emplacement : | includes/api/ |
| Code source : | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes : | ApiBase |
La classe ApiBase implémente plusieurs fonctions de base de l'API et constitue la base de toutes les classes de l'API.
Les fonctions de classe sont divisées en plusieurs groupes de fonctionnalités :
- Paramètres du module : les classes dérivées peuvent définir
getAllowedParams()pour spécifier les paramètres attendus, comment les analyser et les valider. - Profiling : diverses méthodes permettant de garder des onglets sur différentes tâches et leur temps d'exécution
- Auto-documentation : code permettant à l'API de documenter son propre état
Fonctions
getAllowedParams()
Indiquez quels paramètres sont autorisés et quelles exigences doivent être imposées. Voir la documentation commençant en haut de includes/api/ApiBase.php pour les constantes PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED et PARAM_RANGE_ENFORCE. Les types possibles de paramètres sont NULL, chaîne, entier, limite, booléen, horodatage, utilisateur ou upload. Un paramètre "utilisateur" est un nom d'utilisateur qui est validé en utilisant Title::makeTitleSafe(). Pour les paramètres booléens, une valeur par défaut autre que 'false' n'est pas autorisée.
Exemple :
// Title parameter.
public function getAllowedParams() {
return array(
'title' => array (
ApiBase::PARAM_TYPE => 'string',
ApiBase::PARAM_REQUIRED => true
),
);
}
getResultProperties() et getFinalResultProperties()
À FAIRE : Décrire ce qu'ils font
getResult()
Obtient le résultat de l'API (voir Manual:ApiResult.php).
Hooks
Les hooks appelés à partir de ce fichier sont répertoriés dans la catégorie Category:MediaWiki hooks included in ApiBase.php.