Manual:ApiMain.php
Esta página está desatualizada. |
Arquivo MediaWiki: ApiMain.php | |
---|---|
Local: | includes/api/ |
Código fonte: | master • 1.42.3 • 1.41.4 • 1.39.10 |
Classes: | ApiMain |
ApiMain é a classe API principal, usada tanto para o processamento externo quanto para o interno. Quando executado, ele criará o objeto de formatador solicitado, instanciará e executará um objeto associado à ação necessária e usará o formatador para imprimir resultados. No caso de uma exceção, uma mensagem de erro será impressa usando o mesmo formatador. Para usar a API de outro aplicativo, execute-o usando o objeto $faux, caso em que quaisquer exceções internas não serão tratadas, mas passadas para o chamador. Após a execução bem-sucedida, use getResult()
para os dados resultantes.
When executed, it will create the requested formatter object, instantiate and execute an object associated with the needed action, and use formatter to print results.
In case of an exception, an error message will be printed using the same formatter.
To call the API programmatically for testing, run it using the FauxRequest object, in which case any internal exceptions will not be handled but passed up to the caller.
After successful execution, use getResult()
for the resulting data.
Funções
getResult()
getResult()
Obtém o objeto ApiResult associado à solicitação atual.