Base class for a "wanted" query page like WantedPages, WantedTemplates, etc. More...

Inherits MediaWiki\SpecialPage\QueryPage.

Inherited by MediaWiki\Specials\SpecialWantedCategories, MediaWiki\Specials\SpecialWantedFiles, MediaWiki\Specials\SpecialWantedPages, and MediaWiki\Specials\SpecialWantedTemplates.

Collaboration diagram for MediaWiki\SpecialPage\WantedQueryPage:

[legend]

Public Member Functions
	formatResult ( $skin, $result)
	Format an individual result.

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

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

Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage
	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.

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

	recache ( $limit, $unused=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 MediaWiki\SpecialPage\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 POST requests to this special page require write access to the wiki.

	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 canonical, unlocalized name of this special page without namespace.

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

	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', bool $alwaysRedirectToLoginPage=false)
	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)

	setSpecialPageFactory (SpecialPageFactory $specialPageFactory)

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

Protected Member Functions
	existenceCheck (Title $title)
	Does the Title currently exists.

	forceExistenceCheck ()
	Should formatResult() always check page existence, even if the results are fresh? This is a (hopefully temporary) kluge for Special:WantedFiles, which may contain false positives for files that exist e.g.

	getCacheOrderFields ()
	Also use the order fields returned by getOrderFields when fetching from the cache.

	getOrderFields ()
	Order by title for pages with the same number of links to them.

	makeWlhLink ( $title, $result)
	Make a "what links here" link for a given title.

	preprocessResults ( $db, $res)
	Cache page existence for performance.

	sortDescending ()
	Do not order descending for all order fields.

Protected Member Functions inherited from MediaWiki\SpecialPage\QueryPage
	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.

	getDatabaseProvider ()

	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.

	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.

	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.

	setDatabaseProvider (IConnectionProvider $databaseProvider)

	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.

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

	afterExecute ( $subPage)
	Gets called after.

	authorizeAction (?string $action=null)
	Utility function for authorizing an action to be performed by the special page.

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

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

Additional Inherited Members
Static Public Member Functions inherited from MediaWiki\SpecialPage\QueryPage
static	getDisabledQueryPages (Config $config)
	Get a list of disabled query pages and their 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 MediaWiki\SpecialPage\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.

Static Protected Member Functions inherited from MediaWiki\SpecialPage\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).

Protected Attributes inherited from MediaWiki\SpecialPage\QueryPage
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 MediaWiki\SpecialPage\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 as the message key for the default.

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

Detailed Description

Base class for a "wanted" query page like WantedPages, WantedTemplates, etc.

Stability: stable: to extend

Definition at line 35 of file WantedQueryPage.php.

Member Function Documentation

◆ existenceCheck()

MediaWiki\SpecialPage\WantedQueryPage::existenceCheck ( Title $title )

protected

Does the Title currently exists.

This method allows a subclass to override this check (For example, wantedfiles, would want to check if the file exists not just that a page in the file namespace exists).

This will only control if the link is crossed out. Whether or not the link is blue vs red is controlled by if the title exists.

Note: This will only be run if the page is cached (ie $wgMiserMode = true) unless forceExistenceCheck() is true.

Since: 1.24

Stability: stable: to override

Parameters

Title $title

Returns: bool

Reimplemented in MediaWiki\Specials\SpecialWantedFiles.

Definition at line 111 of file WantedQueryPage.php.

References MediaWiki\Title\Title\isKnown().

Referenced by MediaWiki\SpecialPage\WantedQueryPage\formatResult().

◆ forceExistenceCheck()

MediaWiki\SpecialPage\WantedQueryPage::forceExistenceCheck ( )

protected

Should formatResult() always check page existence, even if the results are fresh? This is a (hopefully temporary) kluge for Special:WantedFiles, which may contain false positives for files that exist e.g.

in a shared repo (bug 6220).

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Specials\SpecialWantedFiles.

Definition at line 63 of file WantedQueryPage.php.

Referenced by MediaWiki\SpecialPage\WantedQueryPage\formatResult().

