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

	getContinuationManager ()

	setContinuationManager (ApiContinuationManager $manager=null)

	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.

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

	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.

	addBlockInfoToStatus (StatusValue $status, Authority $user=null)
	Add block info to block messages in 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=0)
	Abort execution with an error.

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

	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 ( $pageIdentity, $actions, array $options=[])
	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.

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

Protected Member Functions
Querying
	resetQueryParams ()
	Blank the internal arrays with query parameters.

	getQueryBuilder ()
	Get the SelectQueryBuilder.

	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( [ $field => $value ] )

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

	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.

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.

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

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata.

	getHookRunner ()
	Get an ApiHookRunner for running core API hooks.

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

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

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

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

	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.

Data access
	getQuery ()
	Get the main Query module.

	getParent ()
	Get the parent of this module. Stability: stable to override Since 1.25 Returns ApiBase\|null

	selectNamedDB ( $name, $db, $groups)
	Change the database connection for subsequent calls to getDB().

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

	getPageSet ()
	Get the PageSet object to work on.

Utility methods
	titlePartToKey ( $titlePart, $namespace=NS_MAIN)
	Convert an input title or title prefix into a 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.

	parsePrefixedTitlePart ( $titlePart, $defaultNamespace=NS_MAIN)
	Convert an input title or title prefix into a TitleValue.

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

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	clearCacheForTest ()
	Reset static caches of database state.

Public Attributes inherited from ApiBase
const	PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
	(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

const	PARAM_DFLT = ParamValidator::PARAM_DEFAULT

const	PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI

const	PARAM_TYPE = ParamValidator::PARAM_TYPE

const	PARAM_MAX = IntegerDef::PARAM_MAX

const	PARAM_MAX2 = IntegerDef::PARAM_MAX2

const	PARAM_MIN = IntegerDef::PARAM_MIN

const	PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES

const	PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED

const	PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED

const	PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP

const	PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX

const	PARAM_ALL = ParamValidator::PARAM_ALL

const	PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES

const	PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE

const	PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES

const	PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1

const	PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2

const	PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES

const	PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS

const	PARAM_HELP_MSG = 'api-param-help-msg'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append'
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

const	PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'
	(array) Specify additional information tags for the parameter.

const	PARAM_VALUE_LINKS = 'api-param-value-links'
	Deprecated and unused.

const	PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage().

const	PARAM_TEMPLATE_VARS = 'param-template-vars'
	(array) Indicate that this is a templated parameter, and specify replacements.

const	ALL_DEFAULT_STRING = '*'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

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	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough.

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.

Stability: stable: to extend

Definition at line 37 of file ApiQueryBase.php.

Constructor & Destructor Documentation

◆ __construct()

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

Stability: stable: to call

Parameters

ApiQuery	$queryModule
string	$moduleName
string	$paramPrefix

Definition at line 53 of file ApiQueryBase.php.

References ApiBase\getMain(), and 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 217 of file ApiQueryBase.php.

References getQueryBuilder().

◆ 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

Definition at line 227 of file ApiQueryBase.php.

References addFields().

Referenced by ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), and ApiQueryRecentChanges\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 206 of file ApiQueryBase.php.

References ApiBase\dieDebug(), and getQueryBuilder().

Referenced by ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ 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
mixed	$value	The option value, or null for a boolean option

Definition at line 383 of file ApiQueryBase.php.

References getQueryBuilder().

◆ addPageSubItem()

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

protected

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

Parameters

int	$pageId
mixed	$item	Data à 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 499 of file ApiQueryBase.php.

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

Referenced by ApiQueryContributors\execute(), ApiQueryExternalLinks\execute(), ApiQueryImageInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), 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
array	$data	Data array à la ApiResult

Returns: bool Whether the element fit in the result

Definition at line 482 of file ApiQueryBase.php.

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

Referenced by ApiQueryCategoryInfo\execute().

◆ addTables()

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

protected

Add a set of tables to the internal array.

Parameters

string \| array	$tables	Table name or array of table names or nested arrays for joins using parentheses for grouping
string \| null	$alias	Table alias, or null for no alias. Cannot be used with multiple tables

Definition at line 187 of file ApiQueryBase.php.

References ApiBase\dieDebug(), and getQueryBuilder().

