This is a class for doing query pages; since they're almost all the same, we factor out some of the functionality into a superclass, and let subclasses derive from it. More...

Inheritance diagram for QueryPage:

[legend]

Collaboration diagram for QueryPage:

[legend]

Public Member Functions
	delete (LinkTarget $title)
	Remove a cached result.

	doQuery ( $offset=false, $limit=false)
	Somewhat deprecated, you probably want to be using execute()

	execute ( $par)
	This is the actual workhorse.

	fetchFromCache ( $limit, $offset=false)
	Fetch the query results from the query cache Stable to override.

	getCachedTimestamp ()

	getQueryInfo ()
	Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions.

	isCacheable ()
	Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table.

	isCached ()
	Whether or not the output of the page in question is retrieved from the database cache.

	isExpensive ()
	Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.

	isSyndicated ()
	Sometime we don't want to build rss / atom feeds.

	reallyDoQuery ( $limit, $offset=false)
	Run the query and return the result Stable to override.

	recache ( $limit, $ignoreErrors=true)
	Clear the cache and save new results.

	usesTimestamps ()
	Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching.

Public Member Functions inherited from SpecialPage
	__construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
	Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.

	addHelpLink ( $to, $overrideBaseUrl=false)
	Adds help link with an icon via page indicators.

	checkPermissions ()
	Checks if userCanExecute, and if not throws a PermissionsError.

	checkReadOnly ()
	If the wiki is currently in readonly mode, throws a ReadOnlyError.

	doesWrites ()
	Indicates whether this special page may perform database writes.

	getConfig ()
	Shortcut to get main config object.

	getContext ()
	Gets the context this SpecialPage is executed in.

	getDescription ()
	Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.

	getFinalGroupName ()
	Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.

	getFullTitle ()
	Return the full title, including $par.

	getLanguage ()
	Shortcut to get user's language.

	getLinkRenderer ()

	getLocalName ()
	Get the localised name of the special page Stable to override.

	getName ()
	Get the name of this Special Page.

	getOutput ()
	Get the OutputPage being used for this instance.

	getPageTitle ( $subpage=false)
	Get a self-referential title object.

	getRequest ()
	Get the WebRequest being used for this instance.

	getRestriction ()
	Get the permission that a user must have to execute this page.

	getSkin ()
	Shortcut to get the skin being used for this instance.

	getUser ()
	Shortcut to get the User executing this instance.

	including ( $x=null)
	Whether the special page is being evaluated via transclusion.

	isIncludable ()
	Whether it's allowed to transclude the special page via {{Special:Foo/params}} Stable to override.

	isListed ()
	Whether this special page is listed in Special:SpecialPages Stable to override.

	isRestricted ()
	Can be overridden by subclasses with more complicated permissions schemes.

	listed ( $x=null)
	Get or set whether this special page is listed in Special:SpecialPages.

	maxIncludeCacheTime ()
	How long to cache page when it is being included.

	msg ( $key,... $params)
	Wrapper around wfMessage that sets the current context.

	prefixSearchSubpages ( $search, $limit, $offset)
	Return an array of subpages beginning with $search that this special page will accept.

	requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in, throws UserNotLoggedIn error.

	run ( $subPage)
	Entry point.

	setContext ( $context)
	Sets the context this SpecialPage is executed in.

	setHookContainer (HookContainer $hookContainer)

	setLinkRenderer (LinkRenderer $linkRenderer)

	setListed ( $listed)
	Set whether this page is listed in Special:Specialpages, at run-time.

	userCanExecute (User $user)
	Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).

Static Public Member Functions
static	getDisabledQueryPages (Config $config)
	Get a list of query pages disabled and with it's run mode.

static	getPages ()
	Get a list of query page classes and their associated special pages, for periodic updates.

Static Public Member Functions inherited from SpecialPage
static	getSafeTitleFor ( $name, $subpage=false)
	Get a localised Title object for a page name with a possibly unvalidated subpage.

static	getTitleFor ( $name, $subpage=false, $fragment='')
	Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.

static	getTitleValueFor ( $name, $subpage=false, $fragment='')
	Get a localised TitleValue object for a specified special page name.

