Manuel:ApiBase.php

From MediaWiki.org
Jump to navigation Jump to search
This page is a translated version of the page Manual:ApiBase.php and the translation is 93% complete.
Outdated translations are marked like this.
Other languages:
English • ‎Nederlands • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎русский • ‎کوردی • ‎ไทย • ‎中文 • ‎日本語

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

  • Paramètres du module : les classes dérivées peuvent définir getAllowedParams() 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

Fonctions

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 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é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