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

Inheritance diagram for ApiQueryImageInfo:

Collaboration diagram for ApiQueryImageInfo:

Public Member Functions
	__construct ($query, $moduleName, $prefix= 'ii')
	Constructor.
	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.
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDescription ()
	Returns the description string for this module.
	getExamples ()
	Returns usage examples for this module.
	getHelpUrls ()
	getParamDescription ()
	Return the API documentation for the parameters.
	getPossibleErrors ()
	getScale ($params)
	From parameters, construct a 'scale' array.
	getVersion ()
	Returns a string that identifies the version of the extending class.
Static Public Member Functions
static	getInfo ($file, $prop, $result, $thumbParams=null, $version= 'latest')
	Get result information for an image revision.
static	getPropertyDescriptions ($filter=array())
	Returns the descriptions for the properties provided by getPropertyNames()
static	getPropertyNames ($filter=array())
	Returns all possible parameters to iiprop.
static	processMetaData ($metadata, $result)
Protected Member Functions
	mergeThumbParams ($image, $thumbParams, $otherParams)
	Validate and merge scale parameters with handler thumb parameters, give error if invalid.
Private Member Functions
	getContinueStr ($img)
Static Private Member Functions
static	getProperties ()
	Returns array key value pairs of properties and their descriptions.

Detailed Description

A query action to get image information and upload history.

Definition at line 32 of file ApiQueryImageInfo.php.

Constructor & Destructor Documentation

ApiQueryImageInfo::__construct	(	$	mainModule,
		$	moduleName,
		$	modulePrefix = `'ii'`
	)

Constructor.

Parameters:

$mainModule	ApiMain object
$moduleName	string Name of this module
$modulePrefix	string Prefix to use for parameter names

Reimplemented from ApiBase.

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

Reimplemented in ApiQueryStashImageInfo.

Definition at line 43 of file ApiQueryImageInfo.php.

References $count, $result, $title, ApiQueryBase\addPageSubItem(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), getContinueStr(), ApiQueryBase\getPageSet(), ApiBase\getResult(), ApiBase\getResultData(), getScale(), mergeThumbParams(), ApiQueryBase\setContinueEnumParameter(), RepoGroup\singleton(), and wfTimestamp().

Here is the call graph for this function:

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 or false

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 438 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. For possible return values and other details about cache modes, see ApiMain::setCacheMode()

Public caching will only be allowed if *all* the modules that supply data for a given request return a cache mode of public.

Parameters:

$params

Returns:: string

Reimplemented from ApiQueryBase.

Definition at line 425 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::getContinueStr ( $ img ) [private]

Parameters:

$img File

Returns:: string

Definition at line 433 of file ApiQueryImageInfo.php.

Referenced by execute().

Here is the caller graph for this function:

ApiQueryImageInfo::getDescription ( )

Returns the description string for this module.

Returns:: mixed string or array of strings

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 550 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: false|string|array

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 565 of file ApiQueryImageInfo.php.

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

static ApiQueryImageInfo::getInfo	(	$	file,
		$	prop,
		$	result,
		$	thumbParams = `null`,
		$	version = `'latest'`
	)		`[static]`

Get result information for an image revision.

Parameters:

$file	File object
$prop	Array of properties to get (in the keys)
$result	ApiResult object
$thumbParams	Array containing 'width' and 'height' items, or null
$version	string Version of image metadata (for things like jpeg which have different versions).