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.
	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.
Public Attributes
	$limit = 0
bool	$listoutput = false
	Whether or not we want plain listoutput rather than an ordered list.
integer	$offset = 0
	The offset and limit in use, as passed to the query() function.
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
	$numRows
	The number of rows returned by the query.
	$shownavigation = true
	Wheter 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 81 of file QueryPage.php.

Member Function Documentation

QueryPage::closeList ( )

Returns:: string

Definition at line 630 of file QueryPage.php.

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

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

Returns:: bool

Definition at line 643 of file QueryPage.php.

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

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

Returns:: ResultWrapper

Reimplemented in LinkSearchPage.

Definition at line 400 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.

Returns:: int

Reimplemented from SpecialPage.

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

Definition at line 454 of file QueryPage.php.

QueryPage::feedDesc ( )

Definition at line 722 of file QueryPage.php.

QueryPage::feedItemAuthor ( $ row )

Definition at line 712 of file QueryPage.php.

QueryPage::feedItemDesc ( $ row )

Definition at line 708 of file QueryPage.php.

QueryPage::feedResult ( $ row )

Override for custom handling.

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

Returns:: FeedItem|null

Definition at line 683 of file QueryPage.php.

QueryPage::feedTitle ( )

Definition at line 716 of file QueryPage.php.

QueryPage::feedUrl ( )

Definition at line 726 of file QueryPage.php.

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

Fetch the query results from the query cache.

Parameters:

$limit	mixed Numerical limit or false for no limit
$offset	mixed Numerical offset or false for no offset

Returns:: ResultWrapper

Since:: 1.18

Definition at line 415 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
$result	object Result row

Returns:: mixed String or false to skip

Parameters:

$skin	Skin object
$result	Object: database row

Reimplemented in WantedQueryPage, FileDuplicateSearchPage, LinkSearchPage, DisambiguationsPage, SpecialPagesWithProp, DoubleRedirectsPage, ListredirectsPage, MostlinkedTemplatesPage, MostinterwikisPage, BrokenRedirectsPage, MostlinkedPage, MIMEsearchPage, MostcategoriesPage, ShortPagesPage, MostlinkedCategoriesPage, UnwatchedpagesPage, FewestrevisionsPage, UnusedtemplatesPage, ImageQueryPage, AncientPagesPage, UnusedCategoriesPage, PopularPagesPage, WantedCategoriesPage, UncategorizedCategoriesPage, and PageQueryPage.

QueryPage::getCachedTimestamp ( )

Definition at line 439 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, DisambiguationsPage, DoubleRedirectsPage, BrokenRedirectsPage, DeadendPagesPage, LonelyPagesPage, ListredirectsPage, WithoutInterwikiPage, UnwatchedpagesPage, UncategorizedPagesPage, and ShortPagesPage.

Definition at line 166 of file QueryPage.php.

QueryPage::getPageHeader ( )

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

Returns:: String

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

Definition at line 256 of file QueryPage.php.

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, DoubleRedirectsPage, SpecialPagesWithProp, DisambiguationsPage, FileDuplicateSearchPage, WithoutInterwikiPage, WantedFilesPage, MostlinkedTemplatesPage, DeadendPagesPage, WantedPagesPage, MIMEsearchPage, BrokenRedirectsPage, LonelyPagesPage, UnusedtemplatesPage, ListredirectsPage, UncategorizedImagesPage, UncategorizedPagesPage, MostlinkedPage, MostcategoriesPage, MostimagesPage, MostinterwikisPage, UnusedimagesPage, UnwatchedpagesPage, FewestrevisionsPage, PopularPagesPage, AncientPagesPage, MostlinkedCategoriesPage, UnusedCategoriesPage, ShortPagesPage, WantedTemplatesPage, and WantedCategoriesPage.

Definition at line 144 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 154 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:: Boolean

Since:: 1.18

Reimplemented in FileDuplicateSearchPage, MIMEsearchPage, LinkSearchPage, and SpecialPagesWithProp.

Definition at line 212 of file QueryPage.php.

QueryPage::isCached ( )

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

Returns:: Boolean

Reimplemented from SpecialPage.

Reimplemented in FileDuplicateSearchPage.

Definition at line 222 of file QueryPage.php.

Referenced by WantedCategoriesPage\formatResult(), ShortPagesPage\formatResult(), MostcategoriesPage\formatResult(), MostinterwikisPage\formatResult(), WithoutInterwikiPage\getPageHeader(), 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:: Boolean

Reimplemented from SpecialPage.

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

Definition at line 200 of file QueryPage.php.

QueryPage::isSyndicated ( )

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

Returns:: Boolean

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

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

QueryPage::openList ( $ offset )

Parameters:

$offset

Returns:: string

Definition at line 623 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:

$out	OutputPage to print to
$skin	Skin: user skin to use
$dbr	Database (read) connection to use
$res	Integer: result pointer
$num	Integer: number of available result rows
$offset	Integer: paging offset

Reimplemented in ImageQueryPage.

Definition at line 570 of file QueryPage.php.

QueryPage::preprocessResults	(	$	db,
		$	res
	)

Do any necessary preprocessing of the result object.

Reimplemented in WantedQueryPage, DisambiguationsPage, MostlinkedTemplatesPage, ListredirectsPage, MostinterwikisPage, MostlinkedPage, MostcategoriesPage, ShortPagesPage, and MostlinkedCategoriesPage.

Definition at line 637 of file QueryPage.php.

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

Run the query and return the result.

Parameters:

$limit	mixed Numerical limit or false for no limit
$offset	mixed Numerical offset or false for no offset

Returns:: ResultWrapper

Since:: 1.18

Definition at line 357 of file QueryPage.php.

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

Clear the cache and save new results.

Parameters:

$limit	Integer: limit for SQL statement
$ignoreErrors	Boolean: whether to ignore database errors

Returns:: bool|int

Definition at line 290 of file QueryPage.php.

QueryPage::setListoutput ( $ bool )

A mutator for $this->listoutput;.

Parameters:

$bool Boolean

Definition at line 114 of file QueryPage.php.

Referenced by WantedPagesPage\execute().

QueryPage::sortDescending ( )

Override to sort by increasing values.

Returns:: Boolean

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

Definition at line 189 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 279 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 180 of file QueryPage.php.

Member Data Documentation

QueryPage::$cachedTimestamp = null [protected]

Definition at line 102 of file QueryPage.php.

QueryPage::$limit = 0

Definition at line 93 of file QueryPage.php.

Referenced by LinkSearchPage\doQuery().

bool QueryPage::$listoutput = false

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

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

Referenced by FileDuplicateSearchPage\execute().

integer QueryPage::$offset = 0

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

Definition at line 92 of file QueryPage.php.

Referenced by LinkSearchPage\doQuery().

QueryPage::$shownavigation = true [protected]

Wheter to show prev/next links.

Definition at line 107 of file QueryPage.php.

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

includes/QueryPage.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Function Documentation

Member Data Documentation