Public Member Functions | |
__construct ($main, $action) | |
getCustomPrinter () | |
If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getAllowedParams () | |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. | |
getParamDescription () | |
Returns an array of parameter descriptions. | |
getDescription () | |
Returns the description string for this module. | |
getVersion () | |
Returns a string that identifies the version of the extending class. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. |
Definition at line 34 of file ApiOpenSearch.php.
ApiOpenSearch::__construct | ( | $ | main, | |
$ | action | |||
) |
ApiOpenSearch::execute | ( | ) |
Evaluates the parameters, performs the requested query, and sets up the result.
Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.
The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.
The result data should be stored in the ApiResult object available through getResult().
Reimplemented from ApiBase.
Definition at line 44 of file ApiOpenSearch.php.
References $result, $wgEnableMWSuggest, ApiBase::extractRequestParams(), ApiBase::getMain(), ApiBase::getResult(), and PrefixSearch::titleSearch().
ApiOpenSearch::getAllowedParams | ( | ) |
Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
Reimplemented from ApiBase.
Definition at line 65 of file ApiOpenSearch.php.
References ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, ApiBase::PARAM_MAX, ApiBase::PARAM_MAX2, ApiBase::PARAM_MIN, and ApiBase::PARAM_TYPE.
ApiOpenSearch::getCustomPrinter | ( | ) |
If the module may only be used with a certain format module, it should override this method to return an instance of that formatter.
A value of null means the default format will be used.
Reimplemented from ApiBase.
Definition at line 40 of file ApiOpenSearch.php.
References ApiBase::getMain().
ApiOpenSearch::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 93 of file ApiOpenSearch.php.
ApiOpenSearch::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 97 of file ApiOpenSearch.php.
ApiOpenSearch::getParamDescription | ( | ) |
Returns an array of parameter descriptions.
Don't call this functon directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.
Reimplemented from ApiBase.
Definition at line 84 of file ApiOpenSearch.php.
ApiOpenSearch::getVersion | ( | ) |
Returns a string that identifies the version of the extending class.
Typically includes the class name, the svn revision, timestamp, and last author. Usually done with SVN's Id keyword
Reimplemented from ApiBase.
Definition at line 103 of file ApiOpenSearch.php.