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.

	deleteAllCachedData ()
	Remove all cached value This is needed when the page is no longer using the cache.

	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.

	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 ()
	Should this query page only be updated offline on large wikis?

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

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

	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.

	getAssociatedNavigationLinks ()
	Return an array of strings representing page titles that are discoverable to end users via UI.

	getAuthority ()
	Shortcut to get the Authority executing this instance.

	getConfig ()
	Shortcut to get main config object.

	getContentLanguage ()
	Shortcut to get content language.

	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.

	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.

	getShortDescription (string $path='')
	Similar to getDescription but takes into account sub pages and designed for display in tabs.

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

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

	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.

	requireNamedUser ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
	If the user is not logged in or is a temporary user, throws UserNotLoggedIn.

	run ( $subPage)
	Entry point.

	setContentLanguage (Language $contentLanguage)
	Set content language.

	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.

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

	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.

static	newSearchPage (User $user)
	Get the users preferred search page.

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.

	getDBLoadBalancer ()

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

	getLinkBatchFactory ()

	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.

	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.

	setDBLoadBalancer (ILoadBalancer $loadBalancer)

	setLinkBatchFactory (LinkBatchFactory $linkBatchFactory)

	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.

	getAuthManager ()

	getCacheTTL ()

	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.

	getSpecialPageFactory ()

	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, SearchEngineFactory $searchEngineFactory=null)
	Perform a regular substring search for prefixSearchSubpages.

	setAuthManager (AuthManager $authManager)
	Set the injected AuthManager from the special page constructor.

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

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

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

Protected Attributes
string null false	$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.

bool	$mIncludable
	Whether the special page can be included in an article.

bool	$mIncluding
	Whether or not this special page is being included from an article.

string	$mName
	The canonical name of this special page Also used for the default.

string	$mRestriction
	Minimum user level required to access this page, or "" for anyone.

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.

Stability: stable: to extend

Definition at line 42 of file QueryPage.php.

Member Function Documentation

◆ closeList()

QueryPage::closeList ( )

protected

Returns: string

Definition at line 873 of file QueryPage.php.

◆ 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 468 of file QueryPage.php.

References $title.

◆ deleteAllCachedData()

QueryPage::deleteAllCachedData ( )

Remove all cached value This is needed when the page is no longer using the cache.

Since: 1.36

Definition at line 484 of file QueryPage.php.

◆ doQuery()

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

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

Parameters

int \| false	$offset
int \| false	$limit

Returns: IResultWrapper

Definition at line 566 of file QueryPage.php.

◆ execute()

QueryPage::execute ( $par )

This is the actual workhorse.

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

Stability: stable: to override

Parameters

string | null $par

Reimplemented from SpecialPage.

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

Definition at line 704 of file QueryPage.php.

References $dbr, $lang, $res, and getUser().

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

Note: Call self::setLinkBatchFactory from special page constructor when use

Parameters

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

Definition at line 898 of file QueryPage.php.

References $res.

◆ fetchFromCache()

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

Fetch the query results from the query cache.

Stability: stable: to override

Parameters

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

Returns: IResultWrapper

Since: 1.18

Definition at line 583 of file QueryPage.php.

References $dbr.

◆ 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
stdClass	$result	Result row

Returns: string|bool String or false to skip

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

◆ getCachedTimestamp()

QueryPage::getCachedTimestamp ( )

Returns: string|false

Definition at line 630 of file QueryPage.php.

References $dbr.

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

Stability: stable: to override

Returns: array

Since: 1.29

Reimplemented in WantedQueryPage.

Definition at line 623 of file QueryPage.php.

◆ 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 673 of file QueryPage.php.

◆ getDBLoadBalancer()

QueryPage::getDBLoadBalancer ( )

finalprotected

Since: 1.36

Returns: ILoadBalancer

Definition at line 924 of file QueryPage.php.

