Expose image information for a page via a new prop=pageimages API. More...

Inheritance diagram for ApiQueryPageImages:

[legend]

Collaboration diagram for ApiQueryPageImages:

[legend]

Public Member Functions
	__construct (ApiQuery $query, $moduleName)

	execute ()
	Evaluates the parameters, performs the requested retrieval of page images, and sets up the result. More...

	getAllowedParams ()
	Return an array describing all possible parameters to this module. More...

	getCacheMode ( $params)
	Get the cache mode for the data generated by this module. More...

	getHelpUrls ()

Public Member Functions inherited from ApiQueryBase
	__construct (ApiQuery $queryModule, $moduleName, $paramPrefix='')

	requestExtraData ( $pageSet)
	Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName') More...

	showHiddenUsersAddBlockInfo ( $showBlockInfo)
	Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information. More...

	getQuery ()
	Get the main Query module. More...

	getParent ()
	Get the parent of this module. Since 1.25 Returns ApiBase\|null More...

	selectNamedDB ( $name, $db, $groups)
	Selects the query database connection with the given name. More...

	titlePartToKey ( $titlePart, $namespace=NS_MAIN)
	Convert an input title or title prefix into a dbkey. More...

	prefixedTitlePartToKey ( $titlePart, $defaultNamespace=NS_MAIN)
	Convert an input title or title prefix into a namespace constant and dbkey. More...

	validateSha1Hash ( $hash)

	validateSha1Base36Hash ( $hash)

	userCanSeeRevDel ()
	Check whether the current user has permission to view revision-deleted fields. More...

Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')

	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules. More...

	getCustomPrinter ()
	If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...

	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked. More...

	isReadMode ()
	Indicates whether this module requires read rights. More...

	isWriteMode ()
	Indicates whether this module requires write mode. More...

	mustBePosted ()
	Indicates whether this module must be called with a POST request. More...

	isDeprecated ()
	Indicates whether this module is deprecated. More...

	isInternal ()
	Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...

	needsToken ()
	Returns the token type this module requires in order to execute. More...

	getConditionalRequestData ( $condition)
	Returns data for HTTP conditional request mechanisms. More...

	getModuleName ()
	Get the name of the module being executed by this instance. More...

	getModulePrefix ()
	Get parameter prefix (usually two letters or an empty string). More...

	getMain ()
	Get the main module. More...

	isMain ()
	Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...

	lacksSameOriginSecurity ()
	Returns true if the current request breaks the same-origin policy. More...

	getModulePath ()
	Get the path to this module. More...

	getModuleFromPath ( $path)
	Get a module from its module path. More...

	getResult ()
	Get the result object. More...

	getErrorFormatter ()
	Get the error formatter. More...

	getContinuationManager ()
	Get the continuation manager. More...

	setContinuationManager (ApiContinuationManager $manager=null)
	Set the continuation manager. More...

	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More...

	encodeParamName ( $paramName)
	This method mangles parameter name based on the prefix supplied to the constructor. More...

	extractRequestParams ( $options=[])
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More...

	requireOnlyOneParameter ( $params, $required)
	Die if none or more than one of a certain set of parameters is set and not false. More...

	requireMaxOneParameter ( $params, $required)
	Die if more than one of a certain set of parameters is set and not false. More...

	requireAtLeastOneParameter ( $params, $required)
	Die if none of a certain set of parameters is set and not false. More...

	requirePostedParameters ( $params, $prefix='prefix')
	Die if any of the specified parameters were found in the query part of the URL rather than the post body. More...

	getTitleOrPageId ( $params, $load=false)
	Get a WikiPage object from a title or pageid param, if possible. More...

	getTitleFromTitleOrPageId ( $params)
	Get a Title object from a title or pageid param, if possible. More...

	validateToken ( $token, array $params)
	Validate the supplied token. More...

	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist. More...

	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status. More...

	addBlockInfoToStatus (StatusValue $status, User $user=null)
	Add block info to block messages in a Status. More...

	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module. More...

	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module. More...

	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting. More...

	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status. More...

	dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
	Abort execution with an error. More...

	dieWithException ( $exception, array $options=[])
	Abort execution with an error derived from an exception. More...

	dieBlocked (AbstractBlock $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More...

	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object. More...

	dieReadOnly ()
	Helper function for readonly errors. More...

	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors. More...

	checkTitleUserPermissions (LinkTarget $linkTarget, $actions, $options=[])
	Helper function for permission-denied errors. More...

	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...

	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis. More...

	getFinalSummary ()
	Get final module summary. More...

	getFinalDescription ()
	Get final module description, after hooks have had a chance to tweak it as needed. More...

	getFinalParams ( $flags=0)
	Get final list of parameters, after hooks have had a chance to tweak it as needed. More...

	getFinalParamDescription ()
	Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...

	modifyHelp (array &$help, array $options, array &$tocData)
	Called from ApiHelp before the pieces are joined together and returned. More...

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()

	getContext ()
	Get the base IContextSource object. More...

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object. More...

	msg ( $key,... $params)
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)

