This is a base class for all Query modules. More...

Inheritance diagram for ApiQueryBase:

[legend]

Collaboration diagram for ApiQueryBase:

[legend]

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

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

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

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

	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.

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

	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.

	getHelpUrls ()
	Return links to more detailed help pages about the module.

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

	isReadMode ()
	Indicates whether this module requires read rights.

	isWriteMode ()
	Indicates whether this module requires write mode.

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

	isDeprecated ()
	Indicates whether this module is deprecated.

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

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

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

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

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

	getMain ()
	Get the main module.

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

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

	getModulePath ()
	Get the path to this module.

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

	getResult ()
	Get the result object.

	getErrorFormatter ()
	Get the error formatter.

	getContinuationManager ()
	Get the continuation manager.

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

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

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

	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.

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

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

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

	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.

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

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

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

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

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

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

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

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

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

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

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

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

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

	dieReadOnly ()
	Helper function for readonly errors.

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

	checkTitleUserPermissions (Title $title, $actions, $user=null)
	Helper function for permission-denied errors.

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

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

	getFinalSummary ()
	Get final module summary.

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

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

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

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

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

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

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

Private Attributes
	$fields

	$join_conds

	$mDb

	$mQueryModule

	$options

	$tables

	$where

Data access
	getQuery ()
	Get the main Query module.

	getParent ()
	@inheritDoc

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

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

	getPageSet ()
	Get the PageSet object to work on.

Querying
	prepareUrlQuerySearchString ( $query=null, $protocol=null)

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

	resetQueryParams ()
	Blank the internal arrays with query parameters.

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

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

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

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

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

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

	addWhereFld ( $field, $value)
	Equivalent to addWhere(array($field => $value))

	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.

	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.

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

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

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

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

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

	validateSha1Hash ( $hash)

	validateSha1Base36Hash ( $hash)

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

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

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

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

static	addTitleInfo (&$arr, $title, $prefix='')
	Add information (title and namespace) about a Title object to a result array.

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

static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length.

Public Attributes inherited from ApiBase
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.

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

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

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

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

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

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

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

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

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

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

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

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

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

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

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.

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

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

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

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.

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

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

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

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

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

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

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

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

Protected Member Functions inherited from ApiBase
	getExamplesMessages ()
	Returns usage examples for 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.

	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.

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

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

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

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

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

	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.

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

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

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

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

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

	getSummaryMessage ()
	Return the summary message.

	getExtendedDescription ()
	Return the extended help text message.

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

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

	getDescription ()
	Returns the description string for this module.

	getParamDescription ()
	Returns an array of parameter descriptions.

	getExamples ()
	Returns usage examples for this module.

	getDescriptionMessage ()
	Return the description message.

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

Detailed Description

This is a base class for all Query modules.

It provides some common functionality such as constructing various SQL queries.

Definition at line 33 of file ApiQueryBase.php.

Constructor & Destructor Documentation

◆ __construct()

ApiQueryBase::__construct	(	ApiQuery	$queryModule,
			$moduleName,
			$paramPrefix = '' )

Parameters

ApiQuery	$queryModule
string	$moduleName
string	$paramPrefix

Reimplemented in ApiQueryImageInfo.

Definition at line 42 of file ApiQueryBase.php.

References resetQueryParams().

Member Function Documentation

◆ addFields()

ApiQueryBase::addFields ( $value )

protected

Add a set of fields to select to the internal array.

Parameters

array | string $value Field name or array of field names

Definition at line 192 of file ApiQueryBase.php.

References $value.

◆ addFieldsIf()

ApiQueryBase::addFieldsIf	(		$value,
			$condition )

protected

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

Parameters

array \| string	$value	See addFields()
bool	$condition	If false, do nothing

Returns: bool $condition

Definition at line 206 of file ApiQueryBase.php.

References $value, and addFields().

Referenced by ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllCategories\run(), ApiQueryAllLinks\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), ApiQueryRecentChanges\run(), ApiQueryAllRevisions\run(), and ApiQueryBacklinksprop\run().

◆ addJoinConds()

ApiQueryBase::addJoinConds ( $join_conds )

protected

Add a set of JOIN conditions to the internal array.

