Manual: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 73% complete.

Other languages:
English • ‎Türkçe • ‎dansk • ‎español • ‎français • ‎polski • ‎português do Brasil • ‎română • ‎русский • ‎العربية • ‎فارسی • ‎ไทย • ‎中文 • ‎日本語 • ‎한국어

El ApiBase implementa muchas de las funciones básicas de la API, y es la base de todas las clases de la API. Las funciones de clase se dividen en varias áreas de funcionalidad:

  • Module parameters: Derived classes can define getAllowedParams() to specify which parameters to expect, how to parse and validate them.
  • Profiling: various methods to allow keeping tabs on various tasks and their time costs
  • Self-documentation: code to allow the API to document its own state

Funciones

getAllowedParams()

Specify which parameters are allowed and what requirements are to be imposed on them. See the documentation at the top of includes/api/ApiBase.php for the constants PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, and PARAM_RANGE_ENFORCE. The possible types of parameters are NULL, string, integer, limit, boolean, timestamp, user, or upload. A "user" parameter is a username that is validated using Title::makeTitleSafe(). For boolean parameters, a default value of anything other than 'false' is not allowed.

Ejemplo:

// Title parameter.
public function getAllowedParams() {
        return array(
                'title' => array (
                        ApiBase::PARAM_TYPE => 'string',
                        ApiBase::PARAM_REQUIRED => true
                ),
        );
}

getResultProperties() y getFinalResultProperties()

PENDIENTE: describir lo que hacen

getResult()

Obtiene el resultado de la API (véase Manual:ApiResult.php).

Ganchos

Hooks called from this file are listed in the MediaWiki hooks included in ApiBase.php category.

Véase también