Referenced by SpecialBrokenRedirects\getQueryInfo(), SpecialLinkSearch\getQueryInfo(), SpecialMediaStatistics\getQueryInfo(), SpecialUncategorizedCategories\getQueryInfo(), SpecialUnwatchedPages\getQueryInfo(), WantedPagesPage\getQueryInfo(), SpecialWithoutInterwiki\getQueryInfo(), SpecialMIMESearch\getSuggestionsForTypes(), and SpecialPagesWithProp\queryExistingProps().

◆ 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 158 of file QueryPage.php.

References Config\get().

Referenced by 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 652 of file QueryPage.php.

References getUser().

◆ getLinkBatchFactory()

QueryPage::getLinkBatchFactory ( )

finalprotected

Since: 1.36

Returns: LinkBatchFactory

Definition at line 144 of file QueryPage.php.

◆ 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

Stability: stable: to override

Since: 1.27

Returns: int

Reimplemented in SpecialLinkSearch.

Definition at line 693 of file QueryPage.php.

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

Stability: 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 239 of file QueryPage.php.

◆ getPageHeader()

QueryPage::getPageHeader ( )

protected

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

Stability: stable: to override

Returns: string

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

Definition at line 342 of file QueryPage.php.

◆ 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: array[] List of [ string $class, string $specialPageName, ?int $limit (optional) ]. Limit defaults to $wgQueryCacheLimit if not given.

Definition at line 87 of file QueryPage.php.

References SpecialMediaStatistics\MAX_LIMIT.

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.

Stability: stable: to override

Returns: array

Since: 1.18

Reimplemented in SpecialAncientPages, SpecialBrokenRedirects, SpecialDeadendPages, SpecialDoubleRedirects, SpecialFewestRevisions, 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 213 of file QueryPage.php.

◆ getRecacheDB()

QueryPage::getRecacheDB ( )

protected

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

Stability: stable: to override

Returns: IDatabase

Definition at line 457 of file QueryPage.php.

Referenced by SpecialShortPages\reallyDoQuery().

◆ getSQL()

QueryPage::getSQL ( )

protected

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

Deprecated: since 1.39; getQueryInfo() should be overridden instead.

Exceptions

MWException

Returns: string

Definition at line 225 of file QueryPage.php.

References wfDeprecated().

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

Stability: stable: to override

Returns: bool

Since: 1.18

Reimplemented in SpecialLinkSearch, SpecialMIMESearch, and SpecialPagesWithProp.

Definition at line 300 of file QueryPage.php.

◆ isCached()

QueryPage::isCached ( )

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

Stability: stable: to override

Returns: bool

Reimplemented from SpecialPage.

Definition at line 311 of file QueryPage.php.

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

◆ isExpensive()

QueryPage::isExpensive ( )

Should this query page only be updated offline on large wikis?

If the query for this page is considered too expensive to run on-demand for large wikis (e.g. every time the special page is viewed), then implement this as returning true.

"Large wikis" are those that enable $wgMiserMode. The value of isExpensive() has no effect by default when $wgMiserMode is off.

It is expected that such large wikis, periodically run the UpdateSpecialPages maintenance script to update these query pages.

By enabling $wgDisableQueryPages, all query pages will be considered as expensive and updated offline only, even query pages that do not mark themselves as expensive.

Stability: 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 288 of file QueryPage.php.

◆ isSyndicated()

QueryPage::isSyndicated ( )

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

Stability: stable: to override

Returns: bool

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

Definition at line 321 of file QueryPage.php.

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

Stability: stable: to override

Returns: array

Reimplemented in SpecialLinkSearch, SpecialMIMESearch, and SpecialPagesWithProp.

Definition at line 365 of file QueryPage.php.

◆ openList()

QueryPage::openList ( $offset )

protected

Parameters

int $offset

Returns: string

Definition at line 866 of file QueryPage.php.

◆ outputResults()

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

protected

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

Stability: 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 832 of file QueryPage.php.

References $line, and $res.

◆ preprocessResults()

QueryPage::preprocessResults	(		$db,
			$res )

protected

Do any necessary preprocessing of the result object.

Stability: 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, SpecialUnusedTemplates, SpecialUnwatchedPages, SpecialWantedCategories, and SpecialMediaStatistics.