JOIN conditions are formatted as [ tablename => [ jointype, conditions ] ] e.g. [ 'page' => [ 'LEFT JOIN', 'page_id=rev_page' ] ]. Conditions may be a string or an addWhere()-style array.

Parameters

array $join_conds JOIN conditions

Definition at line 181 of file ApiQueryBase.php.

References $join_conds, and ApiBase\dieDebug().

Referenced by ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryProtectedTitles\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), and showHiddenUsersAddBlockInfo().

◆ addOption()

ApiQueryBase::addOption	(		$name,
			$value = null )

protected

Add an option such as LIMIT or USE INDEX.

If an option was set before, the old value will be overwritten

Parameters

string	$name	Option name
string \| string[] \| null	$value	Option value

Definition at line 325 of file ApiQueryBase.php.

References $name, $value, and options().

Referenced by addWhereRange(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiQueryBacklinks\runSecondQuery().

◆ addPageSubItem()

ApiQueryBase::addPageSubItem	(	$pageId,
		$item,
		$elemname = null )

protected

Same as addPageSubItems(), but one element of $data at a time.

Parameters

int	$pageId	Page ID
array	$item	Data array à la ApiResult
string \| null	$elemname	XML element name. If null, getModuleName() is used

Returns: bool Whether the element fit in the result

Definition at line 514 of file ApiQueryBase.php.

References ApiBase\getModuleName(), ApiBase\getModulePrefix(), and ApiBase\getResult().

Referenced by ApiQueryContributors\execute(), ApiQueryExternalLinks\execute(), ApiQueryImageInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryImages\run(), ApiQueryLinks\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ addPageSubItems()

ApiQueryBase::addPageSubItems	(		$pageId,
			$data )

protected

Add a sub-element under the page element with the given page ID.

Parameters

int	$pageId	Page ID
array	$data	Data array à la ApiResult

Returns: bool Whether the element fit in the result

Definition at line 497 of file ApiQueryBase.php.

References ApiBase\getModuleName(), ApiBase\getModulePrefix(), ApiBase\getResult(), and ApiResult\setIndexedTagName().

Referenced by ApiQueryReferences\execute(), and ApiQueryCategoryInfo\execute().

◆ addTables()

ApiQueryBase::addTables	(		$tables,
			$alias = null )

protected

Add a set of tables to the internal array.

Parameters

string \| string[]	$tables	Table name or array of table names
string \| null	$alias	Table alias, or null for no alias. Cannot be used with multiple tables

Definition at line 158 of file ApiQueryBase.php.

References $tables, ApiBase\dieDebug(), and tables.

◆ addTimestampWhereRange()

ApiQueryBase::addTimestampWhereRange	(	$field,
		$dir,
		$start,
		$end,
		$sort = true )

protected

Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps.

See also: addWhereRange

Parameters

string	$field
string	$dir
string	$start
string	$end
bool	$sort

Definition at line 313 of file ApiQueryBase.php.

References $sort, addWhereRange(), and getDB().

Referenced by ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllImages\run(), ApiQueryCategoryMembers\run(), ApiQueryProtectedTitles\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ addTitleInfo()

static ApiQueryBase::addTitleInfo	(	&	$arr,
			$title,
			$prefix = '' )

static

Add information (title and namespace) about a Title object to a result array.

Parameters

array	&$arr	Result array à la ApiResult
Title	$title
string	$prefix	Module prefix

Definition at line 486 of file ApiQueryBase.php.

Referenced by ApiPageSet\addValues(), ApiImageRotate\execute(), ApiPatrol\execute(), ApiPurge\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryWatchlist\extractOutputData(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserContribs\extractRowInfo(), LogFormatter\formatParameterValueForApi(), ApiQuerySearch\getSearchResultData(), ApiQuery\outputGeneralPageInfo(), ApiImportReporter\reportPage(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiComparePages\setVals().

◆ addWhere()

ApiQueryBase::addWhere ( $value )

protected

Add a set of WHERE clauses to the internal array.

Clauses can be formatted as 'foo=bar' or [ 'foo' => 'bar' ], the latter only works if the value is a constant (i.e. not another field)

If $value is an empty array, this function does nothing.

For example, [ 'foo=bar', 'baz' => 3, 'bla' => 'foo' ] translates to "foo=bar AND baz='3' AND bla='foo'"

Parameters

string | array $value

Definition at line 227 of file ApiQueryBase.php.

References $value.

◆ addWhereFld()

ApiQueryBase::addWhereFld	(		$field,
			$value )

protected

Equivalent to addWhere(array($field => $value))

Parameters

string	$field	Field name
string \| string[]	$value	Value; ignored if null or empty array

Definition at line 260 of file ApiQueryBase.php.

References $value.

◆ addWhereIf()

ApiQueryBase::addWhereIf	(		$value,
			$condition )

protected

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

Parameters

string \| array	$value
bool	$condition	If false, do nothing

Returns: bool $condition

Definition at line 245 of file ApiQueryBase.php.

References $value, and addWhere().

Referenced by ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryRecentChanges\run(), and ApiQueryBacklinksprop\run().

◆ addWhereRange()

ApiQueryBase::addWhereRange	(	$field,
		$dir,
		$start,
		$end,
		$sort = true )

protected

Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.

Parameters

string	$field	Field name
string	$dir	If 'newer', sort in ascending order, otherwise sort in descending order
string	$start	Value to start the list at. If $dir == 'newer' this is the lower boundary, otherwise it's the upper boundary
string	$end	Value to end the list at. If $dir == 'newer' this is the upper boundary, otherwise it's the lower boundary
bool	$sort	If false, don't add an ORDER BY clause

Definition at line 278 of file ApiQueryBase.php.

References $sort, addOption(), addWhere(), array(), getDB(), and options().

Referenced by addTimestampWhereRange(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiQueryPagePropNames\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), and ApiQueryDeletedRevisions\run().

◆ getCacheMode()

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

array $params

Returns: string

Reimplemented in ApiQueryReferences, ApiQueryOATH, ApiQueryAllCategories, ApiQueryAllImages, ApiQueryAllLinks, ApiQueryAllMessages, ApiQueryAllPages, ApiQueryAllUsers, ApiQueryBacklinks, ApiQueryBacklinksprop, ApiQueryCategories, ApiQueryCategoryInfo, ApiQueryCategoryMembers, ApiQueryContributors, ApiQueryDuplicateFiles, ApiQueryExternalLinks, ApiQueryExtLinksUsage, ApiQueryFileRepoInfo, ApiQueryImageInfo, ApiQueryImages, ApiQueryInfo, ApiQueryIWBacklinks, ApiQueryIWLinks, ApiQueryLangBacklinks, ApiQueryLangLinks, ApiQueryLinks, ApiQueryLogEvents, ApiQueryPagePropNames, ApiQueryPageProps, ApiQueryPagesWithProp, ApiQueryPrefixSearch, ApiQueryProtectedTitles, ApiQueryQueryPage, ApiQueryRandom, ApiQueryRecentChanges, ApiQueryRevisions, ApiQueryRevisionsBase, ApiQuerySearch, ApiQuerySiteinfo, ApiQueryTags, ApiQueryTokens, ApiQueryUserContribs, and ApiQueryUsers.

Definition at line 65 of file ApiQueryBase.php.

◆ getDB()

ApiQueryBase::getDB ( )

protected

Get the Query database connection (read-only)

Returns: IDatabase

Reimplemented from ApiBase.

Reimplemented in ApiQueryAllImages.

Definition at line 105 of file ApiQueryBase.php.

References $mDb, and getQuery().

◆ getPageSet()

ApiQueryBase::getPageSet ( )

protected

Get the PageSet object to work on.

Returns: ApiPageSet

Reimplemented in ApiQueryGeneratorBase.

Definition at line 130 of file ApiQueryBase.php.

References getQuery().

Referenced by ApiQueryReferences\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryImageInfo\execute(), ApiQueryInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), and ApiQueryPageProps\execute().

◆ getParent()

ApiQueryBase::getParent ( )

@inheritDoc

Reimplemented from ApiBase.

Definition at line 97 of file ApiQueryBase.php.

References getQuery().

Referenced by ApiQueryRevisionsBase\parseParameters().

◆ getQuery()

ApiQueryBase::getQuery ( )

Get the main Query module.

Returns: ApiQuery

Definition at line 92 of file ApiQueryBase.php.

References $mQueryModule.

Referenced by getDB(), getPageSet(), getParent(), and selectNamedDB().

◆ prefixedTitlePartToKey()

ApiQueryBase::prefixedTitlePartToKey	(		$titlePart,
			$defaultNamespace = NS_MAIN )

Convert an input title or title prefix into a namespace constant and dbkey.

Since: 1.26

Parameters

string	$titlePart	Title part
int	$defaultNamespace	Default namespace if none is given

Returns: array (int, string) Namespace number and DBkey

Definition at line 575 of file ApiQueryBase.php.

References $t, ApiBase\dieWithError(), and wfEscapeWikiText().

Referenced by ApiQueryWatchlistRaw\run().

◆ prepareUrlQuerySearchString()

ApiQueryBase::prepareUrlQuerySearchString	(		$query = null,
			$protocol = null )

Parameters

string \| null	$query
string \| null	$protocol

Returns: null|string

Definition at line 409 of file ApiQueryBase.php.

References $query, ApiBase\dieWithError(), getDB(), LinkFilter\keepOneWildcard(), and LinkFilter\makeLikeArray().

Referenced by ApiQueryExternalLinks\execute(), and ApiQueryExtLinksUsage\run().

◆ processRow()

ApiQueryBase::processRow	(		$row,
		array &	$data,
		array &	$hookData )

protected

Call the ApiQueryBaseProcessRow hook.

Generally, a module that passed $hookData to self::select() will call this just before calling ApiResult::addValue(), and treat a false return here in the same way it treats a false return from addValue().

Since: 1.28

Parameters

object	$row	Database row
array	&$data	Data to be added to the result
array	&$hookData	Hook data from ApiQueryBase::select()

Returns: bool Return false if row processing should end with continuation

Definition at line 400 of file ApiQueryBase.php.

Referenced by ApiQueryUserContribs\execute(), ApiQueryRecentChanges\run(), ApiQueryAllRevisions\run(), and ApiQueryRevisions\run().

◆ requestExtraData()

ApiQueryBase::requestExtraData ( $pageSet )

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

Note this only makes sense for 'prop' modules, as 'list' and 'meta' modules should not be using the pageset.

Parameters

ApiPageSet $pageSet

Reimplemented in ApiQueryInfo.

Definition at line 78 of file ApiQueryBase.php.

◆ resetQueryParams()

ApiQueryBase::resetQueryParams ( )

protected

Blank the internal arrays with query parameters.

Definition at line 144 of file ApiQueryBase.php.

References options(), and tables.

Referenced by __construct(), ApiQueryContributors\execute(), ApiQueryUsers\execute(), ApiQueryInfo\getDisplayTitle(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryUserContribs\prepareQuery(), and ApiQueryRandom\runQuery().

◆ select()

ApiQueryBase::select	(		$method,
			$extraQuery = [],
		array &	$hookData = null )

protected

Execute a SELECT query based on the values in the internal arrays.

Parameters

string	$method	Function the query should be attributed to. You should usually use METHOD here
array	$extraQuery	Query data to add but not store in the object Format is [ 'tables' => ..., 'fields' => ..., 'where' => ..., 'options' => ..., 'join_conds' => ... ]
array \| null	&$hookData	If set, the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks will be called, and the ApiQueryBaseProcessRow hook will be expected.

Returns: ResultWrapper

Definition at line 350 of file ApiQueryBase.php.

References $fields, $join_conds, $options, $res, $tables, $where, array(), getDB(), options(), and tables.

◆ selectNamedDB()

ApiQueryBase::selectNamedDB	(	$name,
		$db,
		$groups )

Selects the query database connection with the given name.

See ApiQuery::getNamedDB() for more information

Parameters

string	$name	Name to assign to the database connection
int	$db	One of the DB_* constants
string \| string[]	$groups	Query groups

Returns: IDatabase

Definition at line 121 of file ApiQueryBase.php.

References $mDb, and getQuery().

Referenced by ApiQueryUserContribs\execute(), and ApiQueryWatchlist\run().

◆ setContinueEnumParameter()

ApiQueryBase::setContinueEnumParameter	(		$paramName,
			$paramValue )

protected

Set a query-continue value.

Parameters

string	$paramName	Parameter name
string \| array	$paramValue	Parameter value

Reimplemented in ApiQueryGeneratorBase.

Definition at line 535 of file ApiQueryBase.php.

References ApiBase\getContinuationManager().

◆ showHiddenUsersAddBlockInfo()

ApiQueryBase::showHiddenUsersAddBlockInfo ( $showBlockInfo )

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

Parameters

bool $showBlockInfo

Returns: void

Definition at line 438 of file ApiQueryBase.php.

References $fields, $tables, addFields(), addJoinConds(), addTables(), addWhere(), getDB(), and ContextSource\getUser().

Referenced by ApiQueryAllUsers\execute(), and ApiQueryUsers\execute().

◆ titlePartToKey()

ApiQueryBase::titlePartToKey	(		$titlePart,
			$namespace = NS_MAIN )

Convert an input title or title prefix into a dbkey.

$namespace should always be specified in order to handle per-namespace capitalization settings.

Parameters

string	$titlePart	Title part
int	$namespace	Namespace of the title

Returns: string DBkey (no namespace prefix)

Definition at line 549 of file ApiQueryBase.php.

References $t, ApiBase\dieWithError(), and wfEscapeWikiText().

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), and ApiQueryAllDeletedRevisions\run().

◆ userCanSeeRevDel()

ApiQueryBase::userCanSeeRevDel ( )

Check whether the current user has permission to view revision-deleted fields.

Returns: bool

Definition at line 606 of file ApiQueryBase.php.

References ContextSource\getUser().

Referenced by ApiQueryImageInfo\getCacheMode(), ApiQueryLogEvents\getCacheMode(), ApiQueryRecentChanges\getCacheMode(), and ApiQueryRevisionsBase\getCacheMode().

◆ validateSha1Base36Hash()

ApiQueryBase::validateSha1Base36Hash ( $hash )

Parameters

string $hash

Returns: bool

Definition at line 597 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute(), and ApiQueryAllImages\run().

◆ validateSha1Hash()

ApiQueryBase::validateSha1Hash ( $hash )

Parameters

string $hash

Returns: bool

Definition at line 589 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute(), and ApiQueryAllImages\run().

Member Data Documentation

◆ $fields

ApiQueryBase::$fields

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by select(), and showHiddenUsersAddBlockInfo().

◆ $join_conds

ApiQueryBase::$join_conds

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by addJoinConds(), and select().

◆ $mDb

ApiQueryBase::$mDb

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by getDB(), and selectNamedDB().

◆ $mQueryModule

ApiQueryBase::$mQueryModule

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by getQuery().

◆ $options

ApiQueryBase::$options

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by ApiQuerySiteinfo\appendDefaultOptions(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), and select().

◆ $tables

ApiQueryBase::$tables

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by addTables(), ApiQueryAllUsers\execute(), select(), and showHiddenUsersAddBlockInfo().

◆ $where

ApiQueryBase::$where

private

Definition at line 35 of file ApiQueryBase.php.

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryAllDeletedRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), ApiQueryBacklinks\runSecondQuery(), and select().

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

includes/api/ApiQueryBase.php

Public Member Functions

Private Attributes

Data access

Querying

Utility methods

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addFields()

◆ addFieldsIf()

◆ addJoinConds()

◆ addOption()

◆ addPageSubItem()

◆ addPageSubItems()

◆ addTables()

◆ addTimestampWhereRange()

◆ addTitleInfo()

◆ addWhere()

◆ addWhereFld()

◆ addWhereIf()

◆ addWhereRange()

◆ getCacheMode()

◆ getDB()

◆ getPageSet()

◆ getParent()

◆ getQuery()

◆ prefixedTitlePartToKey()

◆ prepareUrlQuerySearchString()

◆ processRow()

◆ requestExtraData()

◆ resetQueryParams()

◆ select()

◆ selectNamedDB()

◆ setContinueEnumParameter()

◆ showHiddenUsersAddBlockInfo()

◆ titlePartToKey()

◆ userCanSeeRevDel()

◆ validateSha1Base36Hash()

◆ validateSha1Hash()

Member Data Documentation

◆ $fields

◆ $join_conds

◆ $mDb

◆ $mQueryModule

◆ $options

◆ $tables

◆ $where