ShortPagesPage Class Reference
[SpecialPage]

SpecialShortpages extends QueryPage. More...

Inherits QueryPage.

Inherited by LongPagesPage.

List of all members.

Public Member Functions

 getName ()
 Subclasses return their name here.
 isExpensive ()
 This query is indexed as of 1.5.
 isSyndicated ()
 Sometime we dont want to build rss / atom feeds.
 getSQL ()
 Subclasses return an SQL query here.
 preprocessResults ($db, $res)
 Do any necessary preprocessing of the result object.
 sortDescending ()
 Override to sort by increasing values.
 formatResult ($skin, $result)
 Formats the results of the query for display.


Detailed Description

SpecialShortpages extends QueryPage.

It is used to return the shortest pages in the database.

Definition at line 12 of file SpecialShortpages.php.


Member Function Documentation

ShortPagesPage::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 return "false", the line output will be skipped.

Reimplemented from QueryPage.

Definition at line 69 of file SpecialShortpages.php.

References $result, $size, $title, $wgContLang, $wgLang, QueryPage::isCached(), Title::makeTitleSafe(), wfMsgExt(), and wfMsgHtml().

ShortPagesPage::getName (  ) 

Subclasses return their name here.

Make sure the name is also specified in SpecialPage.php and in Language.php as a language message param.

Reimplemented from QueryPage.

Reimplemented in LongPagesPage.

Definition at line 14 of file SpecialShortpages.php.

Referenced by getSQL().

ShortPagesPage::getSQL (  ) 

Subclasses return an SQL query here.

Note that the query itself should return the following four columns: 'type' (your special page's name), 'namespace', 'title', and 'value' *in that order*. '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.

Don't include an ORDER or LIMIT clause, this will be added.

Reimplemented from QueryPage.

Definition at line 29 of file SpecialShortpages.php.

References $dbr, $name, $page, $wgContentNamespaces, getName(), and wfGetDB().

ShortPagesPage::isExpensive (  ) 

This query is indexed as of 1.5.

Reimplemented from QueryPage.

Definition at line 21 of file SpecialShortpages.php.

ShortPagesPage::isSyndicated (  ) 

Sometime we dont want to build rss / atom feeds.

Reimplemented from QueryPage.

Definition at line 25 of file SpecialShortpages.php.

ShortPagesPage::preprocessResults ( db,
res 
)

Do any necessary preprocessing of the result object.

Reimplemented from QueryPage.

Definition at line 52 of file SpecialShortpages.php.

References $batch, $db, $res, $row, and QueryPage::isCached().

ShortPagesPage::sortDescending (  ) 

Override to sort by increasing values.

Reimplemented from QueryPage.

Reimplemented in LongPagesPage.

Definition at line 65 of file SpecialShortpages.php.


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

Generated on Sat Sep 5 02:08:46 2009 for MediaWiki by  doxygen 1.5.9