MediaWiki  REL1_19
Public Member Functions | Protected Attributes
BlockListPager Class Reference
Inheritance diagram for BlockListPager:
Inheritance graph
[legend]
Collaboration diagram for BlockListPager:
Collaboration graph
[legend]

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 ()
 This function should be overridden to return the name of the index fi- eld.
 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 210 of file SpecialBlockList.php.

Constructor & Destructor Documentation

BlockListPager::__construct ( $  page,
$  conds 
)
Parameters:
$pageSpecialPage
$condsArray

Definition at line 218 of file SpecialBlockList.php.

References $conds, 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.

Parameters:
$nameString: the database field name
$valueString: the value retrieved from the database

Reimplemented from TablePager.

Definition at line 245 of file SpecialBlockList.php.

References Linker\commentBlock(), ContextSource\getLanguage(), SpecialPage\getTitleFor(), ContextSource\getUser(), Linker\linkKnown(), ContextSource\msg(), Block\parseTarget(), Html\rawElement(), Linker\TOOL_LINKS_NOBLOCK, Block\TYPE_IP, Block\TYPE_RANGE, Block\TYPE_USER, Linker\userLink(), and Linker\userToolLinks().

Here is the call graph for this function:

BlockListPager::getDefaultSort ( )

The database field name used as a default sort order.

Reimplemented from TablePager.

Definition at line 409 of file SpecialBlockList.php.

BlockListPager::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.

Returns:
Array

Reimplemented from TablePager.

Definition at line 225 of file SpecialBlockList.php.

References ContextSource\msg().

Here is the call graph for this function:

BlockListPager::getIndexField ( )

This function should be overridden to return the name of the index fi- eld.

If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &count=querykey will use indexfield to sort. In this case, the first returned key is the default.

Needless to say, it's really not a good idea to use a non-unique index for this! That won't page right.

Returns:
string|Array

Reimplemented from TablePager.

Definition at line 405 of file SpecialBlockList.php.

BlockListPager::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

Returns:
Array

Reimplemented from IndexPager.

Definition at line 366 of file SpecialBlockList.php.

References ContextSource\getUser().

Here is the call graph for this function:

BlockListPager::getTableClass ( )

Reimplemented from TablePager.

Definition at line 401 of file SpecialBlockList.php.

BlockListPager::isFieldSortable ( $  field)

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

Parameters:
$fieldString

Reimplemented from TablePager.

Definition at line 413 of file SpecialBlockList.php.

BlockListPager::preprocessResults ( $  result)

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

Parameters:
$result

Reimplemented from IndexPager.

Definition at line 421 of file SpecialBlockList.php.

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

Here is the call graph for this function:

Member Data Documentation

BlockListPager::$conds [protected]

Definition at line 211 of file SpecialBlockList.php.

Referenced by __construct().

BlockListPager::$page [protected]

Definition at line 212 of file SpecialBlockList.php.

Referenced by __construct().

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