ApiQueryStashImageInfo Class Reference

A query action to get image information from temporarily stashed files. More...

Inheritance diagram for ApiQueryStashImageInfo:

Collaboration diagram for ApiQueryStashImageInfo:

List of all members.

Public Member Functions
	__construct ($query, $moduleName)
	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.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getParamDescription ()
	Return the API documentation for the parameters.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Private Attributes
	$propertyFilter

---

Detailed Description

A query action to get image information from temporarily stashed files.

Definition at line 28 of file ApiQueryStashImageInfo.php.

---

Constructor & Destructor Documentation

ApiQueryStashImageInfo::__construct	(	$	query,
		$	moduleName
	)

Definition at line 30 of file ApiQueryStashImageInfo.php.

---

Member Function Documentation

ApiQueryStashImageInfo::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 ApiQueryImageInfo.

Definition at line 34 of file ApiQueryStashImageInfo.php.

References $file, $result, ApiBase\dieUsage(), ApiBase\extractRequestParams(), ApiQueryImageInfo\getInfo(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), ApiBase\getResult(), ApiQueryImageInfo\getScale(), ApiQueryImageInfo\mergeThumbParams(), and RepoGroup\singleton().

Here is the call graph for this function:

ApiQueryStashImageInfo::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 ApiQueryImageInfo.

Definition at line 78 of file ApiQueryStashImageInfo.php.

References ApiBase\PARAM_DEPRECATED, ApiBase\PARAM_DFLT, ApiBase\PARAM_ISMULTI, and ApiBase\PARAM_TYPE.

ApiQueryStashImageInfo::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiQueryImageInfo.

Definition at line 126 of file ApiQueryStashImageInfo.php.

ApiQueryStashImageInfo::getExamples

(

)

Returns usage examples for this module.

Return false if no examples are available.

Returns:

false|string|array

Reimplemented from ApiQueryImageInfo.

Definition at line 130 of file ApiQueryStashImageInfo.php.

ApiQueryStashImageInfo::getParamDescription

(

)

Return the API documentation for the parameters.

Returns:

Array parameter documentation.

Reimplemented from ApiQueryImageInfo.

Definition at line 113 of file ApiQueryStashImageInfo.php.

References ApiBase\getModulePrefix().

Here is the call graph for this function:

ApiQueryStashImageInfo::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 ApiQueryImageInfo.

Definition at line 137 of file ApiQueryStashImageInfo.php.

---

Member Data Documentation

ApiQueryStashImageInfo::$propertyFilter [private]

Initial value:

 array(
                'user', 'userid', 'comment', 'parsedcomment',
                'mediatype', 'archivename',
        )

Definition at line 73 of file ApiQueryStashImageInfo.php.

---

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

• includes/api/ApiQueryStashImageInfo.php