MediaWiki  master
AllMessagesTablePager Class Reference

Use TablePager for prettified output. More...

Inheritance diagram for AllMessagesTablePager:
Collaboration diagram for AllMessagesTablePager:

Public Member Functions

 __construct (?IContextSource $context, FormOptions $opts, LinkRenderer $linkRenderer)
 
 formatRow ( $row)
 
 formatValue ( $field, $value)
 Format a table cell. More...
 
 getDefaultSort ()
 The database field name used as a default sort order. More...
 
 getQueryInfo ()
 Provides all parameters needed for the main paged query. More...
 
 getTitle ()
 
 reallyDoQuery ( $offset, $limit, $order)
 This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper. More...
 
- Public Member Functions inherited from TablePager
 __construct (IContextSource $context=null, LinkRenderer $linkRenderer=null)
 Stable to call. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getBodyOutput ()
 Get the formatted result list. 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 ()
 Returns the name of the index field.If the pager supports multiple orders, it may return an array of 'querykey' => 'indexfield' pairs, so that a request with &order=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.The pager may paginate on multiple fields in combination. If paginating on multiple fields, they should be unique in combination (e.g. when paginating on user and timestamp, rows may have the same user, rows may have the same timestamp, but rows should all have a different combination of user and timestamp).Examples:

  • Always paginate on the user field: 'user'
  • Paginate on either the user or the timestamp field (default to user): [ 'name' => 'user', 'time' => 'timestamp', ]
  • Always paginate on the combination of user and timestamp: [ [ 'user', 'timestamp' ] ]
  • Paginate on the user then timestamp, or the timestamp then user: [ 'nametime' => [ 'user', 'timestamp' ], 'timename' => [ 'timestamp', 'user' ], ]
Returns
string|string[]|array[]
Stable to override 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...
 
- Public Member Functions inherited from IndexPager
 doQuery ()
 Do the query, using information from the object context. 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...
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. More...
 
 getResult ()
 
 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 ()
 
 getUser ()
 Stable to override. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Static Public Member Functions

static getCustomisedStatuses ( $messageNames, $langcode='en', $foreign=false)
 Determine which of the MediaWiki and MediaWiki_talk namespace pages exist. More...
 

Public Attributes

null bool $custom
 
Language $lang
 
- Public Attributes inherited from IndexPager
IDatabase $mDb
 
bool $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: DIR_ASCENDING or DIR_DESCENDING. More...
 
int $mDefaultLimit = 50
 The default entry limit choosen for clients. More...
 
bool $mIsBackwards
 
bool $mIsFirst
 True if the current result set is the first one. More...
 
bool $mIsLast
 
int $mLimit
 The maximum number of entries to show. More...
 
int[] $mLimitsShown = [ 20, 50, 100, 250, 500 ]
 List of default entry limit options to be presented to clients. More...
 
mixed $mOffset
 The starting point to enumerate entries. More...
 
stdClass bool null $mPastTheEndRow
 Extra row fetched at the end to see if the end was reached. More...
 
bool $mQueryDone = false
 Whether the listing query completed. More...
 
WebRequest $mRequest
 
IResultWrapper $mResult
 Result object for the query. More...
 
const DIR_ASCENDING = false
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const DIR_DESCENDING = true
 Backwards-compatible constant for $mDefaultDirection field (do not change) More...
 
const QUERY_ASCENDING = true
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 
const QUERY_DESCENDING = false
 Backwards-compatible constant for reallyDoQuery() (do not change) More...
 

Protected Member Functions

 getCellAttrs ( $field, $value)
 
 getEndBody ()
 Stable to override. More...
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getRowAttrs ( $row)
 Get attributes to be applied to the given row. More...
 
 getStartBody ()
 Stable to override. More...
 
 isFieldSortable ( $x)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
- Protected Member Functions inherited from TablePager
 getCurrentRow ()
 
 getEmptyBody ()
 
 getNavClass ()
 Stable to override. More...
 
 getRowClass ( $row)
 Get a class name to be applied to the given row. More...
 
 getSortHeaderClass ()
 Stable to override. More...
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. More...
 
