Manual:ApiMain.php
This page is outdated. |
| MediaWiki file: ApiMain.php | |
|---|---|
| Location: | includes/api/ |
| Source code: | master • 1.42.3 • 1.41.4 • 1.39.10 |
| Classes: | ApiMain |
ApiMain ye la clase principal de la API, que s'usa tanto pal procesamientu esternu como internu. Al executala, creará l'oxetu formateador solicitáu, instanciará y executará un oxetu asociáu cola aición necesaria, y usa el formateador pa imprimir los resultaos. En casu d'una esceición, imprimiráse un mensaxe d'error usando'l mesmu formateador. Pa usar la API dende otra aplicación, execútala usando l'oxetu $faux; nesti casu nun se xestionarán les esceiciones internes, sinón que se pasarán al llamante. Tres una execución correuta, usa getResult() pa los datos 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.
Funciones
getResult()
getResult() algama l'oxetu ApiResult asociáu cola solicitú actual.