Protected Member Functions
	closeList ()

	executeLBFromResultWrapper (IResultWrapper $res, $ns=null)
	Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch.

	formatResult ( $skin, $result)
	Formats the results of the query for display.

	getCacheOrderFields ()
	Return the order fields for fetchFromCache.

	getDBLimit ( $uiLimit, $uiOffset)
	What is limit to fetch from DB.

	getLimitOffset ()
	Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser().

	getMaxResults ()
	Get max number of results we can return in miser mode.

	getOrderFields ()
	Subclasses return an array of fields to order by here.

	getPageHeader ()
	The content returned by this function will be output before any result.

	getRecacheDB ()
	Get a DB connection to be used for slow recache queries Stable to override.

	getSQL ()
	For back-compat, subclasses may return a raw SQL query here, as a string.

	linkParameters ()
	If using extra form wheely-dealies, return a set of parameters here as an associative array.

	openList ( $offset)

	outputResults ( $out, $skin, $dbr, $res, $num, $offset)
	Format and output report results using the given information plus OutputPage.

	preprocessResults ( $db, $res)
	Do any necessary preprocessing of the result object.

	setListoutput ( $bool)
	A mutator for $this->listoutput;.

	showEmptyText ()
	Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show.

	sortDescending ()
	Override to sort by increasing values.

Protected Member Functions inherited from SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.

	afterExecute ( $subPage)
	Gets called after.

	beforeExecute ( $subPage)
	Gets called before.

	buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
	Generate (prev x\| next x) (20\|50\|100...) type links for paging.

	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.

	displayRestrictionError ()
	Output an error message telling the user what access level they have to have Stable to override.

	getCacheTTL ()
	Stable to override.

	getGroupName ()
	Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

	getHookContainer ()

	getHookRunner ()

	getLanguageConverter ()
	Shortcut to get language's converter.

	getLoginSecurityLevel ()
	Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.

	getRobotPolicy ()
	Return the robot policy.

	getSubpagesForPrefixSearch ()
	Return an array of subpages that this special page will accept for prefix searches.

	outputHeader ( $summaryMessageKey='')
	Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.

	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.

	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes! Stable to override.

	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.

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

Protected Attributes
string null	$cachedTimestamp = null

int	$limit = 0

bool	$listoutput = false
	Whether or not we want plain listoutput rather than an ordered list.

int	$numRows
	The number of rows returned by the query.

int	$offset = 0
	The offset and limit in use, as passed to the query() function.

bool	$shownavigation = true
	Whether to show prev/next links.

Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.

	$mIncludable

	$mIncluding

	$mName

	$mRestriction

Additional Inherited Members
Static Protected Member Functions inherited from SpecialPage
static	prefixSearchArray ( $search, $limit, array $subpages, $offset)
	Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).

Detailed Description

This is a class for doing query pages; since they're almost all the same, we factor out some of the functionality into a superclass, and let subclasses derive from it.

Stable to extend

Definition at line 39 of file QueryPage.php.

Member Function Documentation

◆ closeList()

QueryPage::closeList ( )

protected

Returns: string

Definition at line 800 of file QueryPage.php.

Referenced by outputResults(), and SpecialFileDuplicateSearch\showList().

◆ delete()

QueryPage::delete ( LinkTarget $title )

Remove a cached result.

Useful for interactive backlogs where the user can fix problems in-place.

Parameters

LinkTarget $title The page to remove.

Since: 1.34

Definition at line 425 of file QueryPage.php.

References $title, DB_MASTER, SpecialPage\getName(), isCached(), and wfGetDB().

◆ doQuery()

QueryPage::doQuery	(	$offset = `false`,
		$limit = `false`
	)

Somewhat deprecated, you probably want to be using execute()

Parameters

int \| bool	$offset
int \| bool	$limit

Returns: IResultWrapper

Definition at line 495 of file QueryPage.php.

References $offset, fetchFromCache(), isCacheable(), isCached(), and reallyDoQuery().

◆ execute()

QueryPage::execute ( $par )

This is the actual workhorse.

It does everything needed to make a real, honest-to-gosh query page. Stable to override

Parameters

string | null $par

Reimplemented from SpecialPage.

