MediaWiki  1.23.8
AllmessagesTablePager Class Reference

Use TablePager for prettified output. More...

Inheritance diagram for AllmessagesTablePager:
Collaboration diagram for AllmessagesTablePager:

Public Member Functions

 __construct ( $page, $conds, $langObj=null)
 
 buildForm ()
 
 formatRow ( $row)
 
 formatValue ( $field, $value)
 Format a table cell. More...
 
 getAllMessages ( $descending)
 
 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...
 
 getFieldNames ()
 An array mapping database field names to a textual description of the field name, for use in the table header. More...
 
 getQueryInfo ()
 This function should be overridden to provide all parameters needed for the main paged query. More...
 
 getRowAttrs ( $row, $isSecond=false)
 
 getStartBody ()
 
 getTitle ()
 Get the Title object. More...
 
 isFieldSortable ( $x)
 Return true if the named field should be sortable by the UI, false otherwise. More...
 
 reallyDoQuery ( $offset, $limit, $descending)
 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)
 
 getEmptyBody ()
 
 getEndBody ()
 
 getHiddenFields ( $blacklist=array())
 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=array())
 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...
 
 getNavClass ()
 
 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...
 
 getSortHeaderClass ()
 
 getTableClass ()
 
- Public Member Functions inherited from IndexPager
 doQuery ()
 Do the query, using information from the object context. More...
 
 extractResultInfo ( $isFirst, $limit, ResultWrapper $res)
 Extract some useful data from the result object for use by the navigation bar, put it into $this. 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...
 
 getLimit ()
 Get the current limit. More...
 
 getLimitLinks ()
 
 getNumRows ()
 Get the number of rows in the result set. More...
 
 getPagingLinks ( $linkTexts, $disabledTexts=array())
 Get paging links. More...
 
 getPagingQueries ()
 Get a URL query array for the prev, next, first and last links. 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...
 
 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 ()
 Get the Config object. More...
 
 getContext ()
 Get the RequestContext object. More...
 
 getLang ()
 Get the Language object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

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
 
 $displayPrefix
 
Language $lang
 
 $langcode
 
 $mLimitsShown
 
 $prefix
 
- Public Attributes inherited from TablePager
 $mCurrentRow
 
 $mSort
 
- Public Attributes inherited from IndexPager
 $mDb
 
 $mDefaultDirection
 $mDefaultDirection gives the direction to use when sorting results: false for ascending, true for descending. More...
 
 $mDefaultLimit = 50
 
 $mDefaultQuery
 
 $mFirstShown
 
 $mIsBackwards
 
 $mIsFirst
 True if the current result set is the first one. More...
 
 $mIsLast
 
 $mLimit
 
 $mLimitsShown = array( 20, 50, 100, 250, 500 )
 
 $mNavigationBar
 
 $mOffset
 
 $mPastTheEndIndex
 
 $mPastTheEndRow
 
 $mQueryDone = false
 
 $mRequest
 
ResultWrapper $mResult
 Result object for the query. More...
 

Protected Attributes

 $filter
 
- 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

- 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: false for ascending, true for 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...
 

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 87 of file SpecialAllmessages.php.

Constructor & Destructor Documentation

◆ __construct()

AllmessagesTablePager::__construct (   $page,
  $conds,
  $langObj = null 
)

Member Function Documentation

◆ buildForm()

◆ formatRow()

AllmessagesTablePager::formatRow (   $row)
Access:\n protected
Parameters
stdClass$row
Returns
String HTML

Reimplemented from TablePager.

Definition at line 392 of file SpecialAllmessages.php.

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

◆ 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.

Access:\n protected
Parameters
string$namethe database field name
string$valuethe value retrieved from the database

Reimplemented from TablePager.

Definition at line 340 of file SpecialAllmessages.php.

