Manual:ApiBase.php
 | Esta página está desactualizada. |
| Archivo de MediaWiki: ApiBase.php | |
|---|---|
| Ubicación: | includes/api/ (includes/Api/ en 1.46 o posterior) |
| Código fuente: | master • 1.45.1 • 1.44.3 • 1.43.6 |
| Clases: | MediaWiki\Api\ApiBase |
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 $apiBase 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'.
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, 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 (
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
),
);
}
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.
Notable changes
- The class became namespaced (MediaWiki\Api\ApiBase) in MW 1.43. Extensions must update uses of this class accordingly.