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=null, FormOptions $opts)
 
 formatRow ( $row)
 
 formatValue ( $field, $value)
 
 getAllMessages ( $descending)
 
 getCellAttrs ( $field, $value)
 
 getDefaultSort ()
 
 getEndBody ()
 
 getFieldNames ()
 
 getQueryInfo ()
 
 getRowAttrs ( $row)
 
 getTitle ()
 
 isFieldSortable ( $x)
 
 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)
 
 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 ()
 
 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...
 
 isFieldSortable ( $field)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
- Public Member Functions inherited from IndexPager
 __construct (IContextSource $context=null)
 
 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...
 
 formatRow ( $row)
 Abstract formatting function. More...
 
 getBody ()
 Get the formatted result list. More...
 
 getDatabase ()
 Get the Database object in use. More...
 
 getDefaultQuery ()
 Get an array of query parameters that should be put into self-links. More...
 
 getIndexField ()
 This function should be overridden to return the name of the index fi- eld. 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, $order)
 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)
 

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

 getStartBody ()
 
- Protected Member Functions inherited from TablePager
 getCurrentRow ()
 
 getEndBody ()
 
 getNavClass ()
 
 getSortHeaderClass ()
 
 getStartBody ()
 
 getTableClass ()
 TablePager relies on mw-datatable for styling, see T214208. More...
 
- Protected Member Functions inherited from IndexPager
 buildPrevNextNavigation (LinkTarget $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...
 
 getDefaultDirections ()
 Return the default sorting direction: DIR_ASCENDING or DIR_DESCENDING. More...
 
 getEmptyBody ()
 Hook into getBody(), for the bit between the start and the end when there are no rows. More...
 
 getEndBody ()
 Hook into getBody() for the end of the list. 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...
 
 getStartBody ()
 Hook into getBody(), allows text to be inserted at the start. More...
 
 preprocessResults ( $result)
 Pre-process results; useful for performing batch existence checks, etc. More...
 

Protected Attributes

bool $foreign
 
string $langcode
 
string $prefix
 
- 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...
 
mixed $mFirstShown
 
bool $mIncludeOffset = false
 Whether to include the offset in the query. More...
 
string $mIndexField
 The index to actually be used for ordering. More...
 
mixed $mLastShown
 
string $mNavigationBar
 
string null $mOrderType
 For pages that support multiple types of ordering, which one to use. More...
 
mixed $mPastTheEndIndex
 

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

Constructor & Destructor Documentation

◆ __construct()

AllMessagesTablePager::__construct ( IContextSource  $context = null,
FormOptions  $opts 
)

Member Function Documentation

◆ formatRow()

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

Definition at line 289 of file AllMessagesTablePager.php.

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

◆ formatValue()

◆ getAllMessages()

AllMessagesTablePager::getAllMessages (   $descending)

Definition at line 103 of file AllMessagesTablePager.php.

References Language\getLocalisationCache().

Referenced by reallyDoQuery().

◆ getCellAttrs()

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

Definition at line 318 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 129 of file AllMessagesTablePager.php.

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

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

◆ getDefaultSort()

AllMessagesTablePager::getDefaultSort ( )

Definition at line 353 of file AllMessagesTablePager.php.

◆ getEndBody()

AllMessagesTablePager::getEndBody ( )

Definition at line 233 of file AllMessagesTablePager.php.

References Html\closeElement().

◆ getFieldNames()

AllMessagesTablePager::getFieldNames ( )

Definition at line 338 of file AllMessagesTablePager.php.

References ContextSource\msg().

◆ getQueryInfo()

AllMessagesTablePager::getQueryInfo ( )

Definition at line 357 of file AllMessagesTablePager.php.

◆ getRowAttrs()

AllMessagesTablePager::getRowAttrs (   $row)

Definition at line 309 of file AllMessagesTablePager.php.

Referenced by formatRow().

◆ getStartBody()

AllMessagesTablePager::getStartBody ( )
protected

◆ getTitle()

AllMessagesTablePager::getTitle ( )
Returns
Title|null

Implements IContextSource.

Definition at line 345 of file AllMessagesTablePager.php.

References SpecialPage\getTitleFor().

◆ isFieldSortable()

AllMessagesTablePager::isFieldSortable (   $x)

Definition at line 349 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
FakeResultWrapper

Definition at line 177 of file AllMessagesTablePager.php.

References as, getAllMessages(), and ContextSource\msg().

Member Data Documentation

◆ $custom

null bool AllMessagesTablePager::$custom

Definition at line 56 of file AllMessagesTablePager.php.

◆ $foreign

bool AllMessagesTablePager::$foreign
protected

Definition at line 41 of file AllMessagesTablePager.php.

◆ $lang

Language AllMessagesTablePager::$lang

Definition at line 51 of file AllMessagesTablePager.php.

◆ $langcode

string AllMessagesTablePager::$langcode
protected

Definition at line 36 of file AllMessagesTablePager.php.

Referenced by __construct().

◆ $prefix

string AllMessagesTablePager::$prefix
protected

Definition at line 46 of file AllMessagesTablePager.php.


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