Reimplemented in SpecialBrokenRedirects, SpecialDoubleRedirects, SpecialFileDuplicateSearch, SpecialLinkSearch, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialMIMESearch, SpecialPagesWithProp, SpecialUnwatchedPages, WantedPagesPage, and SpecialWithoutInterwiki.

Definition at line 633 of file QueryPage.php.

References $dbr, $lang, $limit, $res, SpecialPage\buildPrevNextNavigation(), SpecialPage\checkPermissions(), fetchFromCache(), getCachedTimestamp(), SpecialPage\getConfig(), getDBLimit(), getDisabledQueryPages(), SpecialPage\getLanguage(), getLimitOffset(), getMaxResults(), SpecialPage\getName(), SpecialPage\getOutput(), getPageHeader(), getRecacheDB(), SpecialPage\getSkin(), SpecialPage\getUser(), isCacheable(), isCached(), isSyndicated(), linkParameters(), SpecialPage\msg(), SpecialPage\outputHeader(), outputResults(), preprocessResults(), reallyDoQuery(), SpecialPage\setHeaders(), and showEmptyText().

◆ executeLBFromResultWrapper()

QueryPage::executeLBFromResultWrapper	(	IResultWrapper	$res,
			$ns = `null`
	)

protected

Creates a new LinkBatch object, adds all pages from the passed result wrapper (MUST include title and optional the namespace field) and executes the batch.

This operation will pre-cache LinkCache information like page existence and information for stub color and redirect hints.

Parameters

IResultWrapper	$res	The result wrapper to process. Needs to include the title field and namespace field, if the $ns parameter isn't set.
null	$ns	Use this namespace for the given titles in the result wrapper, instead of the namespace value of $res.

Definition at line 823 of file QueryPage.php.

References $res, and LinkBatch\add().

◆ fetchFromCache()

QueryPage::fetchFromCache	(	$limit,
		$offset = `false`
	)

Fetch the query results from the query cache Stable to override.

Parameters

int \| bool	$limit	Numerical limit or false for no limit
int \| bool	$offset	Numerical offset or false for no offset

Returns: IResultWrapper

Since: 1.18

Definition at line 512 of file QueryPage.php.

References $dbr, $limit, $offset, DB_REPLICA, getCacheOrderFields(), SpecialPage\getName(), sortDescending(), and wfGetDB().

Referenced by doQuery(), and execute().

◆ formatResult()

QueryPage::formatResult	(	$skin,
		$result
	)

abstractprotected

Formats the results of the query for display.

The skin is the current skin; you can use it for making links. The result is a single row of result data. You should be able to grab SQL results from it. If the function returns false, the line output will be skipped.

Parameters

Skin	$skin
object	$result	Result row

Returns: string|bool String or false to skip

Reimplemented in ImageQueryPage, WantedQueryPage, SpecialAncientPages, SpecialBrokenRedirects, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialFileDuplicateSearch, SpecialLinkSearch, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialMediaStatistics, SpecialMIMESearch, SpecialMostCategories, SpecialMostInterwikis, SpecialMostLinked, SpecialMostLinkedCategories, SpecialMostLinkedTemplates, SpecialPagesWithProp, SpecialShortPages, SpecialUncategorizedCategories, SpecialUnusedCategories, SpecialUnusedTemplates, SpecialUnwatchedPages, SpecialWantedCategories, and PageQueryPage.

Referenced by outputResults().

◆ getCachedTimestamp()

QueryPage::getCachedTimestamp ( )

Returns: string

Definition at line 559 of file QueryPage.php.

References $cachedTimestamp, $dbr, DB_REPLICA, SpecialPage\getName(), and wfGetDB().

Referenced by execute().

◆ getCacheOrderFields()

QueryPage::getCacheOrderFields ( )

protected

Return the order fields for fetchFromCache.

Default is to always use "ORDER BY value" which was the default prior to this function. Stable to override

Returns: array

Since: 1.29

Reimplemented in WantedQueryPage.

Definition at line 552 of file QueryPage.php.

Referenced by fetchFromCache().

◆ getDBLimit()

QueryPage::getDBLimit	(	$uiLimit,
		$uiOffset
	)

protected

