MediaWiki  REL1_22
AllmessagesTablePager Class Reference

Use TablePager for prettified output. More...

Inheritance diagram for AllmessagesTablePager:
Collaboration diagram for AllmessagesTablePager:

List of all members.

Public Member Functions

 __construct ($page, $conds, $langObj=null)
 buildForm ()
 formatRow ($row)
 formatValue ($field, $value)
 Format a table cell.
 getAllMessages ($descending)
 getCellAttrs ($field, $value)
 Get any extra attributes to be applied to the given cell.
 getDefaultSort ()
 The database field name used as a default sort order.
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header.
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query.
 getRowAttrs ($row, $isSecond=false)
 getStartBody ()
 getTitle ()
 Get the Title object.
 isFieldSortable ($x)
 Return true if the named field should be sortable by the UI, false otherwise.
 reallyDoQuery ($offset, $limit, $descending)
 This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.

Static Public Member Functions

static getCustomisedStatuses ($messageNames, $langcode= 'en', $foreign=false)
 Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Public Attributes

null bool $custom
 $displayPrefix
Language $lang
 $langcode
 $mLimitsShown
 $prefix

Protected Attributes

 $filter

Detailed Description

Use TablePager for prettified output.

We have to pretend that we're getting data from a table when in fact not all of it comes from the database.

Definition at line 87 of file SpecialAllmessages.php.


Constructor & Destructor Documentation

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

Definition at line 100 of file SpecialAllmessages.php.


Member Function Documentation

Access:
protected
Parameters:
stdClass$row
Returns:
String HTML

Reimplemented from TablePager.

Definition at line 378 of file SpecialAllmessages.php.

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.

Access:
protected
Parameters:
string$namethe database field name
string$valuethe value retrieved from the database

Reimplemented from TablePager.

Definition at line 340 of file SpecialAllmessages.php.

Definition at line 215 of file SpecialAllmessages.php.

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

Access:
protected
Parameters:
string$fieldThe column
string$valueThe cell contents
Returns:
Array of attr => value

Reimplemented from TablePager.

Definition at line 408 of file SpecialAllmessages.php.

static AllmessagesTablePager::getCustomisedStatuses ( messageNames,
langcode = 'en',
foreign = false 
) [static]

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.

Parameters:
array$messageNames
string$langcodeWhat language code
bool$foreignWhether the $langcode is not the content language
Returns:
array: a 'pages' and 'talks' array with the keys of existing pages

Definition at line 243 of file SpecialAllmessages.php.

Referenced by ApiQueryAllMessages\execute(), and DeleteEqualMessages\fetchMessageInfo().

The database field name used as a default sort order.

Access:
protected
Returns:
string

Reimplemented from TablePager.

Definition at line 434 of file SpecialAllmessages.php.

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.

Returns:
Array

Reimplemented from TablePager.

Definition at line 419 of file SpecialAllmessages.php.

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

Returns:
Array

Reimplemented from IndexPager.

Definition at line 438 of file SpecialAllmessages.php.

AllmessagesTablePager::getRowAttrs ( row,
isSecond = false 
)

Definition at line 396 of file SpecialAllmessages.php.

Access:
protected
Returns:
string

Reimplemented from TablePager.

Definition at line 323 of file SpecialAllmessages.php.

Get the Title object.

Since:
1.18
Returns:
Title

Reimplemented from ContextSource.

Definition at line 426 of file SpecialAllmessages.php.

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

Parameters:
$fieldString

Reimplemented from TablePager.

Definition at line 430 of file SpecialAllmessages.php.

AllmessagesTablePager::reallyDoQuery ( offset,
limit,
descending 
)

This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.

Parameters:
string$offset
int$limit
bool$descending
Returns:
FakeResultWrapper

Reimplemented from IndexPager.

Definition at line 290 of file SpecialAllmessages.php.


Member Data Documentation

null bool AllmessagesTablePager::$custom

Definition at line 98 of file SpecialAllmessages.php.

AllmessagesTablePager::$displayPrefix

Definition at line 88 of file SpecialAllmessages.php.

AllmessagesTablePager::$filter [protected]

Definition at line 88 of file SpecialAllmessages.php.

Language AllmessagesTablePager::$lang

Definition at line 94 of file SpecialAllmessages.php.

AllmessagesTablePager::$langcode

Definition at line 88 of file SpecialAllmessages.php.

AllmessagesTablePager::$mLimitsShown

Reimplemented from IndexPager.

Definition at line 90 of file SpecialAllmessages.php.

AllmessagesTablePager::$prefix

Definition at line 88 of file SpecialAllmessages.php.


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