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

Inheritance diagram for ApiQueryBase:

Collaboration diagram for ApiQueryBase:

Public Member Functions
	__construct (ApiBase $query, $moduleName, $paramPrefix= '')
	getCacheMode ($params)
	Get the cache mode for the data generated by this module.
	getDirectionDescription ($p= '', $extraDirText= '')
	Gets the personalised direction parameter description.
	getPossibleErrors ()
	getQuery ()
	Get the main Query module.
	keyPartToTitle ($keyPart)
	An alternative to keyToTitle() that doesn't trim trailing spaces.
	keyToTitle ($key)
	The inverse of titleToKey()
	prepareUrlQuerySearchString ($query=null, $protocol=null)
	requestExtraData ($pageSet)
	Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName')
	selectNamedDB ($name, $db, $groups)
	Selects the query database connection with the given name.
	showHiddenUsersAddBlockInfo ($showBlockInfo)
	Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information.
	titlePartToKey ($titlePart)
	An alternative to titleToKey() that doesn't trim trailing spaces.
	titleToKey ($title)
	Convert a title to a DB key.
	validateSha1Base36Hash ($hash)
	validateSha1Hash ($hash)
Static Public Member Functions
static	addTitleInfo (&$arr, $title, $prefix= '')
	Add information (title and namespace) about a Title object to a result array.
Public Attributes
	$fields
	$join_conds
	$mDb
	$options
	$tables
	$where
Protected Member Functions
	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.
	addJoinConds ($join_conds)
	Add a set of JOIN conditions to the internal array.
	addOption ($name, $value=null)
	Add an option such as LIMIT or USE INDEX.
	addPageSubItem ($pageId, $item, $elemname=null)
	Same as addPageSubItems(), but one element of $data at a time.
	addPageSubItems ($pageId, $data)
	Add a sub-element under the page element with the given page ID.
	addTables ($tables, $alias=null)
	Add a set of tables to the internal array.
	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.
	addWhere ($value)
	Add a set of WHERE clauses to the internal array.
	addWhereFld ($field, $value)
	Equivalent to addWhere(array($field => $value))
	addWhereIf ($value, $condition)
	Same as addWhere(), but add the WHERE clauses only if a condition is met.
	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.
	checkRowCount ()
	Estimate the row count for the SELECT query that would be run if we called select() right now, and check if it's acceptable.
	getDB ()
	Get the Query database connection (read-only)
	getPageSet ()
	Get the PageSet object to work on.
	resetQueryParams ()
	Blank the internal arrays with query parameters.
	select ($method, $extraQuery=array())
	Execute a SELECT query based on the values in the internal arrays.
	setContinueEnumParameter ($paramName, $paramValue)
	Set a query-continue value.
Private Attributes
	$mQueryModule

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	(	ApiBase $	query,
		$	moduleName,
		$	paramPrefix = `''`
	)

Parameters:

$query	ApiBase
$moduleName	string
$paramPrefix	string

Definition at line 43 of file ApiQueryBase.php.

References $query, 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 117 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 131 of file ApiQueryBase.php.

