Table-based display with a user-selectable sort order. More...

Inheritance diagram for TablePager:

Collaboration diagram for TablePager:

Public Member Functions
	__construct (IContextSource $context=null)
	formatRow ($row)
	formatValue ($name, $value)
	Format a table cell.
	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.
	getEmptyBody ()
	Hook into getBody(), for the bit between the start and the end when there are no rows.
	getEndBody ()
	Hook into getBody() for the end of the list.
	getFieldNames ()
	An array mapping database field names to a textual description of the field name, for use in the table header.
	getHiddenFields ($blacklist=array())
	Get <input type="hidden"> elements for use in a method="get" form.
	getIndexField ()
	This function should be overridden to return the name of the index fi- eld.
	getLimitDropdown ()
	Gets a limit selection dropdown.
	getLimitForm ()
	Get a form containing a limit selection dropdown.
	getLimitSelect ()
	Get a <select> element which has options for each of the allowed limits.
	getNavClass ()
	getNavigationBar ()
	A navigation bar with images.
	getRowAttrs ($row)
	Get attributes to be applied to the given row.
	getRowClass ($row)
	Get a class name to be applied to the given row.
	getSortHeaderClass ()
	getStartBody ()
	Hook into getBody(), allows text to be inserted at the start.
	getTableClass ()
	isFieldSortable ($field)
	Return true if the named field should be sortable by the UI, false otherwise.
Public Attributes
	$mCurrentRow
	$mSort

Detailed Description

Table-based display with a user-selectable sort order.

Definition at line 836 of file Pager.php.

Constructor & Destructor Documentation

TablePager::__construct ( IContextSource $ context = null )

Reimplemented from IndexPager.

Definition at line 840 of file Pager.php.

References ContextSource\$context, getDefaultSort(), getFieldNames(), ContextSource\getRequest(), and ContextSource\setContext().

Here is the call graph for this function:

Member Function Documentation

TablePager::formatRow ( $ row )

Parameters:

$row Array

Returns:: String HTML

Reimplemented from IndexPager.

Reimplemented in AllmessagesTablePager.

Definition at line 918 of file Pager.php.

References formatValue(), getCellAttrs(), getFieldNames(), getRowAttrs(), Xml\openElement(), and Xml\tags().

Here is the call graph for this function:

TablePager::formatValue	(	$	name,
		$	value
	)		`[abstract]`

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:

$name	String: the database field name
$value	String: the value retrieved from the database

Reimplemented in AllmessagesTablePager, BlockListPager, and ImageListPager.

Referenced by formatRow().

Here is the caller graph for this function:

TablePager::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	String The column
$value	String The cell contents

Returns:: Array of attr => value

Reimplemented in AllmessagesTablePager.

Definition at line 969 of file Pager.php.

Referenced by formatRow().

Here is the caller graph for this function:

TablePager::getDefaultSort ( ) [abstract]

The database field name used as a default sort order.

Reimplemented in AllmessagesTablePager, BlockListPager, and ImageListPager.

Referenced by __construct().

Here is the caller graph for this function:

TablePager::getEmptyBody ( )

Hook into getBody(), for the bit between the start and the end when there are no rows.

Returns:: String

Reimplemented from IndexPager.

Definition at line 908 of file Pager.php.

References getFieldNames(), and wfMsgHtml().

Here is the call graph for this function:

TablePager::getEndBody ( )

Hook into getBody() for the end of the list.

Returns:: String

Reimplemented from IndexPager.

Definition at line 904 of file Pager.php.

TablePager::getFieldNames ( ) [abstract]

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 in AllmessagesTablePager, BlockListPager, and ImageListPager.

Referenced by __construct(), formatRow(), getEmptyBody(), and getStartBody().

Here is the caller graph for this function:

TablePager::getHiddenFields ( $ blacklist = array() )

Get <input type="hidden"> elements for use in a method="get" form.

Resubmits all defined elements of the query string, except for a blacklist, passed in the $blacklist parameter.

Parameters:

$blacklist Array parameters from the request query which should not be resubmitted

Returns:: String: HTML fragment

Definition at line 1082 of file Pager.php.

References ContextSource\getRequest().

Referenced by AllmessagesTablePager\buildForm(), ImageListPager\getForm(), and getLimitDropdown().

Here is the call graph for this function:

Here is the caller graph for this function:

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