WantedQueryPage Class Reference

Class definition for a wanted query page like WantedPages, WantedTemplates, etc. More...

Inheritance diagram for WantedQueryPage:

Collaboration diagram for WantedQueryPage:

Public Member Functions
	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.
	formatResult ( $skin, $result)
	Format an individual result.
	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.
	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.
	preprocessResults ( $db, $res)
	Cache page existence for performance.
	sortDescending ()
	Do not order descending for all order fields.
Public Member Functions inherited from QueryPage
	closeList ()
	doFeed ( $class='', $limit=50)
	Similar to above, but packaging in a syndicated feed instead of a web page.
	doQuery ( $offset=false, $limit=false)
	Somewhat deprecated, you probably want to be using execute()
	execute ( $par)
	This is the actual workhorse.
	feedDesc ()
	feedItemAuthor ( $row)
	feedItemDesc ( $row)
	feedResult ( $row)
	Override for custom handling.
	feedTitle ()
	feedUrl ()
	fetchFromCache ( $limit, $offset=false)
	Fetch the query results from the query cache.
	getCachedTimestamp ()
	getPageHeader ()
	The content returned by this function will be output before any result.
	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.
	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.
	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.
	linkParameters ()
	If using extra form wheely-dealies, return a set of parameters here as an associative array.
	openList ( $offset)
	reallyDoQuery ( $limit, $offset=false)
	Run the query and return the result.
	recache ( $limit, $ignoreErrors=true)
	Clear the cache and save new results.
	setListoutput ( $bool)
	A mutator for $this->listoutput;.
	tryLastResult ()
	Some special pages (for example SpecialListusers used to) might not return the current object formatted, but return the previous one instead.
	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.
	displayRestrictionError ()
	Output an error message telling the user what access level they have to have.
	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.
	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.
	getTitle ( $subpage=false)
	Get a self-referential title object.
	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)
	Wrapper around wfMessage that sets the current context.
	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.
	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.
	setHeaders ()
	Sets headers - this should be called from the execute() method of all derived classes!
	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).

Protected Member Functions
	existenceCheck (Title $title)
	Does the Title currently exists.
Protected Member Functions inherited from QueryPage
	executeLBFromResultWrapper (IResultWrapper $res, $ns=null)
	Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and optional the namespace field) and executes the batch.
	getDBLimit ( $uiLimit, $uiOffset)
	What is limit to fetch from DB.
	getLimitOffset ()
	Returns limit and offset, as returned by $this->getRequest()->getLimitOffset().
	getMaxResults ()
	Get max number of results we can return in miser mode.
	outputResults ( $out, $skin, $dbr, $res, $num, $offset)
	Format and output report results using the given information plus OutputPage.
	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 SpecialPage
	addFeedLinks ( $params)
	Adds RSS/atom links.
	afterExecute ( $subPage)
	Gets called after.
	beforeExecute ( $subPage)
	Gets called before.
	checkLoginSecurityLevel ( $level=null)
	Verifies that the user meets the security level, possibly reauthenticating them in the process.
	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'.
	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.
	prefixSearchString ( $search, $limit, $offset)
	Perform a regular substring search for prefixSearchSubpages.
	setReauthPostData (array $data)
	Record preserved POST data after a reauthentication.
	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed.

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

Additional Inherited Members
Static Public Member Functions inherited from QueryPage
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 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).
Protected Attributes inherited from QueryPage
	$cachedTimestamp = null
int	$limit = 0
bool	$listoutput = false
	Whether or not we want plain listoutput rather than an ordered list.
	$numRows
	The number of rows returned by the query.
int	$offset = 0
	The offset and limit in use, as passed to the query() function.
	$shownavigation = true
	Whether to show prev/next links.
Protected Attributes inherited from SpecialPage
IContextSource	$mContext
	Current request context.
	$mIncludable
	$mIncluding
	$mName
	$mRestriction

Detailed Description

Class definition for a wanted query page like WantedPages, WantedTemplates, etc.

Definition at line 32 of file WantedQueryPage.php.

Member Function Documentation

existenceCheck()

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

Parameters

Title

$title

Returns

bool

Reimplemented in WantedFilesPage.

Definition at line 108 of file WantedQueryPage.php.

Referenced by formatResult().

forceExistenceCheck()

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

in a shared repo (bug 6220).

Returns

bool

Reimplemented in WantedFilesPage.

Definition at line 58 of file WantedQueryPage.php.

Referenced by formatResult().

formatResult()

WantedQueryPage::formatResult	(		$skin,
			$result )

Format an individual result.

Parameters

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

Returns

string

Reimplemented from QueryPage.

Reimplemented in WantedCategoriesPage.

Definition at line 69 of file WantedQueryPage.php.

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

getCacheOrderFields()

WantedQueryPage::getCacheOrderFields

(

)

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

Returns

array

Since

1.29

Reimplemented from QueryPage.

Definition at line 153 of file WantedQueryPage.php.

References getOrderFields().

getOrderFields()

WantedQueryPage::getOrderFields

(

)

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

Returns

array

Since

1.29

Reimplemented from QueryPage.

Definition at line 131 of file WantedQueryPage.php.

Referenced by getCacheOrderFields().

isExpensive()

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

Returns

bool

Reimplemented from QueryPage.

Definition at line 33 of file WantedQueryPage.php.

isSyndicated()

WantedQueryPage::isSyndicated

(

)

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

Returns

bool

Reimplemented from QueryPage.

Definition at line 37 of file WantedQueryPage.php.

makeWlhLink()

WantedQueryPage::makeWlhLink ( $title, $result )

private

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

Parameters

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

Returns

string

Definition at line 119 of file WantedQueryPage.php.

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

Referenced by formatResult().

preprocessResults()

WantedQueryPage::preprocessResults	(		$db,
			$res )

Cache page existence for performance.

Parameters

IDatabase	$db
IResultWrapper	$res

Reimplemented from QueryPage.

Reimplemented in WantedCategoriesPage.

Definition at line 46 of file WantedQueryPage.php.

References $res, and QueryPage\executeLBFromResultWrapper().

sortDescending()

WantedQueryPage::sortDescending

(

)

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 getOrderFiels above. If you do a database error will be thrown due to double adding DESC to query!

Returns

bool

Since

1.29

Reimplemented from QueryPage.

Definition at line 144 of file WantedQueryPage.php.

---

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

• includes/specialpage/WantedQueryPage.php