MediaWiki  REL1_21
SpecialPagesWithProp Class Reference

Special:PagesWithProp to search the page_props table. More...

Inheritance diagram for SpecialPagesWithProp:
Collaboration diagram for SpecialPagesWithProp:

List of all members.

Public Member Functions

 __construct ($name= 'PagesWithProp')
 execute ($par)
 This is the actual workhorse.
 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.
 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.
 isSyndicated ()
 Disable RSS/Atom feeds.
 onSubmit ($data, $form)

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

Private Attributes

 $propName = null

Detailed Description

Special:PagesWithProp to search the page_props table.

Since:
1.21

Definition at line 32 of file SpecialPagesWithProp.php.


Constructor & Destructor Documentation

SpecialPagesWithProp::__construct ( name = 'PagesWithProp')

Definition at line 35 of file SpecialPagesWithProp.php.

References $name.


Member Function Documentation

This is the actual workhorse.

It does everything needed to make a real, honest-to-gosh query page.

Returns:
int

Reimplemented from QueryPage.

Definition at line 43 of file SpecialPagesWithProp.php.

References $dbr, $form, $res, array(), as, SpecialPage\getContext(), SpecialPage\getRequest(), SpecialPage\getTitle(), SpecialPage\msg(), SpecialPage\outputHeader(), SpecialPage\setHeaders(), and wfGetDB().

Referenced by onSubmit().

SpecialPagesWithProp::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 123 of file SpecialPagesWithProp.php.

References $result, $ret, $title, $value, array(), Linker\link(), SpecialPage\msg(), Title\newFromRow(), and Xml\span().

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 135 of file SpecialPagesWithProp.php.

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 119 of file SpecialPagesWithProp.php.

References array().

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 99 of file SpecialPagesWithProp.php.

References array().

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

Definition at line 39 of file SpecialPagesWithProp.php.

Disable RSS/Atom feeds.

Returns:
bool

Reimplemented from QueryPage.

Definition at line 95 of file SpecialPagesWithProp.php.

SpecialPagesWithProp::onSubmit ( data,
form 
)

Definition at line 86 of file SpecialPagesWithProp.php.

References execute().


Member Data Documentation

SpecialPagesWithProp::$propName = null [private]

Definition at line 33 of file SpecialPagesWithProp.php.


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