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]

List of all members.

Public Member Functions
	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.
	formatResult ($skin, $result)
	Formats the results of the query for display.
	getCachedTimestamp ()
	getOrderFields ()
	Subclasses return an array of fields to order by here.
	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.
	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.
	linkParameters ()
	If using extra form wheely-dealies, return a set of parameters here as an associative array.
	openList ($offset)
	preprocessResults ($db, $res)
	Do any necessary preprocessing of the result object.
	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;.
	sortDescending ()
	Override to sort by increasing values.
	tryLastResult ()
	Some special pages (for example SpecialListusers) 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.
Static Public Member Functions
static	getPages ()
	Get a list of query page classes and their associated special pages, for periodic updates.
Protected Member Functions
	outputResults ($out, $skin, $dbr, $res, $num, $offset)
	Format and output report results using the given information plus OutputPage.
Protected Attributes
	$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.

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.

Definition at line 30 of file QueryPage.php.

Member Function Documentation

QueryPage::closeList ( )

Returns:: string

Definition at line 648 of file QueryPage.php.

QueryPage::doFeed	(	$	class = `''`,
		$	limit = `50`
	)

Similar to above, but packaging in a syndicated feed instead of a web page.

Parameters:

string	$class
int	$limit

Returns:: bool

Definition at line 666 of file QueryPage.php.

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

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

Parameters:

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

Returns:: ResultWrapper

Reimplemented in LinkSearchPage.

Definition at line 415 of file QueryPage.php.

QueryPage::execute ( $ par )

This is the actual workhorse.

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

Parameters:

string $par

Reimplemented from SpecialPage.

Reimplemented in MIMEsearchPage, FileDuplicateSearchPage, LinkSearchPage, UnwatchedpagesPage, SpecialPagesWithProp, WantedPagesPage, and WithoutInterwikiPage.

Definition at line 469 of file QueryPage.php.

QueryPage::feedDesc ( )

Definition at line 744 of file QueryPage.php.

QueryPage::feedItemAuthor ( $ row )

Definition at line 733 of file QueryPage.php.

QueryPage::feedItemDesc ( $ row )

Definition at line 729 of file QueryPage.php.

QueryPage::feedResult ( $ row )

Override for custom handling.

If the titles/links are ok, just do feedItemDesc()

Parameters:

object $row

Returns:: FeedItem|null

Definition at line 704 of file QueryPage.php.

QueryPage::feedTitle ( )

Definition at line 737 of file QueryPage.php.

QueryPage::feedUrl ( )

Definition at line 748 of file QueryPage.php.

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

Fetch the query results from the query cache.

Parameters:

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

Returns:: ResultWrapper

Since:: 1.18

Definition at line 430 of file QueryPage.php.

QueryPage::formatResult	(	$	skin,
		$	result
	)		`[abstract]`

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 off of 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 MediaStatisticsPage, LinkSearchPage, FileDuplicateSearchPage, MIMEsearchPage, SpecialPagesWithProp, DoubleRedirectsPage, MostlinkedPage, ListredirectsPage, MostlinkedTemplatesPage, BrokenRedirectsPage, MostinterwikisPage, ListDuplicatedFilesPage, MostcategoriesPage, WantedCategoriesPage, ShortPagesPage, UnwatchedpagesPage, MostlinkedCategoriesPage, WantedQueryPage, FewestrevisionsPage, UnusedtemplatesPage, AncientPagesPage, UnusedCategoriesPage, ImageQueryPage, PopularPagesPage, PageQueryPage, and UncategorizedCategoriesPage.

QueryPage::getCachedTimestamp ( )

Definition at line 454 of file QueryPage.php.

QueryPage::getOrderFields ( )

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.

Returns:: array

Since:: 1.18