◆ 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 \| int \| null	$start
string \| int \| null	$end
bool	$sort

Definition at line 371 of file ApiQueryBase.php.

References addWhereRange(), and getDB().

Referenced by ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), 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 471 of file ApiQueryBase.php.

References $title.

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), and ApiQueryRandom\runQuery().

◆ addWhere()

ApiQueryBase::addWhere ( $value )

protected

Add a set of WHERE clauses to the internal array.

The array should be appropriate for passing as $conds to IDatabase::select(). Arrays from multiple calls are merged with array_merge(). A string is treated as a single-element array.

When passing ‘'field’ => $arrayOfIDs` where the IDs are taken from user input, consider using addWhereIDsFld() instead.

See also: IDatabase::select()

Parameters

string | array $value

Definition at line 250 of file ApiQueryBase.php.

References getQueryBuilder().

◆ addWhereFld()

ApiQueryBase::addWhereFld	(		$field,
			$value )

protected

Equivalent to addWhere( [ $field => $value ] )

When $value is an array of integer IDs taken from user input, consider using addWhereIDsFld() instead.

Parameters

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

Definition at line 287 of file ApiQueryBase.php.

References getQueryBuilder().

Referenced by ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), and ApiQueryRandom\runQuery().

◆ addWhereIDsFld()

ApiQueryBase::addWhereIDsFld	(	$table,
		$field,
		$ids )

protected

Like addWhereFld for an integer list of IDs.

When passed wildly out-of-range values for integer comparison, the database may choose a poor query plan. This method validates the passed IDs against the range of values in the database to omit out-of-range values.

This should be used when the IDs are derived from arbitrary user input; it is not necessary if the IDs are already known to be within a sensible range.

This should not be used when there is not a suitable index on $field to quickly retrieve the minimum and maximum values.

Since: 1.33

Parameters

string	$table	Table name
string	$field	Field name
int[]	$ids

Returns: int Count of IDs actually included

Definition at line 314 of file ApiQueryBase.php.

References ApiBase\filterIDs(), and getQueryBuilder().

Referenced by ApiQueryBlocks\execute().

◆ 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

Definition at line 268 of file ApiQueryBase.php.

References addWhere().

Referenced by ApiQueryBlocks\execute(), ApiQueryContributors\execute(), and ApiQueryRecentChanges\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 \| int \| null	$start	Value to start the list at. If $dir == 'newer' this is the lower boundary, otherwise it's the upper boundary
string \| int \| null	$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 342 of file ApiQueryBase.php.

References addWhere(), getDB(), and getQueryBuilder().

Referenced by addTimestampWhereRange(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiQueryPagePropNames\execute(), and ApiQueryDeletedRevisions\run().

◆ executeGenderCacheFromResultWrapper()

ApiQueryBase::executeGenderCacheFromResultWrapper	(	IResultWrapper	$res,
			$fname = __METHOD__,
			$fieldPrefix = 'page' )

protected

Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo.

Parameters

IResultWrapper	$res	Result set to work on. The result set must have _namespace and _title fields with the provided field prefix
string	$fname	The caller function name, always use METHOD
string	$fieldPrefix	Prefix for fields to check gender for

Definition at line 616 of file ApiQueryBase.php.

References $res.

Referenced by ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryRecentChanges\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), and ApiQueryRandom\runQuery().

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

Stability: stable: to override

Parameters

array $params

Returns: string

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

Definition at line 76 of file ApiQueryBase.php.

◆ getDB()

ApiQueryBase::getDB ( )

protected

Get the Query database connection (read-only)

Stability: stable: to override

Returns: IDatabase

Reimplemented from ApiBase.

Reimplemented in ApiQueryAllImages.

Definition at line 117 of file ApiQueryBase.php.

References getQuery().

◆ getPageSet()

ApiQueryBase::getPageSet ( )

protected

Get the PageSet object to work on.

Stability: stable: to override

Returns: ApiPageSet

Reimplemented in ApiQueryGeneratorBase.

Definition at line 148 of file ApiQueryBase.php.

References getQuery().

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

◆ getParent()

ApiQueryBase::getParent ( )

Get the parent of this module.

Stability: stable: to override

Since: 1.25

Returns: ApiBase|null