Definition at line 883 of file QueryPage.php.

◆ reallyDoQuery()

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

Run the query and return the result.

Stability: stable: to override

Parameters

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

Returns: IResultWrapper

Since: 1.18

Reimplemented in SpecialShortPages.

Definition at line 509 of file QueryPage.php.

References $dbr, and $res.

◆ recache()

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

Clear the cache and save new results.

Stability: stable: to override

Parameters

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

Exceptions

DBError|Exception

Returns: bool|int

Definition at line 379 of file QueryPage.php.

References $res, Wikimedia\Rdbms\IDatabase\delete(), Wikimedia\Rdbms\IDatabase\insert(), Wikimedia\Rdbms\Platform\ISQLPlatform\timestamp(), Wikimedia\Rdbms\IDatabase\upsert(), and wfTimestamp().

◆ setDBLoadBalancer()

QueryPage::setDBLoadBalancer ( ILoadBalancer $loadBalancer )

finalprotected

Since: 1.36

Parameters

ILoadBalancer $loadBalancer

Definition at line 916 of file QueryPage.php.

◆ setLinkBatchFactory()

QueryPage::setLinkBatchFactory ( LinkBatchFactory $linkBatchFactory )

finalprotected

Since: 1.36

Parameters

LinkBatchFactory $linkBatchFactory

Definition at line 136 of file QueryPage.php.

◆ setListoutput()

QueryPage::setListoutput ( $bool )

protected

A mutator for $this->listoutput;.

Parameters

bool $bool

Definition at line 182 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 353 of file QueryPage.php.

◆ sortDescending()

QueryPage::sortDescending ( )

protected

Override to sort by increasing values.

Stability: 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 264 of file QueryPage.php.

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

Stability: stable: to override

Returns: bool

Since: 1.18

Reimplemented in SpecialAncientPages, and SpecialUnusedImages.

Definition at line 254 of file QueryPage.php.

Member Data Documentation

◆ $cachedTimestamp

string null false QueryPage::$cachedTimestamp = null

protected

Definition at line 64 of file QueryPage.php.

◆ $limit

int QueryPage::$limit = 0

protected

Definition at line 50 of file QueryPage.php.

Referenced by SpecialPagesWithProp\prefixSearchSubpages(), SpecialPagesWithProp\queryExistingProps(), and SpecialShortPages\reallyDoQuery().

◆ $listoutput

bool QueryPage::$listoutput = false

protected

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

Definition at line 44 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 59 of file QueryPage.php.

◆ $offset

int QueryPage::$offset = 0

protected

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

Definition at line 47 of file QueryPage.php.

Referenced by SpecialPagesWithProp\prefixSearchSubpages(), SpecialPagesWithProp\queryExistingProps(), and SpecialShortPages\reallyDoQuery().

◆ $shownavigation

bool QueryPage::$shownavigation = true

protected

Whether to show prev/next links.

Definition at line 69 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()

◆ deleteAllCachedData()

◆ doQuery()

◆ execute()

◆ executeLBFromResultWrapper()

◆ fetchFromCache()

◆ formatResult()

◆ getCachedTimestamp()

◆ getCacheOrderFields()

◆ getDBLimit()

◆ getDBLoadBalancer()

◆ getDisabledQueryPages()

◆ getLimitOffset()

◆ getLinkBatchFactory()

◆ getMaxResults()

◆ getOrderFields()

◆ getPageHeader()

◆ getPages()

◆ getQueryInfo()

◆ getRecacheDB()

◆ getSQL()

◆ isCacheable()

◆ isCached()

◆ isExpensive()

◆ isSyndicated()

◆ linkParameters()

◆ openList()

◆ outputResults()

◆ preprocessResults()

◆ reallyDoQuery()

◆ recache()

◆ setDBLoadBalancer()

◆ setLinkBatchFactory()

◆ setListoutput()

◆ showEmptyText()

◆ sortDescending()

◆ usesTimestamps()

Member Data Documentation

◆ $cachedTimestamp

◆ $limit

◆ $listoutput

◆ $numRows

◆ $offset

◆ $shownavigation