◆ formatResult()

MediaWiki\SpecialPage\WantedQueryPage::formatResult	(		$skin,
			$result )

Format an individual result.

Stability: stable: to override

Parameters

Skin	$skin	Skin to use for UI elements
stdClass	$result	Result row

Returns: string

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Reimplemented in MediaWiki\Specials\SpecialWantedCategories.

Definition at line 76 of file WantedQueryPage.php.

References MediaWiki\SpecialPage\WantedQueryPage\existenceCheck(), MediaWiki\SpecialPage\WantedQueryPage\forceExistenceCheck(), MediaWiki\SpecialPage\SpecialPage\getLanguage(), MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\QueryPage\isCached(), MediaWiki\SpecialPage\WantedQueryPage\makeWlhLink(), and MediaWiki\SpecialPage\SpecialPage\msg().

◆ getCacheOrderFields()

MediaWiki\SpecialPage\WantedQueryPage::getCacheOrderFields ( )

protected

Also use the order fields returned by getOrderFields when fetching from the cache.

Stability: stable: to override

Returns: array

Since: 1.29

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 159 of file WantedQueryPage.php.

References MediaWiki\SpecialPage\WantedQueryPage\getOrderFields().

◆ getOrderFields()

MediaWiki\SpecialPage\WantedQueryPage::getOrderFields ( )

protected

Order by title for pages with the same number of links to them.

Stability: stable: to override

Returns: array

Since: 1.29

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 135 of file WantedQueryPage.php.

Referenced by MediaWiki\SpecialPage\WantedQueryPage\getCacheOrderFields().

◆ isExpensive()

MediaWiki\SpecialPage\WantedQueryPage::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 MediaWiki\SpecialPage\QueryPage.

Definition at line 36 of file WantedQueryPage.php.

◆ isSyndicated()

MediaWiki\SpecialPage\WantedQueryPage::isSyndicated ( )

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

Stability: stable: to override

Returns: bool

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 40 of file WantedQueryPage.php.

◆ makeWlhLink()

MediaWiki\SpecialPage\WantedQueryPage::makeWlhLink	(		$title,
			$result )

protected

Make a "what links here" link for a given title.

Parameters

Title	$title	Title to make the link for
stdClass	$result	Result row

Returns: string

Definition at line 122 of file WantedQueryPage.php.

References MediaWiki\SpecialPage\SpecialPage\getLinkRenderer(), MediaWiki\SpecialPage\SpecialPage\getTitleFor(), and MediaWiki\SpecialPage\SpecialPage\msg().

Referenced by MediaWiki\SpecialPage\WantedQueryPage\formatResult().

◆ preprocessResults()

MediaWiki\SpecialPage\WantedQueryPage::preprocessResults	(		$db,
			$res )

protected

Cache page existence for performance.

Stability: stable: to override

Parameters

IDatabase	$db
IResultWrapper	$res

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Reimplemented in MediaWiki\Specials\SpecialWantedCategories.

Definition at line 50 of file WantedQueryPage.php.

References MediaWiki\SpecialPage\QueryPage\executeLBFromResultWrapper().

◆ sortDescending()

MediaWiki\SpecialPage\WantedQueryPage::sortDescending ( )

protected

Do not order descending for all order fields.

We will use DESC only on one field, see getOrderFields above. This overwrites sortDescending from QueryPage::getOrderFields(). Do NOT change this to true unless you remove the phrase DESC in getOrderFields above. If you do a database error will be thrown due to double adding DESC to query!

Stability: stable: to override

Returns: bool

Since: 1.29

Reimplemented from MediaWiki\SpecialPage\QueryPage.

Definition at line 149 of file WantedQueryPage.php.

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

includes/specialpage/WantedQueryPage.php

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ existenceCheck()

◆ forceExistenceCheck()

◆ formatResult()

◆ getCacheOrderFields()

◆ getOrderFields()

◆ isExpensive()

◆ isSyndicated()

◆ makeWlhLink()

◆ preprocessResults()

◆ sortDescending()