Public Attributes
const	PARAM_LICENSE_ANY = 'any'
	@const API parameter value for images with any type of license More...

const	PARAM_LICENSE_FREE = 'free'
	@const API parameter value for free images More...

Public Attributes inherited from ApiQueryBase
	$fields

	$join_conds

	$mDb

	$options

	$tables

	$where

Public Attributes inherited from ApiBase
string	$mModulePrefix

const	ALL_DEFAULT_STRING = '*'

const	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...

const	LIMIT_BIG1 = 500
	Fast query, standard limit. More...

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit. More...

const	LIMIT_SML1 = 50
	Slow query, standard limit. More...

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit. More...

const	PARAM_DFLT = 0
	(null\|boolean\|integer\|string) Default value of the parameter. More...

const	PARAM_ISMULTI = 1
	(boolean) Accept multiple pipe-separated values for this parameter (e.g. More...

const	PARAM_TYPE = 2
	(string\|string[]) Either an array of allowed value strings, or a string type as described below. More...

const	PARAM_MAX = 3
	(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...

const	PARAM_MAX2 = 4
	(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. More...

const	PARAM_MIN = 5
	(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...

const	PARAM_ALLOW_DUPLICATES = 6
	(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? More...

const	PARAM_DEPRECATED = 7
	(boolean) Is the parameter deprecated (will show a warning)? More...

const	PARAM_REQUIRED = 8
	(boolean) Is the parameter required? More...

const	PARAM_RANGE_ENFORCE = 9
	(boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? More...

const	PARAM_HELP_MSG = 10
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

const	PARAM_HELP_MSG_APPEND = 11
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More...

const	PARAM_HELP_MSG_INFO = 12
	(array) Specify additional information tags for the parameter. More...

const	PARAM_VALUE_LINKS = 13
	(string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help. More...

const	PARAM_HELP_MSG_PER_VALUE = 14
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More...

const	PARAM_SUBMODULE_MAP = 15
	(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. More...

const	PARAM_SUBMODULE_PARAM_PREFIX = 16
	(string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that). More...

const	PARAM_ALL = 17
	(boolean\|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value. More...

const	PARAM_EXTRA_NAMESPACES = 18
	(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values. More...

const	PARAM_SENSITIVE = 19
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field. More...

const	PARAM_DEPRECATED_VALUES = 20
	(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated. More...

const	PARAM_ISMULTI_LIMIT1 = 21
	(integer) Maximum number of values, for normal users. More...

const	PARAM_ISMULTI_LIMIT2 = 22
	(integer) Maximum number of values, for users with the apihighimits right. More...

const	PARAM_MAX_BYTES = 23
	(integer) Maximum length of a string in bytes (in UTF-8 encoding). More...

const	PARAM_MAX_CHARS = 24
	(integer) Maximum length of a string in characters (unicode codepoints). More...

const	PARAM_TEMPLATE_VARS = 25
	(array) Indicate that this is a templated parameter, and specify replacements. More...

Protected Member Functions
	getExamplesMessages ()
	Returns usage examples for this module.Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.Do not call this base class implementation when overriding this method. Since 1.25 Returns array More...

	getTitles ()
	Gets the set of titles to get page images for. More...

	setResultValues (array $prop, $pageId, $fileName, $size)
	For a given page, set API return values for thumbnail and pageimage as needed. More...

Protected Member Functions inherited from ApiQueryBase
	resetQueryParams ()
	Blank the internal arrays with query parameters. More...

	addTables ( $tables, $alias=null)
	Add a set of tables to the internal array. More...

	addJoinConds ( $join_conds)
	Add a set of JOIN conditions to the internal array. More...

	addFields ( $value)
	Add a set of fields to select to the internal array. More...

	addFieldsIf ( $value, $condition)
	Same as addFields(), but add the fields only if a condition is met. More...

	addWhere ( $value)
	Add a set of WHERE clauses to the internal array. More...

	addWhereIf ( $value, $condition)
	Same as addWhere(), but add the WHERE clauses only if a condition is met. More...

	addWhereFld ( $field, $value)
	Equivalent to addWhere( [ $field => $value ] ) More...

	addWhereIDsFld ( $table, $field, $ids)
	Like addWhereFld for an integer list of IDs. More...

	addWhereRange ( $field, $dir, $start, $end, $sort=true)
	Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction. More...

	addTimestampWhereRange ( $field, $dir, $start, $end, $sort=true)
	Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps. More...

	addOption ( $name, $value=null)
	Add an option such as LIMIT or USE INDEX. More...

	select ( $method, $extraQuery=[], array &$hookData=null)
	Execute a SELECT query based on the values in the internal arrays. More...

	processRow ( $row, array &$data, array &$hookData)
	Call the ApiQueryBaseProcessRow hook. More...

	getDB ()
	Get the Query database connection (read-only) More...

	getPageSet ()
	Get the PageSet object to work on. More...

	addPageSubItems ( $pageId, $data)
	Add a sub-element under the page element with the given page ID. More...

	addPageSubItem ( $pageId, $item, $elemname=null)
	Same as addPageSubItems(), but one element of $data at a time. More...

	setContinueEnumParameter ( $paramName, $paramValue)
	Set a query-continue value. More...

	executeGenderCacheFromResultWrapper (IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
	Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo. More...

Protected Member Functions inherited from ApiBase
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module. More...

	getPermissionManager ()
	Obtain a PermissionManager instance that subclasses may use in their authorization checks. More...

	getParameter ( $paramName, $parseLimit=true)
	Get a value for the given parameter. More...

	getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
	Return true if we're to watch the page, false if not, null if no change. More...

	getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)
	Using the settings determine the value for the given parameter. More...

	handleParamNormalization ( $paramName, $value, $rawValue)
	Handle when a parameter was Unicode-normalized. More...

	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode() More...

	parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null)
	Return an array of values that were given in a 'a\|b\|c' notation, after it optionally validates them against the list allowed values. More...

	validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
	Validate the value against the minimum and user/bot maximum limits. More...

	validateTimestamp ( $value, $encParamName)
	Validate and normalize parameters of type 'timestamp'. More...

	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

	filterIDs ( $fields, array $ids)
	Filter out-of-range values from a list of positive integer IDs. More...

	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error. More...

	getSummaryMessage ()
	Return the summary message. More...

	getExtendedDescription ()
	Return the extended help text message. More...

	getHelpFlags ()
	Generates the list of flags for the help screen and for action=paraminfo. More...

	getModuleSourceInfo ()
	Returns information about the source of this module, if known. More...

Static Protected Member Functions
static	getPropNames ( $license)
	Get property names used in page_props table. More...

Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method. More...

Additional Inherited Members
Static Public Member Functions inherited from ApiQueryBase
static	addTitleInfo (&$arr, $title, $prefix='')
	Add information (title and namespace) about a Title object to a result array. More...

Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array. More...

Detailed Description

Expose image information for a page via a new prop=pageimages API.

See also: https://www.mediawiki.org/wiki/Extension:PageImages#API

Note: WTFPL

Author: Max Semenik; Ryan Kaldari; Yuvi Panda; Sam Smith

Definition at line 14 of file ApiQueryPageImages.php.

Constructor & Destructor Documentation

◆ __construct()

ApiQueryPageImages::__construct	(	ApiQuery	$query,
			$moduleName
	)

Parameters

ApiQuery	$query	API query module
string	$moduleName	Name of this query module

Definition at line 30 of file ApiQueryPageImages.php.

Member Function Documentation

◆ execute()

ApiQueryPageImages::execute ( )

Evaluates the parameters, performs the requested retrieval of page images, and sets up the result.

Returns: null

Reimplemented from ApiBase.

Definition at line 76 of file ApiQueryPageImages.php.

References $res, $title, ApiQueryBase\addFields(), ApiQueryBase\addTables(), ApiQueryBase\addWhere(), ApiBase\dieContinueUsageIf(), ApiBase\dieWithError(), ApiBase\encodeParamName(), ApiBase\extractRequestParams(), PageImages\getPropName(), getTitles(), NS_FILE, ApiQueryBase\select(), ApiQueryBase\setContinueEnumParameter(), and setResultValues().

◆ getAllowedParams()

ApiQueryPageImages::getAllowedParams ( )

Return an array describing all possible parameters to this module.

Returns: array

Reimplemented from ApiBase.

Definition at line 234 of file ApiQueryPageImages.php.

References ContextSource\getConfig(), ApiBase\PARAM_DFLT, ApiBase\PARAM_HELP_MSG, ApiBase\PARAM_ISMULTI, PARAM_LICENSE_ANY, PARAM_LICENSE_FREE, ApiBase\PARAM_MAX, ApiBase\PARAM_MAX2, ApiBase\PARAM_MIN, and ApiBase\PARAM_TYPE.

◆ getCacheMode()

ApiQueryPageImages::getCacheMode ( $params )

Get the cache mode for the data generated by this module.

Parameters

array $params Ignored parameters

Returns: string Always returns "public"

Reimplemented from ApiQueryBase.

Definition at line 179 of file ApiQueryPageImages.php.

◆ getExamplesMessages()

ApiQueryPageImages::getExamplesMessages ( )

protected

Returns usage examples for this module.Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.Do not call this base class implementation when overriding this method.

Since: 1.25

Returns: array

Reimplemented from ApiBase.

Definition at line 267 of file ApiQueryPageImages.php.

◆ getHelpUrls()

ApiQueryPageImages::getHelpUrls ( )

See also: ApiBase::getHelpUrls()

Returns: string

Reimplemented from ApiBase.

Definition at line 278 of file ApiQueryPageImages.php.

◆ getPropNames()

static ApiQueryPageImages::getPropNames ( $license )

staticprotected

Get property names used in page_props table.

If the license is free, then only the free property name will be returned, otherwise both free and non-free property names will be returned. That's because we save the image name only once if it's free and the best image.

Parameters

string $license either PARAM_LICENSE_FREE or PARAM_LICENSE_ANY, specifying whether to return the non-free property name or not

Returns: string|array

Reimplemented in PageImages\Tests\ApiQueryPageImagesProxyMock.

Definition at line 166 of file ApiQueryPageImages.php.

References PageImages\getPropName().

◆ getTitles()

ApiQueryPageImages::getTitles ( )

protected

Gets the set of titles to get page images for.

Note well that the set of titles comprises the set of "good" titles (see {

See also: ApiPageSet::getGoodTitles}) union the set of "missing" titles in the File namespace that might correspond to foreign files. The latter are included because titles in the File namespace are expected to be found with {; wfFindFile}.

Returns: Title[] A map of page ID, which will be negative in the case of missing titles in the File namespace, to Title object

Reimplemented in PageImages\Tests\ApiQueryPageImagesProxyMock.

Definition at line 46 of file ApiQueryPageImages.php.

References $title, ApiQueryBase\getPageSet(), Title\newFromText(), and NS_FILE.

Referenced by execute().

◆ setResultValues()

ApiQueryPageImages::setResultValues	(	array	$prop,
			$pageId,
			$fileName,
			$size
	)

protected

For a given page, set API return values for thumbnail and pageimage as needed.

Parameters

array	$prop	The prop values from the API request
int	$pageId	The ID of the page
string	$fileName	The name of the file to transform
int	$size	The thumbsize value from the API request

Definition at line 191 of file ApiQueryPageImages.php.

References $file, ApiBase\getResult(), PROTO_CURRENT, wfExpandUrl(), and wfFindFile().

Referenced by execute().

Member Data Documentation

◆ PARAM_LICENSE_ANY

const ApiQueryPageImages::PARAM_LICENSE_ANY = 'any'

@const API parameter value for images with any type of license

Definition at line 24 of file ApiQueryPageImages.php.

Referenced by getAllowedParams(), and PageImages\Tests\ApiQueryPageImagesTest\testExecute().

◆ PARAM_LICENSE_FREE

const ApiQueryPageImages::PARAM_LICENSE_FREE = 'free'

@const API parameter value for free images

Definition at line 19 of file ApiQueryPageImages.php.

Referenced by getAllowedParams().

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

extensions/PageImages/includes/ApiQueryPageImages.php

Public Member Functions

Public Attributes

Protected Member Functions

Static Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ execute()

◆ getAllowedParams()

◆ getCacheMode()

◆ getExamplesMessages()

◆ getHelpUrls()

◆ getPropNames()

◆ getTitles()

◆ setResultValues()

Member Data Documentation

◆ PARAM_LICENSE_ANY

◆ PARAM_LICENSE_FREE