What is limit to fetch from DB.

Used to make it appear the DB stores less results then it actually does

Parameters

int	$uiLimit	Limit from UI
int	$uiOffset	Offset from UI

Returns: int Limit to use for DB (not including extra row to see if at end)

Definition at line 602 of file QueryPage.php.

References $limit, SpecialPage\getConfig(), and getMaxResults().

Referenced by execute().

◆ getDisabledQueryPages()

static QueryPage::getDisabledQueryPages ( Config $config )

static

Get a list of query pages disabled and with it's run mode.

Parameters

Config $config

Returns: string[]

Definition at line 129 of file QueryPage.php.

References Config\get().

Referenced by execute(), and UpdateSpecialPages\execute().

◆ getLimitOffset()

QueryPage::getLimitOffset ( )

protected

Returns limit and offset, as returned by $this->getRequest()->getLimitOffsetForUser().

Subclasses may override this to further restrict or modify limit and offset.

Note: Restricts the offset parameter, as most query pages have inefficient paging

Its generally expected that the returned limit will not be 0, and the returned offset will be less than the max results.

Since: 1.26

Returns: int[] list( $limit, $offset )

Definition at line 581 of file QueryPage.php.

References $limit, $offset, SpecialPage\getConfig(), getMaxResults(), SpecialPage\getRequest(), and SpecialPage\getUser().

Referenced by execute().

◆ getMaxResults()

QueryPage::getMaxResults ( )

protected

Get max number of results we can return in miser mode.

Most QueryPage subclasses use inefficient paging, so limit the max amount we return This matters for uncached query pages that might otherwise accept an offset of 3 million

Stable to override

Since: 1.27

Returns: int

Reimplemented in SpecialLinkSearch.

Definition at line 622 of file QueryPage.php.

References SpecialPage\getConfig().

Referenced by execute(), getDBLimit(), and getLimitOffset().

◆ getOrderFields()

QueryPage::getOrderFields ( )

protected

Subclasses return an array of fields to order by here.

Don't append DESC to the field names, that'll be done automatically if sortDescending() returns true. Stable to override

Returns: string[]

Since: 1.18

Reimplemented in WantedQueryPage, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialLinkSearch, SpecialListRedirects, SpecialLonelyPages, SpecialMediaStatistics, SpecialMIMESearch, SpecialPagesWithProp, SpecialShortPages, SpecialUncategorizedImages, SpecialUncategorizedPages, SpecialUnusedCategories, SpecialUnusedTemplates, SpecialUnwatchedPages, and SpecialWithoutInterwiki.

Definition at line 208 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ getPageHeader()

QueryPage::getPageHeader ( )

protected

The content returned by this function will be output before any result.

Stable to override

Returns: string

Reimplemented in SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialLonelyPages, SpecialMIMESearch, SpecialUnusedCategories, SpecialUnusedImages, SpecialUnusedTemplates, WantedFilesPage, and SpecialWithoutInterwiki.

Definition at line 299 of file QueryPage.php.

Referenced by execute().

◆ getPages()

static QueryPage::getPages ( )

static

Get a list of query page classes and their associated special pages, for periodic updates.

DO NOT CHANGE THIS LIST without testing that maintenance/updateSpecialPages.php still works.

Returns: string[][]

Definition at line 77 of file QueryPage.php.

Referenced by ApiQueryQueryPage\__construct(), and UpdateSpecialPages\execute().

◆ getQueryInfo()

QueryPage::getQueryInfo ( )

Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => options join_conds => JOIN conditions.

Note that the query itself should return the following three columns: 'namespace', 'title', and 'value'. 'value' is used for sorting.

These may be stored in the querycache table for expensive queries, and that cached data will be returned sometimes, so the presence of extra fields can't be relied upon. The cached 'value' column will be an integer; non-numeric values are useful only for sorting the initial query (except if they're timestamps, see usesTimestamps()).

Don't include an ORDER or LIMIT clause, they will be added.

If this function is not overridden or returns something other than an array, getSQL() will be used instead. This is for backwards compatibility only and is strongly deprecated. Stable to override

Returns: array

Since: 1.18