Reimplemented from ApiBase.

Definition at line 108 of file ApiQueryBase.php.

References getQuery().

Referenced by ApiQueryRevisionsBase\parseParameters().

◆ getQuery()

ApiQueryBase::getQuery ( )

Get the main Query module.

Returns: ApiQuery

Definition at line 103 of file ApiQueryBase.php.

Referenced by ApiQueryLanguageinfo\execute(), getDB(), ApiQueryLanguageinfo\getExamplesMessages(), getPageSet(), getParent(), and selectNamedDB().

◆ getQueryBuilder()

ApiQueryBase::getQueryBuilder ( )

protected

Get the SelectQueryBuilder.

This is lazy initialised since getDB() fails in ApiQueryAllImages if it is called before the constructor completes.

Returns: SelectQueryBuilder

Definition at line 173 of file ApiQueryBase.php.

References getDB().

Referenced by addFields(), addJoinConds(), addOption(), addTables(), addWhere(), addWhereFld(), addWhereIDsFld(), addWhereRange(), and select().

◆ parsePrefixedTitlePart()

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

protected

Convert an input title or title prefix into a TitleValue.

Since: 1.35

Parameters

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

Returns: TitleValue

Definition at line 560 of file ApiQueryBase.php.

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

◆ 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

stdClass	$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 454 of file ApiQueryBase.php.

References ApiBase\getHookRunner().

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.

Stability: stable: to override

Parameters

ApiPageSet $pageSet

Reimplemented in ApiQueryInfo.

Definition at line 90 of file ApiQueryBase.php.

◆ resetQueryParams()

ApiQueryBase::resetQueryParams ( )

protected

Blank the internal arrays with query parameters.

Definition at line 161 of file ApiQueryBase.php.

Referenced by __construct(), ApiQueryContributors\execute(), ApiQueryUsers\execute(), 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: IResultWrapper

Definition at line 404 of file ApiQueryBase.php.

◆ selectNamedDB()

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

Change the database connection for subsequent calls to getDB().

See ApiQuery::getNamedDB() for more information.

Deprecated: since 1.39 Use or override ApiBase::getDB() and optionally pass a query group to wfGetDB() or ILoadBalancer::getConnectionRef().

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 137 of file ApiQueryBase.php.

References getQuery(), and wfDeprecated().

◆ setContinueEnumParameter()

ApiQueryBase::setContinueEnumParameter	(		$paramName,
			$paramValue )

protected

Set a query-continue value.

Parameters

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

Reimplemented in ApiQueryGeneratorBase.

Definition at line 520 of file ApiQueryBase.php.

References ApiBase\getContinuationManager().

Referenced by ApiQueryAllMessages\execute(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLanguageinfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQuerySiteinfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiQueryUserContribs\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
int	$namespace	Namespace of the title

Returns: string DBkey (no namespace prefix)

Definition at line 534 of file ApiQueryBase.php.

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

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), and ApiQueryAllDeletedRevisions\run().

◆ userCanSeeRevDel()

ApiQueryBase::userCanSeeRevDel ( )

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

Returns: bool

Definition at line 597 of file ApiQueryBase.php.

References getAuthority().

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

◆ validateSha1Base36Hash()

ApiQueryBase::validateSha1Base36Hash ( $hash )

Parameters

string $hash

Returns: bool

Definition at line 588 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute().

◆ validateSha1Hash()

ApiQueryBase::validateSha1Hash ( $hash )

Parameters

string $hash

Returns: bool

Definition at line 580 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute().

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

includes/api/ApiQueryBase.php

Public Member Functions

Protected Member Functions

Data access

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

◆ addWhereIDsFld()

◆ addWhereIf()

◆ addWhereRange()

◆ executeGenderCacheFromResultWrapper()

◆ getCacheMode()

◆ getDB()

◆ getPageSet()

◆ getParent()

◆ getQuery()

◆ getQueryBuilder()

◆ parsePrefixedTitlePart()

◆ processRow()

◆ requestExtraData()

◆ resetQueryParams()

◆ select()

◆ selectNamedDB()

◆ setContinueEnumParameter()

◆ titlePartToKey()

◆ userCanSeeRevDel()

◆ validateSha1Base36Hash()

◆ validateSha1Hash()