References $title, $value, array(), Sanitizer\escapeHtmlAllowEntities(), ContextSource\getLanguage(), Linker\link(), Linker\linkKnown(), Linker\makeExternalLink(), Title\makeTitle(), ContextSource\msg(), NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, text, and wfArrayToCgi().

Referenced by formatRow().

◆ getAllMessages()

AllmessagesTablePager::getAllMessages (   $descending)

Definition at line 215 of file SpecialAllmessages.php.

References array(), Language\getLocalisationCache(), wfProfileIn(), and wfProfileOut().

Referenced by reallyDoQuery().

◆ getCellAttrs()

AllmessagesTablePager::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 of attr => value

Reimplemented from TablePager.

Definition at line 422 of file SpecialAllmessages.php.

References array().

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 array( '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 243 of file SpecialAllmessages.php.

References $dbr, $langcode, $res, $s, $title, array(), as, DB_SLAVE, NS_MEDIAWIKI, NS_MEDIAWIKI_TALK, wfGetDB(), wfProfileIn(), and wfProfileOut().

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

◆ getDefaultSort()

AllmessagesTablePager::getDefaultSort ( )

The database field name used as a default sort order.

Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 448 of file SpecialAllmessages.php.

◆ getFieldNames()

AllmessagesTablePager::getFieldNames ( )

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 433 of file SpecialAllmessages.php.

References array(), ContextSource\msg(), and text.

◆ getQueryInfo()

AllmessagesTablePager::getQueryInfo ( )

This function should be overridden to provide 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 452 of file SpecialAllmessages.php.

◆ getRowAttrs()

AllmessagesTablePager::getRowAttrs (   $row,
  $isSecond = false 
)

Definition at line 410 of file SpecialAllmessages.php.

References array(), Sanitizer\escapeId(), and ContextSource\getLanguage().

Referenced by formatRow().

◆ getStartBody()

AllmessagesTablePager::getStartBody ( )
Access:\n protected
Returns
string

Reimplemented from TablePager.

Definition at line 323 of file SpecialAllmessages.php.

References array(), ContextSource\msg(), and Xml\openElement().

◆ getTitle()

AllmessagesTablePager::getTitle ( )

Get the Title object.

Since
1.18
Returns
Title

Reimplemented from ContextSource.

Definition at line 440 of file SpecialAllmessages.php.

References SpecialPage\getTitleFor().

Referenced by buildForm().

◆ isFieldSortable()

AllmessagesTablePager::isFieldSortable (   $field)

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

Parameters
$fieldString

Reimplemented from TablePager.

Definition at line 444 of file SpecialAllmessages.php.

◆ reallyDoQuery()

AllmessagesTablePager::reallyDoQuery (   $offset,
  $limit,
  $descending 
)

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$descending
Returns
FakeResultWrapper

Reimplemented from IndexPager.

Definition at line 290 of file SpecialAllmessages.php.

References $count, $limit, array(), as, getAllMessages(), getCustomisedStatuses(), and wfMessage().

Member Data Documentation

◆ $custom

null bool AllmessagesTablePager::$custom

Definition at line 98 of file SpecialAllmessages.php.

◆ $displayPrefix

AllmessagesTablePager::$displayPrefix

Definition at line 88 of file SpecialAllmessages.php.

◆ $filter

AllmessagesTablePager::$filter
protected

Definition at line 88 of file SpecialAllmessages.php.

◆ $lang

Language AllmessagesTablePager::$lang

Definition at line 94 of file SpecialAllmessages.php.

◆ $langcode

AllmessagesTablePager::$langcode

Definition at line 88 of file SpecialAllmessages.php.

Referenced by __construct(), and getCustomisedStatuses().

◆ $mLimitsShown

AllmessagesTablePager::$mLimitsShown

Definition at line 90 of file SpecialAllmessages.php.

◆ $prefix

AllmessagesTablePager::$prefix

Definition at line 88 of file SpecialAllmessages.php.

Referenced by __construct().


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