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 is the main API class, used for both external and internal processing.
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.
Functions
[edit]getResult()
[edit]getResult() gets the ApiResult object associated with the current request.