MediaWiki  1.28.1
TablePager.php
Go to the documentation of this file.
1 <?php
28 abstract class TablePager extends IndexPager {
29  protected $mSort;
30 
31  protected $mCurrentRow;
32 
33  public function __construct( IContextSource $context = null ) {
34  if ( $context ) {
35  $this->setContext( $context );
36  }
37 
38  $this->mSort = $this->getRequest()->getText( 'sort' );
39  if ( !array_key_exists( $this->mSort, $this->getFieldNames() )
40  || !$this->isFieldSortable( $this->mSort )
41  ) {
42  $this->mSort = $this->getDefaultSort();
43  }
44  if ( $this->getRequest()->getBool( 'asc' ) ) {
45  $this->mDefaultDirection = IndexPager::DIR_ASCENDING;
46  } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
47  $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
48  } /* Else leave it at whatever the class default is */
49 
50  parent::__construct();
51  }
52 
67  final public function getBody() {
68  $this->getOutput()->addModuleStyles( $this->getModuleStyles() );
69  return parent::getBody();
70  }
71 
81  public function getBodyOutput() {
82  $body = parent::getBody();
83 
84  $pout = new ParserOutput;
85  $pout->setText( $body );
86  $pout->addModuleStyles( $this->getModuleStyles() );
87  return $pout;
88  }
89 
99  public function getFullOutput() {
100  $navigation = $this->getNavigationBar();
101  $body = parent::getBody();
102 
103  $pout = new ParserOutput;
104  $pout->setText( $navigation . $body . $navigation );
105  $pout->addModuleStyles( $this->getModuleStyles() );
106  return $pout;
107  }
108 
113  function getStartBody() {
114  $sortClass = $this->getSortHeaderClass();
115 
116  $s = '';
117  $fields = $this->getFieldNames();
118 
119  // Make table header
120  foreach ( $fields as $field => $name ) {
121  if ( strval( $name ) == '' ) {
122  $s .= Html::rawElement( 'th', [], '&#160;' ) . "\n";
123  } elseif ( $this->isFieldSortable( $field ) ) {
124  $query = [ 'sort' => $field, 'limit' => $this->mLimit ];
125  $linkType = null;
126  $class = null;
127 
128  if ( $this->mSort == $field ) {
129  // The table is sorted by this field already, make a link to sort in the other direction
130  // We don't actually know in which direction other fields will be sorted by default…
131  if ( $this->mDefaultDirection == IndexPager::DIR_DESCENDING ) {
132  $linkType = 'asc';
133  $class = "$sortClass TablePager_sort-descending";
134  $query['asc'] = '1';
135  $query['desc'] = '';
136  } else {
137  $linkType = 'desc';
138  $class = "$sortClass TablePager_sort-ascending";
139  $query['asc'] = '';
140  $query['desc'] = '1';
141  }
142  }
143 
144  $link = $this->makeLink( htmlspecialchars( $name ), $query, $linkType );
145  $s .= Html::rawElement( 'th', [ 'class' => $class ], $link ) . "\n";
146  } else {
147  $s .= Html::element( 'th', [], $name ) . "\n";
148  }
149  }
150 
151  $tableClass = $this->getTableClass();
152  $ret = Html::openElement( 'table', [
153  'class' => "mw-datatable $tableClass" ]
154  );
155  $ret .= Html::rawElement( 'thead', [], Html::rawElement( 'tr', [], "\n" . $s . "\n" ) );
156  $ret .= Html::openElement( 'tbody' ) . "\n";
157 
158  return $ret;
159  }
160 
165  function getEndBody() {
166  return "</tbody></table>\n";
167  }
168 
173  function getEmptyBody() {
174  $colspan = count( $this->getFieldNames() );
175  $msgEmpty = $this->msg( 'table_pager_empty' )->text();
176  return Html::rawElement( 'tr', [],
177  Html::element( 'td', [ 'colspan' => $colspan ], $msgEmpty ) );
178  }
179 
185  function formatRow( $row ) {
186  $this->mCurrentRow = $row; // In case formatValue etc need to know
187  $s = Html::openElement( 'tr', $this->getRowAttrs( $row ) ) . "\n";
188  $fieldNames = $this->getFieldNames();
189 
190  foreach ( $fieldNames as $field => $name ) {
191  $value = isset( $row->$field ) ? $row->$field : null;
192  $formatted = strval( $this->formatValue( $field, $value ) );
193 
194  if ( $formatted == '' ) {
195  $formatted = '&#160;';
196  }
197 
198  $s .= Html::rawElement( 'td', $this->getCellAttrs( $field, $value ), $formatted ) . "\n";
199  }
200 
201  $s .= Html::closeElement( 'tr' ) . "\n";
202 
203  return $s;
204  }
205 
214  function getRowClass( $row ) {
215  return '';
216  }
217 
226  function getRowAttrs( $row ) {
227  $class = $this->getRowClass( $row );
228  if ( $class === '' ) {
229  // Return an empty array to avoid clutter in HTML like class=""
230  return [];
231  } else {
232  return [ 'class' => $this->getRowClass( $row ) ];
233  }
234  }
235 
239  protected function getCurrentRow() {
240  return $this->mCurrentRow;
241  }
242 
254  function getCellAttrs( $field, $value ) {
255  return [ 'class' => 'TablePager_col_' . $field ];
256  }
257 
262  function getIndexField() {
263  return $this->mSort;
264  }
265 
269  protected function getTableClass() {
270  return 'TablePager';
271  }
272 
276  protected function getNavClass() {
277  return 'TablePager_nav';
278  }
279 
283  protected function getSortHeaderClass() {
284  return 'TablePager_sort';
285  }
286 
291  public function getNavigationBar() {
292  if ( !$this->isNavigationBarShown() ) {
293  return '';
294  }
295 
296  $labels = [
297  'first' => 'table_pager_first',
298  'prev' => 'table_pager_prev',
299  'next' => 'table_pager_next',
300  'last' => 'table_pager_last',
301  ];
302 
303  $linkTexts = [];
304  $disabledTexts = [];
305  foreach ( $labels as $type => $label ) {
306  $msgLabel = $this->msg( $label )->escaped();
307  $linkTexts[$type] = "<div class='TablePager_nav-enabled'>$msgLabel</div>";
308  $disabledTexts[$type] = "<div class='TablePager_nav-disabled'>$msgLabel</div>";
309  }
310  $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
311 
312  $s = Html::openElement( 'table', [ 'class' => $this->getNavClass() ] );
313  $s .= Html::openElement( 'tr' ) . "\n";
314  $width = 100 / count( $links ) . '%';
315  foreach ( $labels as $type => $label ) {
316  // We want every cell to have the same width. We could use table-layout: fixed; in CSS,
317  // but it only works if we specify the width of a cell or the table and we don't want to.
318  // There is no better way. <http://www.w3.org/TR/CSS2/tables.html#fixed-table-layout>
319  $s .= Html::rawElement( 'td',
320  [ 'style' => "width: $width;", 'class' => "TablePager_nav-$type" ],
321  $links[$type] ) . "\n";
322  }
323  $s .= Html::closeElement( 'tr' ) . Html::closeElement( 'table' ) . "\n";
324  return $s;
325  }
326 
332  public function getModuleStyles() {
333  return [ 'mediawiki.pager.tablePager' ];
334  }
335 
342  public function getLimitSelect( $attribs = [] ) {
343  $select = new XmlSelect( 'limit', false, $this->mLimit );
344  $select->addOptions( $this->getLimitSelectList() );
345  foreach ( $attribs as $name => $value ) {
346  $select->setAttribute( $name, $value );
347  }
348  return $select->getHTML();
349  }
350 
358  public function getLimitSelectList() {
359  # Add the current limit from the query string
360  # to avoid that the limit is lost after clicking Go next time
361  if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) {
362  $this->mLimitsShown[] = $this->mLimit;
363  sort( $this->mLimitsShown );
364  }
365  $ret = [];
366  foreach ( $this->mLimitsShown as $key => $value ) {
367  # The pair is either $index => $limit, in which case the $value
368  # will be numeric, or $limit => $text, in which case the $value
369  # will be a string.
370  if ( is_int( $value ) ) {
371  $limit = $value;
372  $text = $this->getLanguage()->formatNum( $limit );
373  } else {
374  $limit = $key;
375  $text = $value;
376  }
377  $ret[$text] = $limit;
378  }
379  return $ret;
380  }
381 
390  function getHiddenFields( $blacklist = [] ) {
391  $blacklist = (array)$blacklist;
392  $query = $this->getRequest()->getQueryValues();
393  foreach ( $blacklist as $name ) {
394  unset( $query[$name] );
395  }
396  $s = '';
397  foreach ( $query as $name => $value ) {
398  $s .= Html::hidden( $name, $value ) . "\n";
399  }
400  return $s;
401  }
402 
408  function getLimitForm() {
409  return Html::rawElement(
410  'form',
411  [
412  'method' => 'get',
413  'action' => wfScript(),
414  ],
415  "\n" . $this->getLimitDropdown()
416  ) . "\n";
417  }
418 
424  function getLimitDropdown() {
425  # Make the select with some explanatory text
426  $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();
427 
428  return $this->msg( 'table_pager_limit' )
429  ->rawParams( $this->getLimitSelect() )->escaped() .
430  "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
431  $this->getHiddenFields( [ 'limit' ] );
432  }
433 
440  abstract function isFieldSortable( $field );
441 
454  abstract function formatValue( $name, $value );
455 
463  abstract function getDefaultSort();
464 
472  abstract function getFieldNames();
473 }
const DIR_DESCENDING
Definition: IndexPager.php:73
setContext(IContextSource $context)
Set the IContextSource object.
static closeElement($element)
Returns "".
Definition: Html.php:305
Table-based display with a user-selectable sort order.
Definition: TablePager.php:28
formatValue($name, $value)
Format a table cell.
Interface for objects which can provide a MediaWiki context on request.
the array() calling protocol came about after MediaWiki 1.4rc1.
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1555
getLanguage()
Get the Language object.
wfScript($script= 'index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses & $ret
Definition: hooks.txt:1936
formatRow($row)
Definition: TablePager.php:185
getLimitSelect($attribs=[])
Get a " or elements.
Definition: XmlSelect.php:26
getRowClass($row)
Get a class name to be applied to the given row.
Definition: TablePager.php:214
$value
getLimitDropdown()
Gets a limit selection dropdown.
Definition: TablePager.php:424
getDefaultSort()
The database field name used as a default sort order.
IContextSource $context
usually copyright or history_copyright This message must be in HTML not wikitext & $link
Definition: hooks.txt:2889
getRequest()
Get the WebRequest object.
getLimitSelectList()
Get a list of items to show in a " elements for use in a method="get" form.
Definition: TablePager.php:390
msg()
Get a Message object with context set Parameters are the same as wfMessage()
static openElement($element, $attribs=[])
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:247
getLimitForm()
Get a form containing a limit selection dropdown.
Definition: TablePager.php:408
__construct(IContextSource $context=null)
Definition: TablePager.php:33
isFieldSortable($field)
Return true if the named field should be sortable by the UI, false otherwise.
isNavigationBarShown()
Returns whether to show the "navigation bar".
Definition: IndexPager.php:603
getBody()
Get the formatted result list.
Definition: TablePager.php:67
getFieldNames()
An array mapping database field names to a textual description of the field name, for use in the tabl...
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing & $attribs
Definition: hooks.txt:1936
makeLink($text, array $query=null, $type=null)
Make a self-link.
Definition: IndexPager.php:461
getRowAttrs($row)
Get attributes to be applied to the given row.
Definition: TablePager.php:226
getPagingLinks($linkTexts, $disabledTexts=[])
Get paging links.
Definition: IndexPager.php:621
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
getCellAttrs($field, $value)
Get any extra attributes to be applied to the given cell.
Definition: TablePager.php:254
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set and then return false from the hook function Ensure you consume the ChangeTagAfterDelete hook to carry out custom deletion actions as context called by AbstractContent::getParserOutput May be used to override the normal model specific rendering of page content as context as context the output can only depend on parameters provided to this hook not on global state indicating whether full HTML should be generated If generation of HTML may be but other information should still be present in the ParserOutput object to manipulate or replace but no entry for that model exists in $wgContentHandlers if desired whether it is OK to use $contentModel on $title Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok inclusive $limit
Definition: hooks.txt:1046
getSortHeaderClass()
Definition: TablePager.php:283
getFullOutput()
Get the formatted result list, with navigation bars.
Definition: TablePager.php:99
static element($element, $attribs=[], $contents= '')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:229
const DIR_ASCENDING
Constants for the $mDefaultDirection field.
Definition: IndexPager.php:72
do that in ParserLimitReportFormat instead use this to modify the parameters of the image and a DIV can begin in one section and end in another Make sure your code can handle that case gracefully See the EditSectionClearerLink extension for an example zero but section is usually empty its values are the globals values before the output is cached one of or reset my talk my contributions etc etc otherwise the built in rate limiting checks are if enabled allows for interception of redirect as a string mapping parameter names to values & $type
Definition: hooks.txt:2491
getBodyOutput()
Get the formatted result list.
Definition: TablePager.php:81
getOutput()
Get the OutputPage object.
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:300
getNavigationBar()
A navigation bar with images.
Definition: TablePager.php:291