AllmessagesTablePager Class Reference

Inherits TablePager.

List of all members.

Public Member Functions

 __construct ($page, $conds, $langObj=null)
 getAllMessages ($descending)
 getCustomisedStatuses ($messageNames)
 Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.
 reallyDoQuery ($offset, $limit, $descending)
 Do a query with specified parameters, rather than using the object context.
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start.
 formatValue ($field, $value)
 Format a table cell.
 formatRow ($row)
 Abstract formatting function.
 getRowAttrs ($row, $isSecond=false)
 getCellAttrs ($field, $value)
 Get any extra attributes to be applied to the given cell.
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header.
 getTitle ()
 Title used for self-links.
 isFieldSortable ($x)
 Return true if the named field should be sortable by the UI, false otherwise.
 getDefaultSort ()
 The database field name used as a default sort order.
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query.

Public Attributes

 $mLimitsShown


Detailed Description

Definition at line 127 of file SpecialAllmessages.php.


Constructor & Destructor Documentation

AllmessagesTablePager::__construct ( page,
conds,
langObj = null 
)


Member Function Documentation

AllmessagesTablePager::formatRow ( row  ) 

Abstract formatting function.

This should return an HTML string representing the result row $row. Rows will be concatenated and returned by getBody()

Reimplemented from TablePager.

Definition at line 321 of file SpecialAllmessages.php.

References $s, formatValue(), getCellAttrs(), getRowAttrs(), Xml::openElement(), and Xml::tags().

AllmessagesTablePager::formatValue ( name,
value 
)

Format a table cell.

The return value should be HTML, but use an empty string not   for empty cells. Do not include the

and .

The current result row is available as $this->mCurrentRow, in case you need more context.

Parameters:
string $name The database field name
string $value The value retrieved from the database

Reimplemented from TablePager.

Definition at line 280 of file SpecialAllmessages.php.

References $title, $wgLang, Sanitizer::escapeHtmlAllowEntities(), and Title::makeTitle().

Referenced by formatRow().

AllmessagesTablePager::getAllMessages ( descending  ) 

Definition at line 174 of file SpecialAllmessages.php.

References Language::getLocalisationCache(), and wfProfileIn().

Referenced by reallyDoQuery().

AllmessagesTablePager::getCellAttrs ( field,
value 
)

Get any extra attributes to be applied to the given cell.

Don't take this as an excuse to hardcode styles; use classes and CSS instead. Row context is available in $this->mCurrentRow

Parameters:
$field The column
$value The cell contents
Returns:
associative array

Reimplemented from TablePager.

Definition at line 350 of file SpecialAllmessages.php.

Referenced by formatRow().

AllmessagesTablePager::getCustomisedStatuses ( messageNames  ) 

Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Returns array( 'pages' => ..., 'talks' => ... ), where the subarrays have an entry for each existing page, with the key being the message name and value arbitrary.

Definition at line 196 of file SpecialAllmessages.php.

References $dbr, $res, $s, $title, wfGetDB(), wfProfileIn(), and wfProfileOut().

Referenced by reallyDoQuery().

AllmessagesTablePager::getDefaultSort (  ) 

The database field name used as a default sort order.

Reimplemented from TablePager.

Definition at line 371 of file SpecialAllmessages.php.

AllmessagesTablePager::getFieldNames (  ) 

An array mapping database field names to a textual description of the field name, for use in the table header.

The description should be plain text, it will be HTML-escaped later.

Reimplemented from TablePager.

Definition at line 359 of file SpecialAllmessages.php.

References wfMsg().

AllmessagesTablePager::getQueryInfo (  ) 

This function should be overridden to provide all parameters needed for the main paged query.

It returns an associative array with the following elements: tables => Table(s) for passing to Database::select() fields => Field(s) for passing to Database::select(), may be * conds => WHERE conditions options => option array join_conds => JOIN conditions

Reimplemented from IndexPager.

Definition at line 374 of file SpecialAllmessages.php.

AllmessagesTablePager::getRowAttrs ( row,
isSecond = false 
)

Definition at line 338 of file SpecialAllmessages.php.

References $wgLang, and Sanitizer::escapeId().

Referenced by formatRow().

AllmessagesTablePager::getStartBody (  ) 

Hook into getBody(), allows text to be inserted at the start.

This will be called even if there are no rows in the result set.

Reimplemented from TablePager.

Definition at line 263 of file SpecialAllmessages.php.

References Xml::openElement(), and wfMsg().

AllmessagesTablePager::getTitle (  ) 

Title used for self-links.

Override this if you want to be able to use a title other than $wgTitle

Reimplemented from IndexPager.

Definition at line 365 of file SpecialAllmessages.php.

References SpecialPage::getTitleFor().

AllmessagesTablePager::isFieldSortable ( field  ) 

Return true if the named field should be sortable by the UI, false otherwise.

Parameters:
string $field

Reimplemented from TablePager.

Definition at line 368 of file SpecialAllmessages.php.

AllmessagesTablePager::reallyDoQuery ( offset,
limit,
descending 
)

Do a query with specified parameters, rather than using the object context.

Parameters:
string $offset Index offset, inclusive
integer $limit Exact query limit
boolean $descending Query direction, false for ascending, true for descending
Returns:
ResultWrapper

Reimplemented from IndexPager.

Definition at line 236 of file SpecialAllmessages.php.

References $result, getAllMessages(), getCustomisedStatuses(), and wfMsgGetKey().


Member Data Documentation

AllmessagesTablePager::$mLimitsShown

Reimplemented from IndexPager.

Definition at line 129 of file SpecialAllmessages.php.


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

Generated on Sat Apr 30 22:57:30 2011 for MediaWiki by  doxygen 1.5.9