MediaWiki  REL1_22
UnusedtemplatesPage Class Reference

A special page that lists unused templates. More...

Inheritance diagram for UnusedtemplatesPage:
Collaboration diagram for UnusedtemplatesPage:

List of all members.

Public Member Functions

 __construct ($name= 'Unusedtemplates')
 formatResult ($skin, $result)
 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.
 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.
 sortDescending ()
 Override to sort by increasing values.

Protected Member Functions

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

Detailed Description

A special page that lists unused templates.

Definition at line 32 of file SpecialUnusedtemplates.php.


Constructor & Destructor Documentation

UnusedtemplatesPage::__construct ( name = 'Unusedtemplates')

Definition at line 34 of file SpecialUnusedtemplates.php.

References $name.


Member Function Documentation

UnusedtemplatesPage::formatResult ( skin,
result 
)
Parameters:
Skin$skin
object$resultResult row
Returns:
string

Reimplemented from QueryPage.

Definition at line 70 of file SpecialUnusedtemplates.php.

References $result, $title, array(), SpecialPage\getLanguage(), SpecialPage\getTitleFor(), Linker\linkKnown(), Title\makeTitle(), and SpecialPage\msg().

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Returns:
string
Since:
1.21

Reimplemented from SpecialPage.

Definition at line 89 of file SpecialUnusedtemplates.php.

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

Returns:
string

Reimplemented from QueryPage.

Definition at line 85 of file SpecialUnusedtemplates.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 50 of file SpecialUnusedtemplates.php.

References array().

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 38 of file SpecialUnusedtemplates.php.

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

Returns:
bool

Reimplemented from QueryPage.

Definition at line 42 of file SpecialUnusedtemplates.php.

Override to sort by increasing values.

Returns:
bool

Reimplemented from QueryPage.

Definition at line 46 of file SpecialUnusedtemplates.php.


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