Reimplemented in SpecialAncientPages, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialFileDuplicateSearch, SpecialLinkSearch, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialLonelyPages, SpecialMediaStatistics, SpecialMIMESearch, SpecialMostCategories, MostimagesPage, SpecialMostInterwikis, SpecialMostLinked, SpecialMostLinkedCategories, SpecialMostLinkedTemplates, SpecialPagesWithProp, SpecialShortPages, SpecialUncategorizedCategories, SpecialUncategorizedImages, SpecialUncategorizedPages, SpecialUnusedCategories, SpecialUnusedImages, SpecialUnusedTemplates, SpecialUnwatchedPages, SpecialWantedCategories, WantedFilesPage, WantedPagesPage, SpecialWantedTemplates, and SpecialWithoutInterwiki.

Definition at line 184 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ getRecacheDB()

QueryPage::getRecacheDB ( )

protected

Get a DB connection to be used for slow recache queries Stable to override.

Returns: IDatabase

Definition at line 415 of file QueryPage.php.

References DB_REPLICA, SpecialPage\getName(), and wfGetDB().

Referenced by execute(), reallyDoQuery(), and SpecialShortPages\reallyDoQuery().

◆ getSQL()

QueryPage::getSQL ( )

protected

For back-compat, subclasses may return a raw SQL query here, as a string.

This is strongly deprecated; getQueryInfo() should be overridden instead.

Exceptions

MWException

Returns: string

Definition at line 194 of file QueryPage.php.

Referenced by reallyDoQuery().

◆ isCacheable()

QueryPage::isCacheable ( )

Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode and will not have their results written to the querycache table.

Stable to override

Returns: bool

Since: 1.18

Reimplemented in SpecialFileDuplicateSearch, SpecialLinkSearch, SpecialMIMESearch, and SpecialPagesWithProp.

Definition at line 257 of file QueryPage.php.

Referenced by doQuery(), execute(), and recache().

◆ isCached()

QueryPage::isCached ( )

Whether or not the output of the page in question is retrieved from the database cache.

Stable to override

Returns: bool

Reimplemented from SpecialPage.

Reimplemented in SpecialFileDuplicateSearch.

Definition at line 268 of file QueryPage.php.

References SpecialPage\getConfig(), and isExpensive().

Referenced by delete(), doQuery(), execute(), WantedQueryPage\formatResult(), SpecialMostCategories\formatResult(), SpecialMostInterwikis\formatResult(), SpecialShortPages\formatResult(), SpecialWantedCategories\formatResult(), and SpecialWithoutInterwiki\getPageHeader().

◆ isExpensive()

QueryPage::isExpensive ( )

Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.

$wgDisableQueryPages causes all query pages to be declared expensive. Some query pages are always expensive.

Stable to override

Returns: bool

Reimplemented from SpecialPage.

Reimplemented in WantedQueryPage, SpecialAncientPages, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialLonelyPages, SpecialMediaStatistics, SpecialMIMESearch, SpecialMostCategories, MostimagesPage, SpecialMostInterwikis, SpecialMostLinked, SpecialMostLinkedTemplates, SpecialUncategorizedImages, SpecialUncategorizedPages, SpecialUnusedCategories, SpecialUnusedImages, SpecialUnusedTemplates, SpecialUnwatchedPages, and SpecialWithoutInterwiki.

Definition at line 245 of file QueryPage.php.

References SpecialPage\getConfig().

Referenced by isCached().

◆ isSyndicated()

QueryPage::isSyndicated ( )

Sometime we don't want to build rss / atom feeds.

Stable to override

Returns: bool

Reimplemented in WantedQueryPage, SpecialAncientPages, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialFileDuplicateSearch, SpecialLinkSearch, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialLonelyPages, SpecialMIMESearch, SpecialMostCategories, MostimagesPage, SpecialMostInterwikis, SpecialMostLinked, SpecialMostLinkedCategories, SpecialMostLinkedTemplates, SpecialPagesWithProp, SpecialShortPages, SpecialUncategorizedImages, SpecialUncategorizedPages, SpecialUnusedImages, SpecialUnusedTemplates, SpecialUnwatchedPages, and SpecialWithoutInterwiki.

