3 * Efficient paging for SQL queries.
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.
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.
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
25 * Table-based display with a user-selectable sort order
28 abstract class TablePager
extends IndexPager
{
31 protected $mCurrentRow;
33 public function __construct( IContextSource
$context = null ) {
35 $this->setContext( $context );
38 $this->mSort
= $this->getRequest()->getText( 'sort' );
39 if ( !array_key_exists( $this->mSort
, $this->getFieldNames() )
40 ||
!$this->isFieldSortable( $this->mSort
)
42 $this->mSort
= $this->getDefaultSort();
44 if ( $this->getRequest()->getBool( 'asc' ) ) {
45 $this->mDefaultDirection
= false;
46 } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
47 $this->mDefaultDirection
= true;
48 } /* Else leave it at whatever the class default is */
50 parent
::__construct();
54 * Get the formatted result list. Calls getStartBody(), formatRow() and getEndBody(), concatenates
55 * the results and returns them.
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).
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.
64 * @deprecated since 1.24, use getBodyOutput() or getFullOutput() instead
67 final public function getBody() {
68 $this->getOutput()->addModuleStyles( $this->getModuleStyles() );
69 return parent
::getBody();
73 * Get the formatted result list.
75 * Calls getBody() and getModuleStyles() and builds a ParserOutput object. (This is a bit hacky
79 * @return ParserOutput
81 public function getBodyOutput() {
82 $body = parent
::getBody();
84 $pout = new ParserOutput
;
85 $pout->setText( $body );
86 $pout->addModuleStyles( $this->getModuleStyles() );
91 * Get the formatted result list, with navigation bars.
93 * Calls getBody(), getNavigationBar() and getModuleStyles() and
94 * builds a ParserOutput object. (This is a bit hacky but works well.)
97 * @return ParserOutput
99 public function getFullOutput() {
100 $navigation = $this->getNavigationBar();
101 $body = parent
::getBody();
103 $pout = new ParserOutput
;
104 $pout->setText( $navigation . $body . $navigation );
105 $pout->addModuleStyles( $this->getModuleStyles() );
113 function getStartBody() {
115 $sortClass = $this->getSortHeaderClass();
118 $fields = $this->getFieldNames();
121 foreach ( $fields as $field => $name ) {
122 if ( strval( $name ) == '' ) {
123 $s .= Html
::rawElement( 'th', array(), ' ' ) . "\n";
124 } elseif ( $this->isFieldSortable( $field ) ) {
125 $query = array( 'sort' => $field, 'limit' => $this->mLimit
);
126 if ( $field == $this->mSort
) {
127 # This is the sorted column
128 # Prepare a link that goes in the other sort order
129 if ( $this->mDefaultDirection
) {
131 $image = 'Arr_d.png';
134 $alt = $this->msg( 'descending_abbrev' )->escaped();
137 $image = 'Arr_u.png';
139 $query['desc'] = '1';
140 $alt = $this->msg( 'ascending_abbrev' )->escaped();
142 $image = "$wgStylePath/common/images/$image";
143 $link = $this->makeLink(
144 Html
::element( 'img', array( 'width' => 12, 'height' => 12,
145 'alt' => $alt, 'src' => $image ) ) . htmlspecialchars( $name ), $query );
146 $s .= Html
::rawElement( 'th', array( 'class' => $sortClass ), $link ) . "\n";
148 $s .= Html
::rawElement( 'th', array(),
149 $this->makeLink( htmlspecialchars( $name ), $query ) ) . "\n";
152 $s .= Html
::element( 'th', array(), $name ) . "\n";
156 $tableClass = $this->getTableClass();
157 $ret = Html
::openElement( 'table', array(
158 'class' => "mw-datatable $tableClass" )
160 $ret .= Html
::rawElement( 'thead', array(), Html
::rawElement( 'tr', array(), "\n" . $s . "\n" ) );
161 $ret .= Html
::openElement( 'tbody' ) . "\n";
170 function getEndBody() {
171 return "</tbody></table>\n";
178 function getEmptyBody() {
179 $colspan = count( $this->getFieldNames() );
180 $msgEmpty = $this->msg( 'table_pager_empty' )->text();
181 return Html
::rawElement( 'tr', array(),
182 Html
::element( 'td', array( 'colspan' => $colspan ), $msgEmpty ) );
187 * @param stdClass $row
188 * @return string HTML
190 function formatRow( $row ) {
191 $this->mCurrentRow
= $row; // In case formatValue etc need to know
192 $s = Html
::openElement( 'tr', $this->getRowAttrs( $row ) ) . "\n";
193 $fieldNames = $this->getFieldNames();
195 foreach ( $fieldNames as $field => $name ) {
196 $value = isset( $row->$field ) ?
$row->$field : null;
197 $formatted = strval( $this->formatValue( $field, $value ) );
199 if ( $formatted == '' ) {
200 $formatted = ' ';
203 $s .= Html
::rawElement( 'td', $this->getCellAttrs( $field, $value ), $formatted ) . "\n";
206 $s .= Html
::closeElement( 'tr' ) . "\n";
212 * Get a class name to be applied to the given row.
216 * @param object $row The database result row
219 function getRowClass( $row ) {
224 * Get attributes to be applied to the given row.
228 * @param object $row The database result row
229 * @return array Array of attribute => value
231 function getRowAttrs( $row ) {
232 $class = $this->getRowClass( $row );
233 if ( $class === '' ) {
234 // Return an empty array to avoid clutter in HTML like class=""
237 return array( 'class' => $this->getRowClass( $row ) );
242 * Get any extra attributes to be applied to the given cell. Don't
243 * take this as an excuse to hardcode styles; use classes and
244 * CSS instead. Row context is available in $this->mCurrentRow
248 * @param string $field The column
249 * @param string $value The cell contents
250 * @return array Array of attr => value
252 function getCellAttrs( $field, $value ) {
253 return array( 'class' => 'TablePager_col_' . $field );
260 function getIndexField() {
268 function getTableClass() {
276 function getNavClass() {
277 return 'TablePager_nav';
284 function getSortHeaderClass() {
285 return 'TablePager_sort';
289 * A navigation bar with images
290 * @return string HTML
292 public function getNavigationBar() {
293 if ( !$this->isNavigationBarShown() ) {
298 'first' => 'table_pager_first',
299 'prev' => 'table_pager_prev',
300 'next' => 'table_pager_next',
301 'last' => 'table_pager_last',
304 $linkTexts = array();
305 $disabledTexts = array();
306 foreach ( $labels as $type => $label ) {
307 $msgLabel = $this->msg( $label )->escaped();
308 $linkTexts[$type] = "<div class='TablePager_nav-enabled'>$msgLabel</div>";
309 $disabledTexts[$type] = "<div class='TablePager_nav-disabled'>$msgLabel</div>";
311 $links = $this->getPagingLinks( $linkTexts, $disabledTexts );
313 $s = Html
::openElement( 'table', array( 'class' => $this->getNavClass() ) );
314 $s .= Html
::openElement( 'tr' ) . "\n";
315 $width = 100 / count( $links ) . '%';
316 foreach ( $labels as $type => $label ) {
317 // We want every cell to have the same width. We could use table-layout: fixed; in CSS,
318 // but it only works if we specify the width of a cell or the table and we don't want to.
319 // There is no better way. <http://www.w3.org/TR/CSS2/tables.html#fixed-table-layout>
320 $s .= Html
::rawElement( 'td',
321 array( 'style' => "width: $width;", 'class' => "TablePager_nav-$type" ),
322 $links[$type] ) . "\n";
324 $s .= Html
::closeElement( 'tr' ) . Html
::closeElement( 'table' ) . "\n";
329 * ResourceLoader modules that must be loaded to provide correct styling for this pager
333 public function getModuleStyles() {
334 return array( 'mediawiki.pager.tablePager' );
338 * Get a "<select>" element which has options for each of the allowed limits
340 * @param string $attribs Extra attributes to set
341 * @return string HTML fragment
343 public function getLimitSelect( $attribs = array() ) {
344 $select = new XmlSelect( 'limit', false, $this->mLimit
);
345 $select->addOptions( $this->getLimitSelectList() );
346 foreach ( $attribs as $name => $value ) {
347 $select->setAttribute( $name, $value );
349 return $select->getHTML();
353 * Get a list of items to show in a "<select>" element of limits.
354 * This can be passed directly to XmlSelect::addOptions().
359 public function getLimitSelectList() {
360 # Add the current limit from the query string
361 # to avoid that the limit is lost after clicking Go next time
362 if ( !in_array( $this->mLimit
, $this->mLimitsShown
) ) {
363 $this->mLimitsShown
[] = $this->mLimit
;
364 sort( $this->mLimitsShown
);
367 foreach ( $this->mLimitsShown
as $key => $value ) {
368 # The pair is either $index => $limit, in which case the $value
369 # will be numeric, or $limit => $text, in which case the $value
371 if ( is_int( $value ) ) {
373 $text = $this->getLanguage()->formatNum( $limit );
378 $ret[$text] = $limit;
384 * Get \<input type="hidden"\> elements for use in a method="get" form.
385 * Resubmits all defined elements of the query string, except for a
386 * blacklist, passed in the $blacklist parameter.
388 * @param array $blacklist Parameters from the request query which should not be resubmitted
389 * @return string HTML fragment
391 function getHiddenFields( $blacklist = array() ) {
392 $blacklist = (array)$blacklist;
393 $query = $this->getRequest()->getQueryValues();
394 foreach ( $blacklist as $name ) {
395 unset( $query[$name] );
398 foreach ( $query as $name => $value ) {
399 $s .= Html
::hidden( $name, $value ) . "\n";
405 * Get a form containing a limit selection dropdown
407 * @return string HTML fragment
409 function getLimitForm() {
412 return Html
::rawElement(
416 'action' => $wgScript
418 "\n" . $this->getLimitDropdown()
423 * Gets a limit selection dropdown
427 function getLimitDropdown() {
428 # Make the select with some explanatory text
429 $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();
431 return $this->msg( 'table_pager_limit' )
432 ->rawParams( $this->getLimitSelect() )->escaped() .
433 "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
434 $this->getHiddenFields( array( 'limit' ) );
438 * Return true if the named field should be sortable by the UI, false
441 * @param string $field
443 abstract function isFieldSortable( $field );
446 * Format a table cell. The return value should be HTML, but use an empty
447 * string not   for empty cells. Do not include the <td> and </td>.
449 * The current result row is available as $this->mCurrentRow, in case you
454 * @param string $name The database field name
455 * @param string $value The value retrieved from the database
457 abstract function formatValue( $name, $value );
460 * The database field name used as a default sort order.
466 abstract function getDefaultSort();
469 * An array mapping database field names to a textual description of the
470 * field name, for use in the table header. The description should be plain
471 * text, it will be HTML-escaped later.
475 abstract function getFieldNames();