- Protected Member Functions inherited from IndexPager
 buildPrevNextNavigation (Title $title, $offset, $limit, array $query=[], $atend=false)
 Generate (prev x| next x) (20|50|100...) type links for paging. More...
 
 buildQueryInfo ( $offset, $limit, $order)
 Build variables to use by the database wrapper. More...
 
 doBatchLookups ()
 Called from getBody(), before getStartBody() is called and after doQuery() was called. 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...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getExtraSortFields ()
 Returns the names of secondary columns to order by in addition to the column in getIndexField(). More...
 
 getLimitLinks ()
 
 getLinkRenderer ()
 
 getPagingLinks ( $linkTexts, $disabledTexts=[])
 Get paging links. More...
 
 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" @stable to override. More...
 
 makeLink ( $text, array $query=null, $type=null)
 Make a self-link. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

bool $foreign
 
string $langcode
 
string $prefix
 
string $suffix
 
- Protected Attributes inherited from TablePager
stdClass $mCurrentRow
 
string $mSort
 
- Protected Attributes inherited from IndexPager
array $mDefaultQuery
 
string[] $mExtraSortFields
 An array of secondary columns to order by. More...
 
array $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string string[] $mIndexField
 The index to actually be used for ordering. More...
 
array $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
array $mPastTheEndIndex
 

Private Member Functions

 getAllMessages ( $descending)
 

Additional Inherited Members

- Static Protected Member Functions inherited from IndexPager
static oppositeOrder ( $order)
 

Detailed Description

Use TablePager for prettified output.

We have to pretend that we're getting data from a table when in fact not all of it comes from the database.

Definition at line 33 of file AllMessagesTablePager.php.

Constructor & Destructor Documentation

◆ __construct()

AllMessagesTablePager::__construct ( ?IContextSource  $context,
FormOptions  $opts,
LinkRenderer  $linkRenderer 
)

Member Function Documentation

◆ formatRow()

AllMessagesTablePager::formatRow (   $row)
Parameters
stdClass$row
Returns
string HTML

Reimplemented from TablePager.

Definition at line 300 of file AllMessagesTablePager.php.

References $s, Html\closeElement(), Html\element(), formatValue(), getCellAttrs(), getRowAttrs(), Html\openElement(), and Html\rawElement().

◆ formatValue()

AllMessagesTablePager::formatValue (   $name,
  $value 
)

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.

Parameters
string$nameThe database field name
string$valueThe value retrieved from the database

Reimplemented from TablePager.

Definition at line 249 of file AllMessagesTablePager.php.

References IndexPager\$linkRenderer, $title, Sanitizer\escapeHtmlAllowEntities(), ContextSource\getLanguage(), IndexPager\getLinkRenderer(), MediaWiki\Linker\LinkRenderer\makeBrokenLink(), Linker\makeExternalLink(), MediaWiki\Linker\LinkRenderer\makeKnownLink(), Title\makeTitle(), ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfArrayToCgi().

Referenced by formatRow().

◆ getAllMessages()

AllMessagesTablePager::getAllMessages (   $descending)
private

Definition at line 113 of file AllMessagesTablePager.php.

Referenced by reallyDoQuery().

◆ getCellAttrs()

AllMessagesTablePager::getCellAttrs (   $field,
  $value 
)
protected
Parameters
string$field
string$value
Returns
array HTML attributes

Reimplemented from TablePager.

Definition at line 329 of file AllMessagesTablePager.php.

Referenced by formatRow().

◆ getCustomisedStatuses()

static AllMessagesTablePager::getCustomisedStatuses (   $messageNames,
  $langcode = 'en',
  $foreign = false 
)
static

Determine which of the MediaWiki and MediaWiki_talk namespace pages exist.

Returns [ 'pages' => ..., 'talks' => ... ], where the subarrays have an entry for each existing page, with the key being the message name and value arbitrary.

