MediaWiki file: ApiMain.php
Location: includes/api/
Source code: master 1.40.0 1.39.4 1.35.11
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

getResult()

getResult() gets the ApiResult object associated with the current request.

See also

  • Manual:ApiBase.php
This article is issued from Mediawiki. The text is licensed under Creative Commons - Attribution - Sharealike. Additional terms may apply for the media files.