References $value, and addFields().

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryBlocks\execute(), ApiQueryLogEvents\execute(), ApiQueryTags\execute(), ApiQueryAllUsers\execute(), ApiQueryInfo\getWatchedInfo(), ApiQueryContributions\prepareQuery(), ApiQueryProtectedTitles\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryPagesWithProp\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 array( tablename => array(jointype, conditions) e.g. array('page' => array('LEFT JOIN', 'page_id=rev_page')) . conditions may be a string or an addWhere()-style array

Parameters:

$join_conds array JOIN conditions

Definition at line 106 of file ApiQueryBase.php.

References $join_conds, and ApiBase\dieDebug().

Referenced by ApiQueryCategoryInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryAllUsers\execute(), ApiQueryUsers\execute(), ApiQueryRevisions\execute(), ApiQueryContributions\prepareQuery(), ApiQueryProtectedTitles\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryWatchlist\run(), ApiQueryAllPages\run(), ApiQueryAllImages\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 246 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 348 of file ApiQueryBase.php.

References $result, array(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), and ApiBase\getResult().

Referenced by ApiQueryExternalLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryImageInfo\execute(), ApiQueryRevisions\execute(), ApiQueryImages\run(), ApiQueryDuplicateFiles\run(), ApiQueryCategories\run(), and ApiQueryLinks\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 332 of file ApiQueryBase.php.

References $result, array(), ApiBase\getModuleName(), ApiBase\getModulePrefix(), and ApiBase\getResult().

Referenced by ApiQueryCategoryInfo\execute().

ApiQueryBase::addTables	(	$	tables,
		$	alias = `null`
	)		`[protected]`

Add a set of tables to the internal array.

Parameters:

$tables	mixed Table name or array of table names
$alias	mixed Table alias, or null for no alias. Cannot be used with multiple tables

Definition at line 82 of file ApiQueryBase.php.

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

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:

$field
$dir
$start
$end
$sort	bool

Definition at line 234 of file ApiQueryBase.php.

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

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryBlocks\execute(), ApiQueryLogEvents\execute(), ApiQueryRevisions\execute(), ApiQueryContributions\prepareQuery(), ApiQueryProtectedTitles\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryAllImages\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 305 of file ApiQueryBase.php.

References $title.

Referenced by ApiQueryLogEvents\addLogParams(), ApiImageRotate\addValues(), ApiPurge\addValues(), ApiPatrol\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiImageRotate\execute(), ApiPurge\execute(), ApiQueryRandom\extractRowInfo(), ApiQueryWatchlist\extractRowInfo(), ApiQueryContributions\extractRowInfo(), ApiQueryLogEvents\extractRowInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiImportReporter\reportPage(), ApiQueryLangBacklinks\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryPagesWithProp\run(), ApiQuerySearch\run(), ApiQueryQueryPage\run(), ApiQueryAllImages\run(), ApiQueryLinks\run(), and ApiQueryAllLinks\run().

ApiQueryBase::addWhere ( $ value ) [protected]

Add a set of WHERE clauses to the internal array.

Clauses can be formatted as 'foo=bar' or array('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, array('foo=bar', 'baz' => 3, 'bla' => 'foo') translates to "foo=bar AND baz='3' AND bla='foo'"

Parameters:

$value mixed String or array

Definition at line 150 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 181 of file ApiQueryBase.php.

References $value.

Referenced by ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryPageProps\execute(), ApiQueryBlocks\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiQueryRevisions\execute(), ApiQueryInfo\getDisplayTitle(), ApiQueryInfo\getProtectionInfo(), ApiQueryRandom\prepareQuery(), ApiQueryContributions\prepareQuery(), ApiQueryLangBacklinks\run(), ApiQueryImages\run(), ApiQueryProtectedTitles\run(), ApiQueryIWBacklinks\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryPagesWithProp\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryLinks\run(), ApiQueryAllLinks\run(), and ApiQueryRecentChanges\run().

ApiQueryBase::addWhereIf	(	$	value,
		$	condition
	)		`[protected]`

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

Parameters:

	$value	mixed See addWhere()
bool	$condition	If false, do nothing

Returns:: bool $condition

Definition at line 168 of file ApiQueryBase.php.

References $value, and addWhere().

Referenced by ApiQueryBlocks\execute(), ApiQueryContributions\prepareQuery(), ApiQueryWatchlistRaw\run(), ApiQueryWatchlist\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 201 of file ApiQueryBase.php.

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

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

ApiQueryBase::checkRowCount ( ) [protected]

Estimate the row count for the SELECT query that would be run if we called select() right now, and check if it's acceptable.

Returns:: bool true if acceptable, false otherwise

Definition at line 285 of file ApiQueryBase.php.

References getDB(), global, options(), ApiBase\profileDBIn(), ApiBase\profileDBOut(), and tables.

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:

$params

Returns:: string

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

Definition at line 61 of file ApiQueryBase.php.

ApiQueryBase::getDB ( ) [protected]

Get the Query database connection (read-only)

Returns:: DatabaseBase

Reimplemented from ApiBase.

Reimplemented in ApiQueryAllImages.

Definition at line 381 of file ApiQueryBase.php.

References getQuery().

Referenced by addWhereRange(), ApiQuerySiteinfo\appendGeneralInfo(), checkRowCount(), ApiQueryLangLinks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryCategoryInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryBlocks\execute(), ApiQueryLogEvents\execute(), ApiQueryContributions\execute(), ApiQueryAllUsers\execute(), ApiQueryRevisions\execute(), ApiQueryLogEvents\getCacheMode(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), ApiQueryContributions\prepareQuery(), ApiQueryLangBacklinks\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryWatchlistRaw\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryAllCategories\run(), ApiQueryWatchlist\run(), ApiQueryAllPages\run(), ApiQueryLinks\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), and select().

ApiQueryBase::getDirectionDescription	(	$	p = `''`,
		$	extraDirText = `''`
	)

Gets the personalised direction parameter description.

Parameters:

string	$p	ModulePrefix
string	$extraDirText	Any extra text to be appended on the description

Returns:: array

Definition at line 468 of file ApiQueryBase.php.

References array().

Referenced by ApiQueryProtectedTitles\getParamDescription(), ApiQueryBlocks\getParamDescription(), ApiQueryDeletedrevs\getParamDescription(), ApiQueryContributions\getParamDescription(), ApiQueryWatchlist\getParamDescription(), ApiQueryLogEvents\getParamDescription(), ApiQueryRecentChanges\getParamDescription(), and ApiQueryRevisions\getParamDescription().

ApiQueryBase::getPageSet ( ) [protected]

Get the PageSet object to work on.

Returns:: ApiPageSet

Reimplemented in ApiQueryGeneratorBase.

Definition at line 404 of file ApiQueryBase.php.

References getQuery().

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

ApiQueryBase::getPossibleErrors ( )

Returns:: array

Reimplemented from ApiBase.

Reimplemented in ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryImageInfo, ApiQuerySiteinfo, ApiQueryWatchlist, ApiQueryLogEvents, ApiQueryContributions, ApiQueryBacklinks, ApiQueryAllUsers, ApiQueryBlocks, ApiQueryDeletedrevs, ApiQueryCategoryMembers, ApiQuerySearch, ApiQueryAllImages, ApiQueryFilearchive, ApiQueryAllPages, ApiQueryAllLinks, ApiQueryAllMessages, ApiQueryExtLinksUsage, ApiQueryCategories, ApiQueryLangBacklinks, ApiQueryIWBacklinks, ApiQueryWatchlistRaw, ApiQueryQueryPage, ApiQueryIWLinks, ApiQueryLangLinks, and ApiQueryExternalLinks.

Definition at line 550 of file ApiQueryBase.php.

References array().

ApiQueryBase::getQuery ( )

Get the main Query module.

Returns:: ApiQuery

Definition at line 322 of file ApiQueryBase.php.

Referenced by getDB(), getPageSet(), selectNamedDB(), and ApiQueryGeneratorBase\setContinueEnumParameter().

ApiQueryBase::keyPartToTitle ( $ keyPart )

An alternative to keyToTitle() that doesn't trim trailing spaces.

Parameters:

string $keyPart Key part with spaces

Returns:: string Key part with underscores

Definition at line 457 of file ApiQueryBase.php.

References keyToTitle().

ApiQueryBase::keyToTitle ( $ key )

The inverse of titleToKey()

Parameters:

string $key Page title with underscores

Returns:: string Page title with spaces

Definition at line 430 of file ApiQueryBase.php.

References $key, $t, array(), ApiBase\dieUsageMsg(), and Title\newFromDBkey().

Referenced by keyPartToTitle().

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

Parameters:

$query	String
$protocol	String

Returns:: null|string

Definition at line 481 of file ApiQueryBase.php.

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

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

ApiQueryBase::requestExtraData ( $ pageSet )

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

Parameters:

$pageSet ApiPageSet

Reimplemented in ApiQueryInfo.

Definition at line 315 of file ApiQueryBase.php.

ApiQueryBase::resetQueryParams ( ) [protected]

Blank the internal arrays with query parameters.

Definition at line 68 of file ApiQueryBase.php.

References array(), options(), and tables.

Referenced by __construct(), ApiQueryUsers\execute(), ApiQueryInfo\getDisplayTitle(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), and ApiQueryRandom\prepareQuery().

ApiQueryBase::select	(	$	method,
		$	extraQuery = `array()`
	)		`[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 array( 'tables' => ..., 'fields' => ..., 'where' => ..., 'options' => ..., 'join_conds' => ... )