MediaWiki  REL1_20
DisambiguationsPage Class Reference

A special page that lists pages containing links to disambiguations pages. More...

Inheritance diagram for DisambiguationsPage:
Collaboration diagram for DisambiguationsPage:

List of all members.

Public Member Functions

 __construct ($name= 'Disambiguations')
 formatResult ($skin, $result)
 Formats the results of the query for display.
 getOrderFields ()
 Subclasses return an array of fields to order by here.
 getPageHeader ()
 The content returned by this function will be output before any result.
 getQueryFromLinkBatch ()
 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.
 isExpensive ()
 Is this query expensive (for some definition of expensive)? Then we don't let it run in miser mode.
 isSyndicated ()
 Sometime we dont want to build rss / atom feeds.
 preprocessResults ($db, $res)
 Fetch links and cache their existence.
 sortDescending ()
 Override to sort by increasing values.

Detailed Description

A special page that lists pages containing links to disambiguations pages.

Definition at line 29 of file SpecialDisambiguations.php.


Constructor & Destructor Documentation

DisambiguationsPage::__construct ( name = 'Disambiguations')

Definition at line 31 of file SpecialDisambiguations.php.


Member Function Documentation

DisambiguationsPage::formatResult ( skin,
result 
)

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:
$skinSkin
$resultobject Result row
Returns:
mixed String or false to skip
Parameters:
$skinSkin object
$resultObject: database row

Reimplemented from QueryPage.

Definition at line 145 of file SpecialDisambiguations.php.

References $result, $title, SpecialPage\getLanguage(), Linker\link(), Title\makeTitle(), SpecialPage\msg(), and Title\newFromID().

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 from QueryPage.

Definition at line 117 of file SpecialDisambiguations.php.

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

Returns:
String

Reimplemented from QueryPage.

Definition at line 43 of file SpecialDisambiguations.php.

References SpecialPage\msg().

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 from QueryPage.

Definition at line 92 of file SpecialDisambiguations.php.

References MWNamespace\getContentNamespaces(), and getQueryFromLinkBatch().

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

Definition at line 35 of file SpecialDisambiguations.php.

Sometime we dont want to build rss / atom feeds.

Returns:
Boolean

Reimplemented from QueryPage.

Definition at line 39 of file SpecialDisambiguations.php.

Fetch links and cache their existence.

Parameters:
$dbDatabaseBase
$res

Reimplemented from QueryPage.

Definition at line 131 of file SpecialDisambiguations.php.

References $res, and LinkBatch\add().

Override to sort by increasing values.

Returns:
Boolean

Reimplemented from QueryPage.

Definition at line 121 of file SpecialDisambiguations.php.


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