Inherits ApiQueryBase.
Public Member Functions | |
__construct ($query, $moduleName) | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getCacheMode ($params) | |
Get the cache mode for the data generated by this module. | |
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. | |
getPossibleErrors () | |
Returns a list of all possible errors returned by the 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) |
static | getPropertyNames () |
Returns all possible parameters to iiprop. | |
Protected Member Functions | |
getExamples () | |
Returns usage examples for this module. | |
Private Member Functions | |
getContinueStr ($img) |
Definition at line 36 of file ApiQueryImageInfo.php.
ApiQueryImageInfo::__construct | ( | $ | query, | |
$ | moduleName | |||
) |
Definition at line 38 of file ApiQueryImageInfo.php.
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 $result, $title, ApiQueryBase::addPageSubItem(), ApiBase::dieUsage(), ApiBase::extractRequestParams(), getContinueStr(), ApiQueryBase::getPageSet(), ApiBase::getResult(), ApiBase::getResultData(), 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.
Reimplemented from ApiBase.
Definition at line 257 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::getCacheMode | ( | $ | params | ) |
Get the cache mode for the data generated by this module.
Override this in the module subclass.
Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.
Reimplemented from ApiQueryBase.
Definition at line 247 of file ApiQueryImageInfo.php.
ApiQueryImageInfo::getContinueStr | ( | $ | img | ) | [private] |
ApiQueryImageInfo::getDescription | ( | ) |
Returns the description string for this module.
Reimplemented from ApiBase.
Definition at line 321 of file ApiQueryImageInfo.php.
ApiQueryImageInfo::getExamples | ( | ) | [protected] |
Returns usage examples for this module.
Return null if no examples are available.
Reimplemented from ApiBase.
Definition at line 333 of file ApiQueryImageInfo.php.
static ApiQueryImageInfo::getInfo | ( | $ | file, | |
$ | prop, | |||
$ | result, | |||
$ | scale = null | |||
) | [static] |
Get result information for an image revision.
File | f The image |
Definition at line 182 of file ApiQueryImageInfo.php.
References $result, processMetaData(), wfBaseConvert(), wfExpandUrl(), and wfTimestamp().
Referenced by UploadBase::getImageInfo(), and 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.
Reimplemented from ApiBase.
Definition at line 308 of file ApiQueryImageInfo.php.
ApiQueryImageInfo::getPossibleErrors | ( | ) |
Returns a list of all possible errors returned by the module.
Reimplemented from ApiQueryBase.
Definition at line 327 of file ApiQueryImageInfo.php.
static ApiQueryImageInfo::getPropertyNames | ( | ) | [static] |
Returns all possible parameters to iiprop.
Definition at line 292 of file ApiQueryImageInfo.php.
Referenced by ApiQueryAllimages::getAllowedParams(), and UploadBase::getImageInfo().
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
Reimplemented from ApiBase.
Definition at line 340 of file ApiQueryImageInfo.php.
static ApiQueryImageInfo::processMetaData | ( | $ | metadata, | |
$ | result | |||
) | [static] |