Manual:ApiBase.php

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

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:

  • Módulo de Parámetros: las clases derivadas pueden definir getAllowedParams() para especificar qué parámetros esperar, cómo analizarlos y validarlos.
  • Perfilado: varios métodos para permitir el cuidado de tabuladores en varias tareas y sus costes de tiempo
  • Auto-documentación: código para permitir que la API documente su propio estado

Funciones

getAllowedParams()

Especificar qué parámetros están permitidos y qué requisitos se les impondrán. Consulte la documentación en la parte superior de includes/api/ApiBase.php para las constantes PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED y PARAM_RANGE_ENFORCE. Los posibles tipos de parámetros son NULL, string, integer, limit, boolean, timestamp, user o upload. Un parámetro "usuario" es un nombre de usuario que se valida usando Title::makeTitleSafe(). Para los parámetros booleanos, no se permite un valor predeterminado que no sea 'falso'.

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

Los ganchos llamados desde este archivo se enumeran en la Categoría Category:MediaWiki hooks included in ApiBase.php .

Véase también