Manual:ApiBase.php/pt-br
 | Esta página está desatualizada. |
| Arquivo do MediaWiki: ApiBase.php | |
|---|---|
| Localização: | includes/api/ (includes/Api/ in 1.46 or later) |
| Código-fonte: | master • 1.45.1 • 1.44.3 • 1.43.6 |
| Classes: | MediaWiki\Api\ApiBase |
A classe ApiBase 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
getAllowedParams()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
Funções
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 Title::makeTitleSafe(). Para os parâmetros booleanos, um valor padrão de qualquer coisa que não seja "false" não é permitido.
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.
Exemplo:
// Title parameter.
public function getAllowedParams() {
return array(
'title' => array (
ParamValidator::PARAM_TYPE => 'string',
ParamValidator::PARAM_REQUIRED => true
),
);
}
getResult()
Obtém o resultado da API (consulte Manual:ApiResult.php).
Hooks
Hooks chamados a partir deste arquivo estão listados na categoria 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.