ApiQueryImageInfo Class Reference
[API]

A query action to get image information and upload history. More...

Inherits ApiQueryBase.

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.
 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.

Static Public Member Functions

static getInfo ($file, $prop, $result, $scale=null)
 Get result information for an image revision.
static processMetaData ($metadata, $result)

Protected Member Functions

 getExamples ()
 Returns usage examples for this module.

Private Member Functions

 getContinueStr ($img)


Detailed Description

A query action to get image information and upload history.

Definition at line 36 of file ApiQueryImageInfo.php.


Constructor & Destructor Documentation

ApiQueryImageInfo::__construct ( query,
moduleName 
)

Definition at line 38 of file ApiQueryImageInfo.php.


Member Function Documentation

ApiQueryImageInfo::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 42 of file ApiQueryImageInfo.php.

References $key, $result, $start, $title, ApiQueryBase::addPageSubItem(), ApiBase::dieUsage(), ApiBase::extractRequestParams(), getContinueStr(), ApiQueryBase::getPageSet(), ApiBase::getResult(), is(), ApiQueryBase::setContinueEnumParameter(), RepoGroup::singleton(), and wfTimestamp().

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

Reimplemented from ApiBase.

Definition at line 248 of file ApiQueryImageInfo.php.

References ApiBase::LIMIT_BIG1, ApiBase::LIMIT_BIG2, ApiBase::PARAM_DFLT, ApiBase::PARAM_ISMULTI, ApiBase::PARAM_MAX, ApiBase::PARAM_MAX2, ApiBase::PARAM_MIN, and ApiBase::PARAM_TYPE.

ApiQueryImageInfo::getContinueStr ( img  )  [private]

Definition at line 242 of file ApiQueryImageInfo.php.

Referenced by execute().

ApiQueryImageInfo::getDescription (  ) 

Returns the description string for this module.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 304 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::getExamples (  )  [protected]

Returns usage examples for this module.

Return null if no examples are available.

Returns:
mixed string or array of strings

Reimplemented from ApiBase.

Definition at line 310 of file ApiQueryImageInfo.php.

static ApiQueryImageInfo::getInfo ( file,
prop,
result,
scale = null 
) [static]

Get result information for an image revision.

Parameters:
File f The image
Returns:
array Result array

Definition at line 177 of file ApiQueryImageInfo.php.

References $file, $result, wfBaseConvert(), wfExpandUrl(), and wfTimestamp().

Referenced by ApiQueryAllimages::run().

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

Reimplemented from ApiBase.

Definition at line 291 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::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 317 of file ApiQueryImageInfo.php.

static ApiQueryImageInfo::processMetaData ( metadata,
result 
) [static]

Definition at line 224 of file ApiQueryImageInfo.php.

References $key, and $result.


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

Generated on Sat Sep 5 02:08:32 2009 for MediaWiki by  doxygen 1.5.9