Reimplemented in LinkSearchPage, SpecialPagesWithProp, DoubleRedirectsPage, MIMEsearchPage, MediaStatisticsPage, BrokenRedirectsPage, LonelyPagesPage, DeadendPagesPage, UncategorizedPagesPage, WithoutInterwikiPage, UnwatchedpagesPage, ListredirectsPage, and ShortPagesPage.

Definition at line 169 of file QueryPage.php.

QueryPage::getPageHeader ( )

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

Returns:: string

Reimplemented in MIMEsearchPage, UnusedtemplatesPage, UnusedimagesPage, BrokenRedirectsPage, DoubleRedirectsPage, WithoutInterwikiPage, WantedFilesPage, UnusedCategoriesPage, DeadendPagesPage, and LonelyPagesPage.

Definition at line 253 of file QueryPage.php.

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

Definition at line 59 of file QueryPage.php.

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

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.

Returns:: array

Since:: 1.18

Reimplemented in LinkSearchPage, WantedFilesPage, DoubleRedirectsPage, SpecialPagesWithProp, FileDuplicateSearchPage, WithoutInterwikiPage, MostlinkedTemplatesPage, DeadendPagesPage, ListDuplicatedFilesPage, MediaStatisticsPage, WantedPagesPage, MIMEsearchPage, BrokenRedirectsPage, LonelyPagesPage, UncategorizedPagesPage, UnusedtemplatesPage, ListredirectsPage, UncategorizedImagesPage, MostlinkedPage, UnusedimagesPage, UnwatchedpagesPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, AncientPagesPage, FewestrevisionsPage, PopularPagesPage, MostlinkedCategoriesPage, ShortPagesPage, UnusedCategoriesPage, WantedTemplatesPage, and WantedCategoriesPage.

Definition at line 146 of file QueryPage.php.

QueryPage::getRecacheDB ( )

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

Returns:: DatabaseBase

Definition at line 353 of file QueryPage.php.

QueryPage::getSQL ( )

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

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.

Returns:: bool

Since:: 1.18

Reimplemented in LinkSearchPage, FileDuplicateSearchPage, MIMEsearchPage, and SpecialPagesWithProp.

Definition at line 214 of file QueryPage.php.

QueryPage::isCached ( )

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

Returns:: bool

Reimplemented from SpecialPage.

Reimplemented in FileDuplicateSearchPage.

Definition at line 224 of file QueryPage.php.

Referenced by WantedQueryPage\formatResult(), ShortPagesPage\formatResult(), WantedCategoriesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), WithoutInterwikiPage\getPageHeader(), WantedCategoriesPage\preprocessResults(), ShortPagesPage\preprocessResults(), MostcategoriesPage\preprocessResults(), and MostinterwikisPage\preprocessResults().

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.

Returns:: bool

Reimplemented from SpecialPage.

Reimplemented in WithoutInterwikiPage, DeadendPagesPage, LonelyPagesPage, MostlinkedTemplatesPage, UncategorizedPagesPage, UncategorizedImagesPage, MediaStatisticsPage, MostlinkedPage, UnwatchedpagesPage, ListDuplicatedFilesPage, MIMEsearchPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, UnusedtemplatesPage, ListredirectsPage, AncientPagesPage, BrokenRedirectsPage, DoubleRedirectsPage, FewestrevisionsPage, PopularPagesPage, UnusedimagesPage, UnusedCategoriesPage, and WantedQueryPage.

Definition at line 203 of file QueryPage.php.

QueryPage::isSyndicated ( )

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

Returns:: bool

Reimplemented in LinkSearchPage, SpecialPagesWithProp, WithoutInterwikiPage, MostlinkedTemplatesPage, DeadendPagesPage, LonelyPagesPage, UncategorizedPagesPage, UncategorizedImagesPage, FileDuplicateSearchPage, MostlinkedPage, UnusedimagesPage, UnwatchedpagesPage, ListDuplicatedFilesPage, MIMEsearchPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, UnusedtemplatesPage, ListredirectsPage, AncientPagesPage, BrokenRedirectsPage, DoubleRedirectsPage, FewestrevisionsPage, PopularPagesPage, MostlinkedCategoriesPage, ShortPagesPage, and WantedQueryPage.

