MediaWiki  REL1_24
BlockListPager Class Reference
Inheritance diagram for BlockListPager:
Collaboration diagram for BlockListPager:

List of all members.

Public Member Functions

 __construct ($page, $conds)
 formatValue ($name, $value)
 Format a table 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.
 getIndexField ()
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query.
 getTableClass ()
 isFieldSortable ($name)
 Return true if the named field should be sortable by the UI, false otherwise.
 preprocessResults ($result)
 Do a LinkBatch query to minimise database load when generating all these links.

Protected Attributes

 $conds
 $page

Detailed Description

Definition at line 216 of file SpecialBlockList.php.


Constructor & Destructor Documentation

BlockListPager::__construct ( page,
conds 
)
Parameters:
SpecialPage$page
array$conds

Definition at line 224 of file SpecialBlockList.php.

References $conds, $page, IndexPager\DIR_DESCENDING, and page.


Member Function Documentation

BlockListPager::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 251 of file SpecialBlockList.php.

References $name, $type, $value, array(), Linker\formatComment(), ContextSource\getLanguage(), SpecialPage\getTitleFor(), ContextSource\getUser(), Linker\linkKnown(), list, ContextSource\msg(), Block\parseTarget(), Html\rawElement(), Linker\TOOL_LINKS_NOBLOCK, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, Linker\userLink(), and Linker\userToolLinks().

The database field name used as a default sort order.

Access:
protected
Returns:
string

Reimplemented from TablePager.

Definition at line 415 of file SpecialBlockList.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 231 of file SpecialBlockList.php.

References $key, array(), as, and ContextSource\msg().

Access:
protected
Returns:
string

Reimplemented from TablePager.

Definition at line 411 of file SpecialBlockList.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 372 of file SpecialBlockList.php.

References array(), and ContextSource\getUser().

Access:
protected
Returns:
string

Reimplemented from TablePager.

Definition at line 407 of file SpecialBlockList.php.

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

Parameters:
string$field

Reimplemented from TablePager.

Definition at line 419 of file SpecialBlockList.php.

Do a LinkBatch query to minimise database load when generating all these links.

Parameters:
ResultWrapper$result

Reimplemented from IndexPager.

Definition at line 427 of file SpecialBlockList.php.

References $lb, $name, $result, $user, array(), as, UserArray\newFromIDs(), wfProfileIn(), and wfProfileOut().


Member Data Documentation

BlockListPager::$conds [protected]

Definition at line 217 of file SpecialBlockList.php.

Referenced by __construct().

BlockListPager::$page [protected]

Definition at line 218 of file SpecialBlockList.php.

Referenced by __construct().


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