MediaWiki  REL1_31
TablePager Class Reference

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. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getBodyOutput ()
 Get the formatted result list. More...
 
 getCellAttrs ( $field, $value)
 Get any extra attributes to be applied to the given cell. More...
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 getEmptyBody ()
 
 getEndBody ()
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getFullOutput ()
 Get the formatted result list, with navigation bars. More...
 
 getHiddenFields ( $blacklist=[])
 Get \<input type="hidden"\> elements for use in a method="get" form. More...
 
 getIndexField ()
 
 getLimitDropdown ()
 Gets a limit selection dropdown. More...
 
 getLimitForm ()
 Get a form containing a limit selection dropdown. More...
 
 getLimitSelect ( $attribs=[])
 Get a "<select>" element which has options for each of the allowed limits. More...
 
 getLimitSelectList ()
 Get a list of items to show in a "<select>" element of limits. More...
 
 getModuleStyles ()
 ResourceLoader modules that must be loaded to provide correct styling for this pager. More...
 
 getNavigationBar ()
 A navigation bar with images. More...
 
 getRowAttrs ( $row)
 Get attributes to be applied to the given row. More...
 
 getRowClass ( $row)
 Get a class name to be applied to the given row. More...
 
 getStartBody ()
 
 isFieldSortable ( $field)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
- Public Member Functions inherited from IndexPager
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, IResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getResult ()
 
 getSqlComment ()
 Get some text to go in brackets in the "function name" part of the SQL comment. More...
 
 isNavigationBarShown ()
 Returns whether to show the "navigation bar". More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 reallyDoQuery ( $offset, $limit, $descending)
 Do a query with specified parameters, rather than using the object context. More...
 
 setIncludeOffset ( $include)
 Set whether a row matching exactly the offset should be also included in the result or not. More...
 
 setLimit ( $limit)
 Set the limit from an other source than the request. More...
 
 setOffset ( $offset)
 Set the offset from an other source than the request. More...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Protected Member Functions

 getCurrentRow ()
 
 getNavClass ()
 
 getSortHeaderClass ()
 
 getTableClass ()
 
- Protected Member Functions inherited from IndexPager
 buildQueryInfo ( $offset, $limit, $descending)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. More...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getExtraSortFields ()
 This function should be overridden to return the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

 $mCurrentRow
 
 $mSort
 
- Protected Attributes inherited from IndexPager
 $mExtraSortFields
 An array of secondary columns to order by. More...
 
 $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
 $mIndexField
 The index to actually be used for ordering. More...
 
 $mLastShown
 
 $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 

Additional Inherited Members

- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Constants for the $mDefaultDirection field. More...
 
const DIR_DESCENDING = true
 

Detailed Description

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

Definition at line 28 of file TablePager.php.

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ formatRow()

TablePager::formatRow (   $row)
Access:\n protected
Parameters
stdClass$row
Returns
string HTML

Reimplemented from IndexPager.

Reimplemented in AllMessagesTablePager.

Definition at line 185 of file TablePager.php.

References $name, $s, $value, as, Html\closeElement(), formatValue(), getCellAttrs(), getFieldNames(), getRowAttrs(), Html\openElement(), and Html\rawElement().

◆ formatValue()

TablePager::formatValue (   $name,
  $value 
)
abstract

Format a table cell.

The return value should be HTML, but use an empty string not &#160; for empty cells. Do not include the

and .

The current result row is available as $this->mCurrentRow, in case you need more context.

Access:\n protected
Parameters
string$nameThe database field name
string$valueThe value retrieved from the database

Reimplemented in BlockListPager, ProtectedPagesPager, ImageListPager, and AllMessagesTablePager.

Referenced by formatRow().

◆ getBody()

TablePager::getBody ( )
final

Get the formatted result list.

Calls getStartBody(), formatRow() and getEndBody(), concatenates the results and returns them.

Also adds the required styles to our OutputPage object (this means that if context wasn't passed to constructor or otherwise set up, you will get a pager with missing styles).

This method has been made 'final' in 1.24. There's no reason to override it, and if there exist any subclasses that do, the style loading hack is probably broken in them. Let's fail fast rather than mysteriously render things wrong.

Deprecated:
since 1.24, use getBodyOutput() or getFullOutput() instead
Returns
string

Reimplemented from IndexPager.

Definition at line 67 of file TablePager.php.

References getModuleStyles(), and ContextSource\getOutput().

◆ getBodyOutput()

TablePager::getBodyOutput ( )

Get the formatted result list.

Calls getBody() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky but works well.)

Since
1.24
Returns
ParserOutput

Definition at line 81 of file TablePager.php.

References getModuleStyles(), and ParserOutput\setText().

◆ getCellAttrs()

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

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

Reimplemented in AllMessagesTablePager.

Definition at line 254 of file TablePager.php.

Referenced by formatRow().

◆ getCurrentRow()

TablePager::getCurrentRow ( )
protected
Returns
stdClass

Definition at line 239 of file TablePager.php.

References $mCurrentRow.

◆ getDefaultSort()

TablePager::getDefaultSort ( )
abstract

The database field name used as a default sort order.

Access:\n protected
Returns
string

Reimplemented in ProtectedPagesPager, ImageListPager, BlockListPager, and AllMessagesTablePager.

Referenced by __construct().

◆ getEmptyBody()

TablePager::getEmptyBody ( )
Access:\n protected
Returns
string

