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

Inheritance diagram for ApiQueryBase:

Collaboration diagram for ApiQueryBase:

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

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

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

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

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

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

	getHelpUrls ()
	Return links to more detailed help pages about the module. 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...

	getParent ()
	Get the parent of this module. 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 ($manager)
	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 ($parseLimit=true)
	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...

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

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

	setWarning ($warning)
	Set warning section for this module. More...

	dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null)
	Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message. More...

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

	getErrorFromStatus ($status, &$extraData=null)
	Get error (as code, string) from a Status object. More...

	dieStatus ($status)
	Throw a UsageException based on the errors in the Status object. More...

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

	dieUsageMsg ($error)
	Output the error message related to a certain array. More...

	dieUsageMsgOrDebug ($error)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...

	parseMsg ($error)
	Return the error message related to a certain array. More...

	logFeatureUsage ($feature)
	Write logging information for API features to a debug log, for usage analysis. 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...

	getModuleProfileName ($db=false)

	profileIn ()

	profileOut ()

	safeProfileOut ()

	getProfileTime ()

	profileDBIn ()

	profileDBOut ()

	getProfileDBTime ()

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 ()
	Get the Config object. More...

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

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getStats ()
	Get the Stats object. More...

	getTiming ()
	Get the Timing object. More...

	getTitle ()
	Get the Title object. More...

	getUser ()
	Get the User object. More...

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

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

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Public Attributes
	$fields

	$join_conds

	$mDb

	$options

	$tables

	$where

Public Attributes inherited from ApiBase
string	$mModulePrefix

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

Private Attributes
	$mQueryModule

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

	getParent ()

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

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

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

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

	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(array($field => $value)) 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...

Utility methods
	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...

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

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

Additional Inherited Members
Static Public Member Functions inherited from ApiBase
static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length. More...

static	makeMessage ($msg, IContextSource $context, array $params=null)
	Create a Message from a string or array. More...

Static Public Attributes inherited from ApiBase
static	$messageMap
	Array that maps message keys to error messages. More...

Protected Member Functions inherited from ApiBase
	getExamplesMessages ()
	Returns usage examples for this module. More...

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

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

	getDB ()
	Gets a default replica DB connection object. 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)
	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 of parameters of type 'timestamp'. More...

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

	dieContinueUsageIf ($condition)
	Die with the $prefix. More...

	getDescriptionMessage ()
	Return the description 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...

	getDescription ()
	Returns the description string for this module. More...

	getParamDescription ()
	Returns an array of parameter descriptions. More...

	getExamples ()
	Returns usage examples for this module. More...

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

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

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

Constructor & Destructor Documentation

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

Parameters

ApiQuery	$queryModule
string	$moduleName
string	$paramPrefix

Definition at line 43 of file ApiQueryBase.php.

References ApiBase\getMain(), and resetQueryParams().

Member Function Documentation

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

References $value.

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

References $value, and addFields().

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

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

References ApiBase\dieDebug().

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

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	$value	Option value

Definition at line 330 of file ApiQueryBase.php.

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

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	$elemname	XML element name. If null, getModuleName() is used

Returns: bool Whether the element fit in the result

Definition at line 511 of file ApiQueryBase.php.

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

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

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

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

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

References $tables, and ApiBase\dieDebug().

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

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

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

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

References $title.

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

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

References $value.

ApiQueryBase::addWhereFld	(	$field,
		$value
	)

protected

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

Parameters

string	$field	Field name
string	$value	Value; ignored if null or empty array;

Definition at line 263 of file ApiQueryBase.php.

References $value.

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

References $value, and addWhere().

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

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

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

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

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

Definition at line 66 of file ApiQueryBase.php.

ApiQueryBase::getDB ( )

protected

Get the Query database connection (read-only)

Returns: Database

Definition at line 108 of file ApiQueryBase.php.

References $mDb, and getQuery().

Referenced by addTimestampWhereRange(), addWhereRange(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQueryBlocks\execute(), ApiQueryLangLinks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryIWLinks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryFilearchive\execute(), ApiQueryLogEvents\execute(), ApiQueryContributions\execute(), ApiQueryContributors\execute(), ApiQueryAllUsers\execute(), ApiQueryLogEvents\getCacheMode(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryContributions\prepareQuery(), prepareUrlQuerySearchString(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryLangBacklinks\run(), ApiQueryIWBacklinks\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryLinks\run(), ApiQueryRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiQueryRandom\runQuery(), ApiQueryBacklinks\runSecondQuery(), and select().

ApiQueryBase::getPageSet ( )

protected

Get the PageSet object to work on.

Returns: ApiPageSet

Definition at line 133 of file ApiQueryBase.php.

References getQuery().

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

ApiQueryBase::getParent ( )

See also: ApiBase::getParent()

Definition at line 100 of file ApiQueryBase.php.

References getQuery().

ApiQueryBase::getQuery ( )

Get the main Query module.

Returns: ApiQuery

Definition at line 93 of file ApiQueryBase.php.

References $mQueryModule.

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

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

References $t, ApiBase\dieUsageMsg(), and Title\newFromText().

Referenced by ApiQueryWatchlistRaw\run().

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

Parameters

string	$query
string	$protocol

Returns: null|string

Definition at line 415 of file ApiQueryBase.php.

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

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

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

References Hooks\run().

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

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

Definition at line 79 of file ApiQueryBase.php.

ApiQueryBase::resetQueryParams ( )

protected

Blank the internal arrays with query parameters.

Definition at line 147 of file ApiQueryBase.php.

References options().

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

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.