Definition at line 278 of file QueryPage.php.

Referenced by execute().

◆ linkParameters()

QueryPage::linkParameters ( )

protected

If using extra form wheely-dealies, return a set of parameters here as an associative array.

They will be encoded and added to the paging links (prev/next/lengths).

Stable to override

Returns: array

Reimplemented in SpecialFileDuplicateSearch, SpecialLinkSearch, and SpecialMIMESearch.

Definition at line 322 of file QueryPage.php.

Referenced by execute().

◆ openList()

QueryPage::openList ( $offset )

protected

Parameters

int $offset

Returns: string

Definition at line 793 of file QueryPage.php.

References $offset.

Referenced by outputResults(), and SpecialFileDuplicateSearch\showList().

◆ outputResults()

QueryPage::outputResults	(	$out,
		$skin,
		$dbr,
		$res,
		$num,
		$offset
	)

protected

Format and output report results using the given information plus OutputPage.

Stable to override

Parameters

OutputPage	$out	OutputPage to print to
Skin	$skin	User skin to use
IDatabase	$dbr	Database (read) connection to use
IResultWrapper	$res	Result pointer
int	$num	Number of available result rows
int	$offset	Paging offset

Reimplemented in ImageQueryPage, and SpecialMediaStatistics.

Definition at line 759 of file QueryPage.php.

References $line, $res, closeList(), formatResult(), and openList().

Referenced by execute().

◆ preprocessResults()

QueryPage::preprocessResults	(	$db,
		$res
	)

protected

Do any necessary preprocessing of the result object.

Stable to override

Parameters

IDatabase	$db
IResultWrapper	$res

Reimplemented in PageQueryPage, WantedQueryPage, SpecialAncientPages, SpecialBrokenRedirects, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialLinkSearch, SpecialListDuplicatedFiles, SpecialListRedirects, SpecialMIMESearch, SpecialMostCategories, SpecialMostInterwikis, SpecialMostLinked, SpecialMostLinkedCategories, SpecialMostLinkedTemplates, SpecialShortPages, SpecialUnusedCategories, SpecialUnwatchedPages, SpecialWantedCategories, and SpecialMediaStatistics.

Definition at line 810 of file QueryPage.php.

Referenced by execute().

◆ reallyDoQuery()

QueryPage::reallyDoQuery	(	$limit,
		$offset = `false`
	)

Run the query and return the result Stable to override.

Parameters

int \| bool	$limit	Numerical limit or false for no limit
int \| bool	$offset	Numerical offset or false for no offset

Returns: IResultWrapper

Since: 1.18

Reimplemented in SpecialShortPages.

Definition at line 444 of file QueryPage.php.

References $dbr, $limit, $offset, $res, getOrderFields(), getQueryInfo(), getRecacheDB(), getSQL(), and sortDescending().

Referenced by doQuery(), execute(), and recache().

◆ recache()

QueryPage::recache	(	$limit,
		$ignoreErrors = `true`
	)

Clear the cache and save new results.

Stable to override

Parameters

int \| bool	$limit	Limit for SQL statement
bool	$ignoreErrors	Whether to ignore database errors

Exceptions

DBError|Exception

Returns: bool|int

Definition at line 336 of file QueryPage.php.

References $res, DB_MASTER, Wikimedia\Rdbms\IDatabase\delete(), SpecialPage\getName(), Wikimedia\Rdbms\IDatabase\insert(), isCacheable(), reallyDoQuery(), Wikimedia\Rdbms\IDatabase\timestamp(), usesTimestamps(), wfGetDB(), and wfTimestamp().

◆ setListoutput()

QueryPage::setListoutput ( $bool )

protected

A mutator for $this->listoutput;.

Parameters

bool $bool

Definition at line 153 of file QueryPage.php.

Referenced by WantedPagesPage\execute().

◆ showEmptyText()

QueryPage::showEmptyText ( )

protected

Outputs some kind of an informative message (via OutputPage) to let the user know that the query returned nothing and thus there's nothing to show.

Since: 1.26

Definition at line 310 of file QueryPage.php.

References SpecialPage\getOutput().

Referenced by execute().

◆ sortDescending()

QueryPage::sortDescending ( )