Reimplemented from IndexPager.

Definition at line 173 of file TablePager.php.

References Html\element(), getFieldNames(), ContextSource\msg(), and Html\rawElement().

◆ getEndBody()

TablePager::getEndBody ( )
Access:\n protected
Returns
string

Reimplemented from IndexPager.

Definition at line 165 of file TablePager.php.

◆ getFieldNames()

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 ProtectedPagesPager, ImageListPager, BlockListPager, and AllMessagesTablePager.

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

◆ getFullOutput()

TablePager::getFullOutput ( )

Get the formatted result list, with navigation bars.

Calls getBody(), getNavigationBar() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky but works well.)

Since
1.24
Returns
ParserOutput

Definition at line 99 of file TablePager.php.

References getModuleStyles(), getNavigationBar(), and ParserOutput\setText().

Referenced by SpecialAutoblockList\showList(), and SpecialBlockList\showList().

◆ getHiddenFields()

TablePager::getHiddenFields (   $blacklist = [])

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
array$blacklistParameters from the request query which should not be resubmitted
Returns
string HTML fragment

Definition at line 391 of file TablePager.php.

References $name, $query, $s, $value, array(), as, ContextSource\getRequest(), and Html\hidden().

Referenced by AllMessagesTablePager\buildForm(), and getLimitDropdown().

◆ getIndexField()

TablePager::getIndexField ( )
Access:\n protected
Returns
string

Reimplemented from IndexPager.

Reimplemented in ProtectedPagesPager, and BlockListPager.

Definition at line 262 of file TablePager.php.

References $mSort.

◆ getLimitDropdown()

TablePager::getLimitDropdown ( )

Gets a limit selection dropdown.

Returns
string

Definition at line 425 of file TablePager.php.

References getHiddenFields(), getLimitSelect(), and ContextSource\msg().

Referenced by getLimitForm().

◆ getLimitForm()

TablePager::getLimitForm ( )

Get a form containing a limit selection dropdown.

Returns
string HTML fragment

Definition at line 409 of file TablePager.php.

References getLimitDropdown(), Html\rawElement(), and wfScript().

◆ getLimitSelect()

TablePager::getLimitSelect (   $attribs = [])

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

Parameters
string[]$attribsExtra attributes to set
Returns
string HTML fragment

Definition at line 343 of file TablePager.php.

References $attribs, $name, $value, as, and getLimitSelectList().

Referenced by AllMessagesTablePager\buildForm(), and getLimitDropdown().

◆ getLimitSelectList()

TablePager::getLimitSelectList ( )

Get a list of items to show in a "<select>" element of limits.

This can be passed directly to XmlSelect::addOptions().

Since
1.22
Returns
array

Definition at line 359 of file TablePager.php.

References IndexPager\$mLimit, $ret, $value, as, and ContextSource\getLanguage().

Referenced by getLimitSelect().

◆ getModuleStyles()

TablePager::getModuleStyles ( )

ResourceLoader modules that must be loaded to provide correct styling for this pager.

Since
1.24
Returns
string[]

Definition at line 333 of file TablePager.php.

Referenced by getBody(), getBodyOutput(), and getFullOutput().

◆ getNavClass()

TablePager::getNavClass ( )
protected
Returns
string

Reimplemented in ImageListPager.

Definition at line 276 of file TablePager.php.

Referenced by getNavigationBar().

◆ getNavigationBar()

TablePager::getNavigationBar ( )

A navigation bar with images.

Returns
string HTML

Implements Pager.

Definition at line 291 of file TablePager.php.

References $queries, $title, $type, as, getNavClass(), ContextSource\getOutput(), IndexPager\getPagingQueries(), ContextSource\getTitle(), IndexPager\isNavigationBarShown(), ContextSource\msg(), and text.

Referenced by getFullOutput().

◆ getRowAttrs()

TablePager::getRowAttrs (   $row)

Get attributes to be applied to the given row.

Access:\n protected
Parameters
object$rowThe database result row
Returns
array Array of attribute => value

Definition at line 226 of file TablePager.php.

References getRowClass().

Referenced by formatRow().

◆ getRowClass()

TablePager::getRowClass (   $row)

Get a class name to be applied to the given row.

Access:\n protected
Parameters
object$rowThe database result row
Returns
string

Definition at line 214 of file TablePager.php.

Referenced by getRowAttrs().

◆ getSortHeaderClass()

TablePager::getSortHeaderClass ( )
protected
Returns
string

Reimplemented in ImageListPager.

Definition at line 283 of file TablePager.php.

Referenced by getStartBody().

◆ getStartBody()

TablePager::getStartBody ( )

◆ getTableClass()

TablePager::getTableClass ( )
protected
Returns
string

Reimplemented in ProtectedPagesPager, ImageListPager, and BlockListPager.

Definition at line 269 of file TablePager.php.

Referenced by getStartBody(), and AllMessagesTablePager\getStartBody().

◆ isFieldSortable()

TablePager::isFieldSortable (   $field)
abstract

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

Parameters
string$field

Reimplemented in AllMessagesTablePager, BlockListPager, ProtectedPagesPager, and ImageListPager.

Referenced by __construct(), and getStartBody().

Member Data Documentation

◆ $mCurrentRow

TablePager::$mCurrentRow
protected

◆ $mSort

TablePager::$mSort
protected

Definition at line 29 of file TablePager.php.

Referenced by getIndexField().


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