Parameters
array$messageNames
string$langcodeWhat language code
bool$foreignWhether the $langcode is not the content language
Returns
array A 'pages' and 'talks' array with the keys of existing pages

Definition at line 141 of file AllMessagesTablePager.php.

References $dbr, $foreign, $langcode, $res, $s, $title, DB_REPLICA, Title\newFromRow(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, and wfGetDB().

Referenced by ApiQueryAllMessages\execute(), DeleteEqualMessages\fetchMessageInfo(), and reallyDoQuery().

◆ getDefaultSort()

AllMessagesTablePager::getDefaultSort ( )

The database field name used as a default sort order.

Note that this field will only be sorted on if isFieldSortable returns true for this field. If not (e.g. paginating on multiple columns), this should return empty string, and getIndexField should be overridden.

Returns
string

Reimplemented from TablePager.

Definition at line 364 of file AllMessagesTablePager.php.

◆ getEndBody()

AllMessagesTablePager::getEndBody ( )
protected

Stable to override.

Returns
string

Reimplemented from TablePager.

Definition at line 245 of file AllMessagesTablePager.php.

References Html\closeElement().

◆ getFieldNames()

AllMessagesTablePager::getFieldNames ( )
protected

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 349 of file AllMessagesTablePager.php.

References ContextSource\msg().

◆ getQueryInfo()

AllMessagesTablePager::getQueryInfo ( )

Provides 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 368 of file AllMessagesTablePager.php.

◆ getRowAttrs()

AllMessagesTablePager::getRowAttrs (   $row)
protected

Get attributes to be applied to the given row.

Stable to override

Parameters
object$rowThe database result row
Returns
array Array of attribute => value

Reimplemented from TablePager.

Definition at line 320 of file AllMessagesTablePager.php.

Referenced by formatRow().

◆ getStartBody()

AllMessagesTablePager::getStartBody ( )
protected

Stable to override.

Returns
string

Reimplemented from TablePager.

Definition at line 223 of file AllMessagesTablePager.php.

References TablePager\getTableClass(), ContextSource\msg(), and Xml\openElement().

◆ getTitle()

AllMessagesTablePager::getTitle ( )
Since
1.18 Stable to override
Returns
Title|null

Reimplemented from ContextSource.

Definition at line 356 of file AllMessagesTablePager.php.

References SpecialPage\getTitleFor().

◆ isFieldSortable()

AllMessagesTablePager::isFieldSortable (   $field)
protected

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

Parameters
string$field

Reimplemented from TablePager.

Definition at line 360 of file AllMessagesTablePager.php.

◆ reallyDoQuery()

AllMessagesTablePager::reallyDoQuery (   $offset,
  $limit,
  $order 
)

This function normally does a database query to get the results; we need to make a pretend result using a FakeResultWrapper.

Parameters
string$offset
int$limit
bool$order
Returns
IResultWrapper

Reimplemented from IndexPager.

Definition at line 189 of file AllMessagesTablePager.php.

References getAllMessages(), getCustomisedStatuses(), ContextSource\msg(), and IndexPager\QUERY_ASCENDING.

Member Data Documentation

◆ $custom

null bool AllMessagesTablePager::$custom

Definition at line 63 of file AllMessagesTablePager.php.

◆ $foreign

bool AllMessagesTablePager::$foreign
protected

Definition at line 43 of file AllMessagesTablePager.php.

Referenced by getCustomisedStatuses().

◆ $lang

Language AllMessagesTablePager::$lang

Definition at line 58 of file AllMessagesTablePager.php.

◆ $langcode

string AllMessagesTablePager::$langcode
protected

Definition at line 38 of file AllMessagesTablePager.php.

Referenced by __construct(), and getCustomisedStatuses().

◆ $prefix

string AllMessagesTablePager::$prefix
protected

Definition at line 48 of file AllMessagesTablePager.php.

Referenced by __construct().

◆ $suffix

string AllMessagesTablePager::$suffix
protected

Definition at line 53 of file AllMessagesTablePager.php.


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