Manuel:ApiBase.php

This page is a translated version of the page Manual:ApiBase.php and the translation is 100% complete.

Emplacement :

includes/api/ (includes/Api/ in 1.46 or later)

Code source :

Classes :

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 leur doivent être imposées. Voir la documentation au début 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, PARAM_RANGE_ENFORCE. Les types possibles de paramètres sont : NULL, string, integer, limit, boolean, timestamp, user, upload. Un paramètre 'user' 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 :

// paramètre Title.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ParamValidator::PARAM_TYPE => 'string',
                        ParamValidator::PARAM_REQUIRED => true
                ),
        );
}

getResult()

Récupère le résultat de l'API (voir Manuel:ApiResult.php ).

Accroches

APIGetAllowedParams

Les accroches appelées à partir de ce fichier appartiennent à la catégorie Category:MediaWiki hooks included in ApiBase.php .

Modifications remarquables

La classe a été affectée à un espace de noms (MediaWiki\Api\ApiBase) en MW 1.43 . Les extensions doivent mettre à jour les utilisations de cette classe en conséquence.

Voir aussi