MediaWiki  REL1_19
ShortPagesPage Class Reference

SpecialShortpages extends QueryPage. More...

Inheritance diagram for ShortPagesPage:
Collaboration diagram for ShortPagesPage:

List of all members.

Public Member Functions

 __construct ($name= 'Shortpages')
 formatResult ($skin, $result)
 Formats the results of the query for display.
 getOrderFields ()
 Subclasses return an array of fields to order by here.
 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.
 isSyndicated ()
 Sometime we dont want to build rss / atom feeds.
 preprocessResults ($db, $res)
 sortDescending ()
 Override to sort by increasing values.

Detailed Description

SpecialShortpages extends QueryPage.

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

Definition at line 30 of file SpecialShortpages.php.


Constructor & Destructor Documentation

ShortPagesPage::__construct ( name = 'Shortpages')

Reimplemented in LongPagesPage.

Definition at line 32 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 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 80 of file SpecialShortpages.php.

References $result, $size, $title, SpecialPage\getLanguage(), QueryPage\isCached(), Linker\link(), Linker\linkKnown(), Title\makeTitle(), SpecialPage\msg(), and wfMsgHtml().

Here is the call graph for this function:

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 52 of file SpecialShortpages.php.

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 40 of file SpecialShortpages.php.

Sometime we dont want to build rss / atom feeds.

Returns:
Boolean

Reimplemented from QueryPage.

Definition at line 36 of file SpecialShortpages.php.

ShortPagesPage::preprocessResults ( db,
res 
)
Parameters:
$dbDatabaseBase
$res
Returns:
void

Reimplemented from QueryPage.

Definition at line 61 of file SpecialShortpages.php.

References $res, and QueryPage\isCached().

Here is the call graph for this function:

Override to sort by increasing values.

Returns:
Boolean

Reimplemented from QueryPage.

Reimplemented in LongPagesPage.

Definition at line 76 of file SpecialShortpages.php.


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