protected

Override to sort by increasing values.

Stable to override

Returns: bool

Reimplemented in WantedQueryPage, SpecialAncientPages, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialFewestRevisions, SpecialListRedirects, SpecialLonelyPages, SpecialLongPages, SpecialMostLinkedCategories, SpecialMostLinkedTemplates, SpecialMostRevisions, SpecialPagesWithProp, SpecialShortPages, SpecialUncategorizedImages, SpecialUncategorizedPages, SpecialUnusedCategories, SpecialUnusedImages, SpecialUnusedTemplates, SpecialUnwatchedPages, and SpecialWithoutInterwiki.

Definition at line 233 of file QueryPage.php.

Referenced by fetchFromCache(), and reallyDoQuery().

◆ usesTimestamps()

QueryPage::usesTimestamps ( )

Does this query return timestamps rather than integers in its 'value' field? If true, this class will convert 'value' to a UNIX timestamp for caching.

NOTE: formatRow() may get timestamps in TS_MW (mysql), TS_DB (pgsql) or TS_UNIX (querycache) format, so be sure to always run them through wfTimestamp() Stable to override

Returns: bool

Since: 1.18

Reimplemented in SpecialAncientPages, and SpecialUnusedImages.

Definition at line 223 of file QueryPage.php.

Referenced by recache().

Member Data Documentation

◆ $cachedTimestamp

string null QueryPage::$cachedTimestamp = null

protected

Definition at line 61 of file QueryPage.php.

Referenced by getCachedTimestamp().

◆ $limit

int QueryPage::$limit = 0

protected

Definition at line 47 of file QueryPage.php.

Referenced by execute(), fetchFromCache(), getDBLimit(), getLimitOffset(), SpecialFileDuplicateSearch\prefixSearchSubpages(), SpecialPagesWithProp\prefixSearchSubpages(), SpecialPagesWithProp\queryExistingProps(), reallyDoQuery(), and SpecialShortPages\reallyDoQuery().

◆ $listoutput

bool QueryPage::$listoutput = false

protected

Whether or not we want plain listoutput rather than an ordered list.

Definition at line 41 of file QueryPage.php.

◆ $numRows

int QueryPage::$numRows

protected

The number of rows returned by the query.

Reading this variable only makes sense in functions that are run after the query has been done, such as preprocessResults() and formatRow().

Definition at line 56 of file QueryPage.php.

Referenced by SpecialFileDuplicateSearch\execute().

◆ $offset

int QueryPage::$offset = 0

protected

The offset and limit in use, as passed to the query() function.

Definition at line 44 of file QueryPage.php.

Referenced by doQuery(), fetchFromCache(), getLimitOffset(), openList(), SpecialFileDuplicateSearch\prefixSearchSubpages(), SpecialPagesWithProp\prefixSearchSubpages(), SpecialPagesWithProp\queryExistingProps(), reallyDoQuery(), and SpecialShortPages\reallyDoQuery().

◆ $shownavigation

bool QueryPage::$shownavigation = true

protected

Whether to show prev/next links.

Definition at line 66 of file QueryPage.php.

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

includes/specialpage/QueryPage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ closeList()

◆ delete()

◆ doQuery()

◆ execute()

◆ executeLBFromResultWrapper()

◆ fetchFromCache()

◆ formatResult()

◆ getCachedTimestamp()

◆ getCacheOrderFields()

◆ getDBLimit()

◆ getDisabledQueryPages()

◆ getLimitOffset()

◆ getMaxResults()

◆ getOrderFields()

◆ getPageHeader()

◆ getPages()

◆ getQueryInfo()

◆ getRecacheDB()

◆ getSQL()

◆ isCacheable()

◆ isCached()

◆ isExpensive()

◆ isSyndicated()

◆ linkParameters()

◆ openList()

◆ outputResults()

◆ preprocessResults()

◆ reallyDoQuery()

◆ recache()

◆ setListoutput()

◆ showEmptyText()

◆ sortDescending()

◆ usesTimestamps()

Member Data Documentation

◆ $cachedTimestamp

◆ $limit

◆ $listoutput

◆ $numRows

◆ $offset

◆ $shownavigation