ApiOpenSearch Class Reference

Inheritance diagram for ApiOpenSearch:

Collaboration diagram for ApiOpenSearch:

List of all members.

Public Member Functions
	__construct ($main, $action)
	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.
	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.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Returns an array of parameter descriptions.
	getVersion ()
	Returns a string that identifies the version of the extending class.

---

Detailed Description

Definition at line 30 of file ApiOpenSearch.php.

---

Constructor & Destructor Documentation

ApiOpenSearch::__construct	(	$	main,
		$	action
	)

Definition at line 32 of file ApiOpenSearch.php.

---

Member Function Documentation

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 40 of file ApiOpenSearch.php.

References $limit, $result, $wgContLang, $wgEnableOpenSearchSuggest, $wgSearchSuggestCacheExpiry, ApiBase\extractRequestParams(), ApiBase\getMain(), ApiBase\getResult(), and PrefixSearch\titleSearch().

Here is the call graph for this function:

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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 85 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.

Returns:

mixed instance of a derived class of ApiFormatBase, or null

Reimplemented from ApiBase.

Definition at line 36 of file ApiOpenSearch.php.

References ApiBase\getMain().

Here is the call graph for this function:

ApiOpenSearch::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 113 of file ApiOpenSearch.php.

ApiOpenSearch::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiBase.

Definition at line 117 of file ApiOpenSearch.php.

ApiOpenSearch::getHelpUrls

(

)

Returns:

false|string|array Returns a false if the module has no help url, else returns a (array of) string

Reimplemented from ApiBase.

Definition at line 123 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.

Returns:

array or false

Reimplemented from ApiBase.

Definition at line 104 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

Returns:

string

Reimplemented from ApiBase.

Definition at line 127 of file ApiOpenSearch.php.

---

The documentation for this class was generated from the following file:

• includes/api/ApiOpenSearch.php