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 ()
	getResultProperties ()
	Returns possible properties in the result, grouped by the value of the prop parameter that shows them.
	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(), $modulePrefix= '')
	Returns the descriptions for the properties provided by getPropertyNames()
static	getPropertyNames ($filter=array())
	Returns all possible parameters to iiprop.
static	getResultPropertiesFiltered ($filter=array())
static	processMetaData ($metadata, $result)
Protected Member Functions
	getContinueStr ($img)
	mergeThumbParams ($image, $thumbParams, $otherParams)
	Validate and merge scale parameters with handler thumb parameters, give error if invalid.
Static Private Member Functions
static	getProperties ($modulePrefix= '')
	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, $params, $result, $title, ApiQueryBase\addPageSubItem(), ApiBase\dieUsage(), ApiBase\extractRequestParams(), getContinueStr(), ApiQueryBase\getPageSet(), ApiBase\getResult(), ApiBase\getResultData(), getScale(), mergeThumbParams(), 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|bool

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 442 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 429 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::getContinueStr ( $ img ) [protected]

Parameters:

$img File

Returns:: string

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

Reimplemented in ApiQueryStashImageInfo.

Definition at line 665 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::getExamples ( )

Returns usage examples for this module.

Return false if no examples are available.

Returns:: bool|string|array

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 680 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::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 687 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).

Returns:: Array: result array

Definition at line 273 of file ApiQueryImageInfo.php.

References $comment, $ext, $file, $mime, $result, $url, $user, File\DELETED_COMMENT, File\DELETED_FILE, File\DELETED_USER, Linker\formatComment(), processMetaData(), wfBaseConvert(), wfExpandUrl(), and wfTimestamp().

Referenced by ApiQueryStashImageInfo\execute(), UploadBase\getImageInfo(), and ApiQueryAllImages\run().

ApiQueryImageInfo::getParamDescription ( )

Return the API documentation for the parameters.

Returns:: Array parameter documentation.

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 538 of file ApiQueryImageInfo.php.

References ApiBase\getModulePrefix().

ApiQueryImageInfo::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiQueryBase.

Definition at line 669 of file ApiQueryImageInfo.php.

References ApiBase\getModulePrefix().

static ApiQueryImageInfo::getProperties ( $ modulePrefix = '' ) [static, private]

Returns array key value pairs of properties and their descriptions.

Returns:: array

Definition at line 499 of file ApiQueryImageInfo.php.

static ApiQueryImageInfo::getPropertyDescriptions	(	$	filter = `array()`,
		$	modulePrefix = `''`
	)		`[static]`

Returns the descriptions for the properties provided by getPropertyNames()

Parameters:

array $filter List of properties to filter out

Returns:: array

Definition at line 527 of file ApiQueryImageInfo.php.

Referenced by ApiQueryAllImages\getParamDescription().

static ApiQueryImageInfo::getPropertyNames ( $ filter = array() ) [static]

Returns all possible parameters to iiprop.

Parameters:

array $filter List of properties to filter out

Returns:: Array

Definition at line 490 of file ApiQueryImageInfo.php.

Referenced by ApiQueryAllImages\getAllowedParams(), and UploadBase\getImageInfo().

ApiQueryImageInfo::getResultProperties ( )

Returns possible properties in the result, grouped by the value of the prop parameter that shows them.

Properties that are shown always are in a group with empty string as a key. Properties that can be shown by several values of prop are included multiple times. If some properties are part of a list and some are on the root object (see ApiQueryQueryPage), those on the root object are under the key PROP_ROOT. The array can also contain a boolean under the key PROP_LIST, indicating whether the result is a list.

Don't call this functon directly: use getFinalResultProperties() to allow hooks to modify descriptions as needed.

Returns:: array|bool False on no properties

Reimplemented from ApiBase.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 661 of file ApiQueryImageInfo.php.

References getResultPropertiesFiltered().

static ApiQueryImageInfo::getResultPropertiesFiltered ( $ filter = array() ) [static]

Definition at line 557 of file ApiQueryImageInfo.php.

References ApiBase\PROP_NULLABLE, and ApiBase\PROP_TYPE.

Referenced by ApiQueryStashImageInfo\getResultProperties(), ApiQueryAllImages\getResultProperties(), and getResultProperties().

ApiQueryImageInfo::getScale ( $ params )

From parameters, construct a 'scale' array.

Parameters:

$params Array: Parameters passed to api.

Returns:: Array or Null: key-val array of 'width' and 'height', or null

Definition at line 191 of file ApiQueryImageInfo.php.

References $params, ApiBase\dieUsage(), and ApiBase\getModulePrefix().

Referenced by ApiQueryStashImageInfo\execute(), and execute().

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.

Reimplemented in ApiQueryStashImageInfo.

Definition at line 691 of file ApiQueryImageInfo.php.

ApiQueryImageInfo::mergeThumbParams	(	$	image,
		$	thumbParams,
		$	otherParams
	)		`[protected]`

Validate and merge scale parameters with handler thumb parameters, give error if invalid.

We do this later than getScale, since we need the image to know which handler, since handlers can make their own parameters.

Parameters:

File	$image	Image that params are for.
Array	$thumbParams	thumbnail parameters from getScale
String	$otherParams	of otherParams (iiurlparam).

Returns:: Array of parameters for transform.

Definition at line 223 of file ApiQueryImageInfo.php.

References $value, ApiBase\dieUsage(), ApiBase\getModulePrefix(), and ApiBase\setWarning().

Referenced by ApiQueryStashImageInfo\execute(), and execute().

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

Parameters:

$metadata	Array
$result	ApiResult

Returns:: Array

Definition at line 412 of file ApiQueryImageInfo.php.

References $result, and $value.

Referenced by ApiQueryFilearchive\execute(), and getInfo().

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

includes/api/ApiQueryImageInfo.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation