includes/pager/TablePager.php

   1 <?php
   2 /**
   3  * Efficient paging for SQL queries.
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup Pager
  22  */
  23
  24 /**
  25  * Table-based display with a user-selectable sort order
  26  * @ingroup Pager
  27  */
  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
  53         /**
  54          * Get the formatted result list. Calls getStartBody(), formatRow() and getEndBody(), concatenates
  55          * the results and returns them.
  56          *
  57          * Also adds the required styles to our OutputPage object (this means that if context wasn't
  58          * passed to constructor or otherwise set up, you will get a pager with missing styles).
  59          *
  60          * This method has been made 'final' in 1.24. There's no reason to override it, and if there exist
  61          * any subclasses that do, the style loading hack is probably broken in them. Let's fail fast
  62          * rather than mysteriously render things wrong.
  63          *
  64          * @deprecated since 1.24, use getBodyOutput() or getFullOutput() instead
  65          * @return string
  66          */
  67         final public function getBody() {
  68                 $this->getOutput()->addModuleStyles( $this->getModuleStyles() );
  69                 return parent::getBody();
  70         }
  71
  72         /**
  73          * Get the formatted result list.
  74          *
  75          * Calls getBody() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky
  76          * but works well.)
  77          *
  78          * @since 1.24
  79          * @return ParserOutput
  80          */
  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
  90         /**
  91          * Get the formatted result list, with navigation bars.
  92          *
  93          * Calls getBody(), getNavigationBar() and getModuleStyles() and
  94          * builds a ParserOutput object. (This is a bit hacky but works well.)
  95          *
  96          * @since 1.24
  97          * @return ParserOutput
  98          */
  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
 109         /**
 110          * @protected
 111          * @return string
 112          */
 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', array(), '&#160;' ) . "\n";
 123                         } elseif ( $this->isFieldSortable( $field ) ) {
 124                                 $query = array( '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', array( 'class' => $class ), $link ) . "\n";
 146                         } else {
 147                                 $s .= Html::element( 'th', array(), $name ) . "\n";
 148                         }
 149                 }
 150
 151                 $tableClass = $this->getTableClass();
 152                 $ret = Html::openElement( 'table', array(
 153                         'class' => "mw-datatable $tableClass" )
 154                 );
 155                 $ret .= Html::rawElement( 'thead', array(), Html::rawElement( 'tr', array(), "\n" . $s . "\n" ) );
 156                 $ret .= Html::openElement( 'tbody' ) . "\n";
 157
 158                 return $ret;
 159         }
 160
 161         /**
 162          * @protected
 163          * @return string
 164          */
 165         function getEndBody() {
 166                 return "</tbody></table>\n";
 167         }
 168
 169         /**
 170          * @protected
 171          * @return string
 172          */
 173         function getEmptyBody() {
 174                 $colspan = count( $this->getFieldNames() );
 175                 $msgEmpty = $this->msg( 'table_pager_empty' )->text();
 176                 return Html::rawElement( 'tr', array(),
 177                         Html::element( 'td', array( 'colspan' => $colspan ), $msgEmpty ) );
 178         }
 179
 180         /**
 181          * @protected
 182          * @param stdClass $row
 183          * @return string HTML
 184          */
 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
 206         /**
 207          * Get a class name to be applied to the given row.
 208          *
 209          * @protected
 210          *
 211          * @param object $row The database result row
 212          * @return string
 213          */
 214         function getRowClass( $row ) {
 215                 return '';
 216         }
 217
 218         /**
 219          * Get attributes to be applied to the given row.
 220          *
 221          * @protected
 222          *
 223          * @param object $row The database result row
 224          * @return array Array of attribute => value
 225          */
 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 array();
 231                 } else {
 232                         return array( 'class' => $this->getRowClass( $row ) );
 233                 }
 234         }
 235
 236         /**
 237          * Get any extra attributes to be applied to the given cell. Don't
 238          * take this as an excuse to hardcode styles; use classes and
 239          * CSS instead.  Row context is available in $this->mCurrentRow
 240          *
 241          * @protected
 242          *
 243          * @param string $field The column
 244          * @param string $value The cell contents
 245          * @return array Array of attr => value
 246          */
 247         function getCellAttrs( $field, $value ) {
 248                 return array( 'class' => 'TablePager_col_' . $field );
 249         }
 250
 251         /**
 252          * @protected
 253          * @return string
 254          */
 255         function getIndexField() {
 256                 return $this->mSort;
 257         }
 258
 259         /**
 260          * @protected
 261          * @return string
 262          */
 263         function getTableClass() {
 264                 return 'TablePager';
 265         }
 266
 267         /**
 268          * @protected
 269          * @return string
 270          */
 271         function getNavClass() {
 272                 return 'TablePager_nav';
 273         }
 274
 275         /**
 276          * @protected
 277          * @return string
 278          */
 279         function getSortHeaderClass() {
 280                 return 'TablePager_sort';
 281         }
 282
 283         /**
 284          * A navigation bar with images
 285          * @return string HTML
 286          */
 287         public function getNavigationBar() {
 288                 if ( !$this->isNavigationBarShown() ) {
 289                         return '';
 290                 }
 291
 292                 $labels = array(
 293                         'first' => 'table_pager_first',
 294                         'prev' => 'table_pager_prev',
 295                         'next' => 'table_pager_next',
 296                         'last' => 'table_pager_last',
 297                 );
 298
 299                 $linkTexts = array();
 300                 $disabledTexts = array();
 301                 foreach ( $labels as $type => $label ) {
 302                         $msgLabel = $this->msg( $label )->escaped();
 303                         $linkTexts[$type] = "<div class='TablePager_nav-enabled'>$msgLabel</div>";
 304                         $disabledTexts[$type] = "<div class='TablePager_nav-disabled'>$msgLabel</div>";
 305                 }
 306                 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
 307
 308                 $s = Html::openElement( 'table', array( 'class' => $this->getNavClass() ) );
 309                 $s .= Html::openElement( 'tr' ) . "\n";
 310                 $width = 100 / count( $links ) . '%';
 311                 foreach ( $labels as $type => $label ) {
 312                         // We want every cell to have the same width. We could use table-layout: fixed; in CSS,
 313                         // but it only works if we specify the width of a cell or the table and we don't want to.
 314                         // There is no better way. <http://www.w3.org/TR/CSS2/tables.html#fixed-table-layout>
 315                         $s .= Html::rawElement( 'td',
 316                                 array( 'style' => "width: $width;", 'class' => "TablePager_nav-$type" ),
 317                                 $links[$type] ) . "\n";
 318                 }
 319                 $s .= Html::closeElement( 'tr' ) . Html::closeElement( 'table' ) . "\n";
 320                 return $s;
 321         }
 322
 323         /**
 324          * ResourceLoader modules that must be loaded to provide correct styling for this pager
 325          * @since 1.24
 326          * @return string[]
 327          */
 328         public function getModuleStyles() {
 329                 return array( 'mediawiki.pager.tablePager' );
 330         }
 331
 332         /**
 333          * Get a "<select>" element which has options for each of the allowed limits
 334          *
 335          * @param string $attribs Extra attributes to set
 336          * @return string HTML fragment
 337          */
 338         public function getLimitSelect( $attribs = array() ) {
 339                 $select = new XmlSelect( 'limit', false, $this->mLimit );
 340                 $select->addOptions( $this->getLimitSelectList() );
 341                 foreach ( $attribs as $name => $value ) {
 342                         $select->setAttribute( $name, $value );
 343                 }
 344                 return $select->getHTML();
 345         }
 346
 347         /**
 348          * Get a list of items to show in a "<select>" element of limits.
 349          * This can be passed directly to XmlSelect::addOptions().
 350          *
 351          * @since 1.22
 352          * @return array
 353          */
 354         public function getLimitSelectList() {
 355                 # Add the current limit from the query string
 356                 # to avoid that the limit is lost after clicking Go next time
 357                 if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) {
 358                         $this->mLimitsShown[] = $this->mLimit;
 359                         sort( $this->mLimitsShown );
 360                 }
 361                 $ret = array();
 362                 foreach ( $this->mLimitsShown as $key => $value ) {
 363                         # The pair is either $index => $limit, in which case the $value
 364                         # will be numeric, or $limit => $text, in which case the $value
 365                         # will be a string.
 366                         if ( is_int( $value ) ) {
 367                                 $limit = $value;
 368                                 $text = $this->getLanguage()->formatNum( $limit );
 369                         } else {
 370                                 $limit = $key;
 371                                 $text = $value;
 372                         }
 373                         $ret[$text] = $limit;
 374                 }
 375                 return $ret;
 376         }
 377
 378         /**
 379          * Get \<input type="hidden"\> elements for use in a method="get" form.
 380          * Resubmits all defined elements of the query string, except for a
 381          * blacklist, passed in the $blacklist parameter.
 382          *
 383          * @param array $blacklist Parameters from the request query which should not be resubmitted
 384          * @return string HTML fragment
 385          */
 386         function getHiddenFields( $blacklist = array() ) {
 387                 $blacklist = (array)$blacklist;
 388                 $query = $this->getRequest()->getQueryValues();
 389                 foreach ( $blacklist as $name ) {
 390                         unset( $query[$name] );
 391                 }
 392                 $s = '';
 393                 foreach ( $query as $name => $value ) {
 394                         $s .= Html::hidden( $name, $value ) . "\n";
 395                 }
 396                 return $s;
 397         }
 398
 399         /**
 400          * Get a form containing a limit selection dropdown
 401          *
 402          * @return string HTML fragment
 403          */
 404         function getLimitForm() {
 405                 return Html::rawElement(
 406                         'form',
 407                         array(
 408                                 'method' => 'get',
 409                                 'action' => wfScript(),
 410                         ),
 411                         "\n" . $this->getLimitDropdown()
 412                 ) . "\n";
 413         }
 414
 415         /**
 416          * Gets a limit selection dropdown
 417          *
 418          * @return string
 419          */
 420         function getLimitDropdown() {
 421                 # Make the select with some explanatory text
 422                 $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();
 423
 424                 return $this->msg( 'table_pager_limit' )
 425                         ->rawParams( $this->getLimitSelect() )->escaped() .
 426                         "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
 427                         $this->getHiddenFields( array( 'limit' ) );
 428         }
 429
 430         /**
 431          * Return true if the named field should be sortable by the UI, false
 432          * otherwise
 433          *
 434          * @param string $field
 435          */
 436         abstract function isFieldSortable( $field );
 437
 438         /**
 439          * Format a table cell. The return value should be HTML, but use an empty
 440          * string not &#160; for empty cells. Do not include the <td> and </td>.
 441          *
 442          * The current result row is available as $this->mCurrentRow, in case you
 443          * need more context.
 444          *
 445          * @protected
 446          *
 447          * @param string $name The database field name
 448          * @param string $value The value retrieved from the database
 449          */
 450         abstract function formatValue( $name, $value );
 451
 452         /**
 453          * The database field name used as a default sort order.
 454          *
 455          * @protected
 456          *
 457          * @return string
 458          */
 459         abstract function getDefaultSort();
 460
 461         /**
 462          * An array mapping database field names to a textual description of the
 463          * field name, for use in the table header. The description should be plain
 464          * text, it will be HTML-escaped later.
 465          *
 466          * @return array
 467          */
 468         abstract function getFieldNames();
 469 }