Manual:ApiBase.php/fr

La classe   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 zones de fonctionnalité :


 * Paramètres du module : les classes dérivées peuvent définir  pour spécifier les paramètres à attendre, comment les analyser et les valider.
 * Profiling : diverses méthodes permettant de garder les onglets sur les différentes tâches et leurs coûts de temps
 * Auto-documentation : code permettant à l'API de documenter son propre état

getAllowedParams
Indiquez quels paramètres sont autorisés et quelles exigences doivent être imposées. Voir la documentation commençant à la ligne 46 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, timestamp, utilisateur ou upload. Un paramètre "utilisateur" est un nom d'utilisateur qui est validé en utilisant. Pour les paramètres booléens, une valeur par défaut autre que 'false' n'est pas autorisée.

Exemple:

getResultProperties et getFinalResultProperties
À FAIRE: Décrivez ce qu'ils font

getResult
Obtient le résultat API (voir Manual:ApiResult.php).

Hooks


Les hooks appelés à partir de ce fichier sont répertoriés dans la catégorie MediaWiki hooks inclus dans ApiBase.php.

Voir aussi

 * Stratégie d'implémentation de l'API
 * Manuel:Code
 * Manuel:Code
 * Manuel:Code