Definition at line 233 of file QueryPage.php.

QueryPage::linkParameters ( )

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

Returns:: array

Reimplemented in LinkSearchPage, FileDuplicateSearchPage, and MIMEsearchPage.

Definition at line 264 of file QueryPage.php.

QueryPage::openList ( $ offset )

Parameters:

int $offset

Returns:: string

Definition at line 641 of file QueryPage.php.

QueryPage::outputResults	(	$	out,
		$	skin,
		$	dbr,
		$	res,
		$	num,
		$	offset
	)		`[protected]`

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

Parameters:

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

Reimplemented in MediaStatisticsPage, and ImageQueryPage.

Definition at line 586 of file QueryPage.php.

QueryPage::preprocessResults	(	$	db,
		$	res
	)

Do any necessary preprocessing of the result object.

Parameters:

DatabaseBase	$db
ResultWrapper	$res

Reimplemented in MediaStatisticsPage, MostlinkedTemplatesPage, MostlinkedPage, ListredirectsPage, ListDuplicatedFilesPage, MostinterwikisPage, MostcategoriesPage, ShortPagesPage, MostlinkedCategoriesPage, WantedCategoriesPage, WantedQueryPage, and PageQueryPage.

Definition at line 657 of file QueryPage.php.

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

Run the query and return the result.

Parameters:

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

Returns:: ResultWrapper

Since:: 1.18

Definition at line 364 of file QueryPage.php.

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

Clear the cache and save new results.

Parameters:

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

Exceptions:

DBError|Exception

Returns:: bool|int

Definition at line 288 of file QueryPage.php.

QueryPage::setListoutput ( $ bool )

A mutator for $this->listoutput;.

Parameters:

bool $bool

Definition at line 116 of file QueryPage.php.

Referenced by WantedPagesPage\execute().

QueryPage::sortDescending ( )

Override to sort by increasing values.

Returns:: bool

Reimplemented in ShortPagesPage, WithoutInterwikiPage, FewestrevisionsPage, UnwatchedpagesPage, AncientPagesPage, UnusedCategoriesPage, MostlinkedTemplatesPage, DeadendPagesPage, MostlinkedCategoriesPage, UnusedtemplatesPage, ListredirectsPage, BrokenRedirectsPage, DoubleRedirectsPage, LonelyPagesPage, UnusedimagesPage, UncategorizedPagesPage, UncategorizedImagesPage, LongPagesPage, and MostrevisionsPage.

Definition at line 192 of file QueryPage.php.

QueryPage::tryLastResult ( )

Some special pages (for example SpecialListusers) might not return the current object formatted, but return the previous one instead.

Setting this to return true will ensure formatResult() is called one more time to make sure that the very last result is formatted as well.

Returns:: bool

Definition at line 276 of file QueryPage.php.

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

Returns:: bool

Since:: 1.18

Reimplemented in UnusedimagesPage, and AncientPagesPage.

Definition at line 183 of file QueryPage.php.

Member Data Documentation

QueryPage::$cachedTimestamp = null [protected]

Definition at line 44 of file QueryPage.php.

int QueryPage::$limit = 0 [protected]

*

Definition at line 35 of file QueryPage.php.

Referenced by SpecialPagesWithProp\prefixSearchSubpages().

bool QueryPage::$listoutput = false [protected]

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

Definition at line 31 of file QueryPage.php.

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

Referenced by FileDuplicateSearchPage\execute().

int QueryPage::$offset = 0 [protected]

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

Definition at line 33 of file QueryPage.php.

QueryPage::$shownavigation = true [protected]

Whether to show prev/next links.

Definition at line 49 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

Detailed Description

Member Function Documentation

Member Data Documentation