TablePager Class Reference
[Pager]

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

Inherits IndexPager.

Inherited by ImageListPager.

List of all members.

Public Member Functions

 __construct ()
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start.
 getEndBody ()
 Hook into getBody() for the end of the list.
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows.
 formatRow ($row)
 Abstract formatting function.
 getRowClass ($row)
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld.
 getTableClass ()
 getNavClass ()
 getSortHeaderClass ()
 getNavigationBar ()
 A navigation bar with images.
 getLimitSelect ()
 Get a <select> element which has options for each of the allowed limits.
 getHiddenFields ($blacklist=array())
 Get <input type="hidden"> elements for use in a method="get" form.
 getLimitForm ()
 Get a form containing a limit selection dropdown.
 isFieldSortable ($field)
 Return true if the named field should be sortable by the UI, false otherwise.
 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.

Public Attributes

 $mSort
 $mCurrentRow


Detailed Description

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

Definition at line 672 of file Pager.php.


Constructor & Destructor Documentation

TablePager::__construct (  ) 

Reimplemented from IndexPager.

Reimplemented in ImageListPager.

Definition at line 676 of file Pager.php.

References $wgRequest, getDefaultSort(), and getFieldNames().


Member Function Documentation

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

Definition at line 747 of file Pager.php.

References $name, $row, $s, formatValue(), getFieldNames(), and getRowClass().

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:
string $name The database field name
string $value The value retrieved from the database

Reimplemented in ImageListPager.

Referenced by formatRow().

TablePager::getDefaultSort (  )  [abstract]

The database field name used as a default sort order.

Reimplemented in ImageListPager.

Referenced by __construct().

TablePager::getEmptyBody (  ) 

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

Reimplemented from IndexPager.

Definition at line 741 of file Pager.php.

References getFieldNames(), and wfMsgHtml().

TablePager::getEndBody (  ) 

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

Reimplemented from IndexPager.

Definition at line 737 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.

Reimplemented in ImageListPager.

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

TablePager::getHiddenFields ( blacklist = array()  ) 

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

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

Definition at line 849 of file Pager.php.

References $name, and $s.

Referenced by ImageListPager::getForm(), and getLimitForm().

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.

Reimplemented from IndexPager.

Definition at line 769 of file Pager.php.

TablePager::getLimitForm (  ) 

Get a form containing a limit selection dropdown.

Definition at line 867 of file Pager.php.

References $url, getHiddenFields(), getLimitSelect(), IndexPager::getTitle(), and wfMsgHtml().

TablePager::getLimitSelect (  ) 

Get a <select> element which has options for each of the allowed limits.

Definition at line 832 of file Pager.php.

References $s, and $wgLang.

Referenced by ImageListPager::getForm(), and getLimitForm().

TablePager::getNavClass (  ) 

Reimplemented in ImageListPager.

Definition at line 777 of file Pager.php.

Referenced by getNavigationBar().

TablePager::getNavigationBar (  ) 

A navigation bar with images.

Implements Pager.

Definition at line 788 of file Pager.php.

References $path, $s, $type, $wgContLang, $wgStylePath, getNavClass(), IndexPager::getPagingLinks(), and wfMsgHtml().

TablePager::getRowClass ( row  ) 

Definition at line 765 of file Pager.php.

Referenced by formatRow().

TablePager::getSortHeaderClass (  ) 

Reimplemented in ImageListPager.

Definition at line 781 of file Pager.php.

Referenced by getStartBody().

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

Reimplemented in ImageListPager.

Definition at line 691 of file Pager.php.

References $fields, $name, $s, $wgStylePath, getFieldNames(), getSortHeaderClass(), getTableClass(), isFieldSortable(), IndexPager::makeLink(), and wfMsg().

TablePager::getTableClass (  ) 

Reimplemented in ImageListPager.

Definition at line 773 of file Pager.php.

Referenced by getStartBody().

TablePager::isFieldSortable ( field  )  [abstract]

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

Parameters:
string $field

Reimplemented in ImageListPager.

Referenced by getStartBody().


Member Data Documentation

TablePager::$mCurrentRow

Definition at line 674 of file Pager.php.

TablePager::$mSort

Definition at line 673 of file Pager.php.


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

Generated on Sat Sep 5 02:08:48 2009 for MediaWiki by  doxygen 1.5.9