ApiParamInfo Class Reference

Inheritance diagram for ApiParamInfo:

Collaboration diagram for ApiParamInfo:

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.
	getClassInfo ($obj)
	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.
	isReadMode ()
	Indicates whether this module requires read rights.
Protected Attributes
ApiQuery	$queryObj

---

Detailed Description

Definition at line 30 of file ApiParamInfo.php.

---

Constructor & Destructor Documentation

ApiParamInfo::__construct	(	$	main,
		$	action
	)

Definition at line 36 of file ApiParamInfo.php.

References ApiBase\getMain().

---

Member Function Documentation

ApiParamInfo::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 41 of file ApiParamInfo.php.

References $f, $params, $res, $result, ApiBase\extractRequestParams(), getClassInfo(), ApiBase\getMain(), ApiBase\getModuleName(), and ApiBase\getResult().

ApiParamInfo::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|bool

Reimplemented from ApiBase.

Definition at line 320 of file ApiParamInfo.php.

References ApiBase\getMain().

ApiParamInfo::getClassInfo

(

$

obj

)

Parameters:

$obj

ApiBase

Returns:

ApiResult

Definition at line 112 of file ApiParamInfo.php.

Referenced by execute().

ApiParamInfo::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 355 of file ApiParamInfo.php.

ApiParamInfo::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

bool|string|array

Reimplemented from ApiBase.

Definition at line 359 of file ApiParamInfo.php.

ApiParamInfo::getHelpUrls

(

)

Returns:

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

Reimplemented from ApiBase.

Definition at line 365 of file ApiParamInfo.php.

ApiParamInfo::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|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 345 of file ApiParamInfo.php.

ApiParamInfo::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 369 of file ApiParamInfo.php.

ApiParamInfo::isReadMode

(

)

Indicates whether this module requires read rights.

Returns:

bool

Reimplemented from ApiBase.

Definition at line 316 of file ApiParamInfo.php.

---

Member Data Documentation

ApiQuery ApiParamInfo::$queryObj [protected]

Definition at line 34 of file ApiParamInfo.php.

---

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

• includes/api/ApiParamInfo.php