Manual:ApiBase.php/pt-br

A classe  implementa muitas funções básicas da API, e é a base de todas as classes da API. As funções de classe estão divididas em várias áreas de funcionalidade:


 * Parâmetros de módulo: As classes derivadas podem definir  para especificar quais os parâmetros esperar, como analisá-los e validá-los.
 * Perfil: vários métodos que permitam manter o controle sobre várias tarefas e os seus custos de tempo
 * Auto-documentação: código para permitir que a API documente seu próprio estado

getAllowedParams
Especifica quais parâmetros são permitidos e quais os requisitos que devem ser impostos a eles. Consulte a documentação começando na linha 46 para as constantes PARAM_DFLT, PARAM_ISMULTI, PARAM_TYPE, PARAM_MAX, PARAM_MAX2, PARAM_MIN, PARAM_ALLOW_DUPLICATES, PARAM_DEPRECATED, PARAM_REQUIRED, e PARAM_RANGE_ENFORCE. Os tipos possíveis de parâmetros são NULL, string, integer, limit, boolean, timestamp, user, ou upload. Um parâmetro "user" é um nome de usuário que é validado utilizando. Para os parâmetros booleanos, um valor padrão de qualquer coisa que não seja "false" não é permitido.

Exemplo:

getResultProperties e getFinalResultProperties
PENDENTE: Descrever o funcionamento destas funções.

getResult
Obtém o resultado da API (consulte Manual:ApiResult.php).

Hooks


Hooks chamados a partir deste arquivo estão listados na categoria MediaWiki hooks included in ApiBase.php.

Ver também

 * API Implementation Strategy