TablePager.php

Go to the documentation of this file.

<?php
abstract class TablePager extends IndexPager {
    protected $mSort;

    protected $mCurrentRow;

    public function __construct( IContextSource $context = null ) {
        if ( $context ) {
            $this->setContext( $context );
        }

        $this->mSort = $this->getRequest()->getText( 'sort' );
        if ( !array_key_exists( $this->mSort, $this->getFieldNames() )
            || !$this->isFieldSortable( $this->mSort )
        ) {
            $this->mSort = $this->getDefaultSort();
        }
        if ( $this->getRequest()->getBool( 'asc' ) ) {
            $this->mDefaultDirection = IndexPager::DIR_ASCENDING;
        } elseif ( $this->getRequest()->getBool( 'desc' ) ) {
            $this->mDefaultDirection = IndexPager::DIR_DESCENDING;
        } /* Else leave it at whatever the class default is */

        parent::__construct();
    }

    final public function getBody() {
        $this->getOutput()->addModuleStyles( $this->getModuleStyles() );
        return parent::getBody();
    }

    public function getBodyOutput() {
        $body = parent::getBody();

        $pout = new ParserOutput;
        $pout->setText( $body );
        $pout->addModuleStyles( $this->getModuleStyles() );
        return $pout;
    }

    public function getFullOutput() {
        $navigation = $this->getNavigationBar();
        $body = parent::getBody();

        $pout = new ParserOutput;
        $pout->setText( $navigation . $body . $navigation );
        $pout->addModuleStyles( $this->getModuleStyles() );
        return $pout;
    }

    function getStartBody() {
        $sortClass = $this->getSortHeaderClass();

        $s = '';
        $fields = $this->getFieldNames();

        // Make table header
        foreach ( $fields as $field => $name ) {
            if ( strval( $name ) == '' ) {
                $s .= Html::rawElement( 'th', array(), '&#160;' ) . "\n";
            } elseif ( $this->isFieldSortable( $field ) ) {
                $query = array( 'sort' => $field, 'limit' => $this->mLimit );
                $linkType = null;
                $class = null;

                if ( $this->mSort == $field ) {
                    // The table is sorted by this field already, make a link to sort in the other direction
                    // We don't actually know in which direction other fields will be sorted by default…
                    if ( $this->mDefaultDirection == IndexPager::DIR_DESCENDING ) {
                        $linkType = 'asc';
                        $class = "$sortClass TablePager_sort-descending";
                        $query['asc'] = '1';
                        $query['desc'] = '';
                    } else {
                        $linkType = 'desc';
                        $class = "$sortClass TablePager_sort-ascending";
                        $query['asc'] = '';
                        $query['desc'] = '1';
                    }
                }

                $link = $this->makeLink( htmlspecialchars( $name ), $query, $linkType );
                $s .= Html::rawElement( 'th', array( 'class' => $class ), $link ) . "\n";
            } else {
                $s .= Html::element( 'th', array(), $name ) . "\n";
            }
        }

        $tableClass = $this->getTableClass();
        $ret = Html::openElement( 'table', array(
            'class' => "mw-datatable $tableClass" )
        );
        $ret .= Html::rawElement( 'thead', array(), Html::rawElement( 'tr', array(), "\n" . $s . "\n" ) );
        $ret .= Html::openElement( 'tbody' ) . "\n";

        return $ret;
    }

    function getEndBody() {
        return "</tbody></table>\n";
    }

    function getEmptyBody() {
        $colspan = count( $this->getFieldNames() );
        $msgEmpty = $this->msg( 'table_pager_empty' )->text();
        return Html::rawElement( 'tr', array(),
            Html::element( 'td', array( 'colspan' => $colspan ), $msgEmpty ) );
    }

    function formatRow( $row ) {
        $this->mCurrentRow = $row; // In case formatValue etc need to know
        $s = Html::openElement( 'tr', $this->getRowAttrs( $row ) ) . "\n";
        $fieldNames = $this->getFieldNames();

        foreach ( $fieldNames as $field => $name ) {
            $value = isset( $row->$field ) ? $row->$field : null;
            $formatted = strval( $this->formatValue( $field, $value ) );

            if ( $formatted == '' ) {
                $formatted = '&#160;';
            }

            $s .= Html::rawElement( 'td', $this->getCellAttrs( $field, $value ), $formatted ) . "\n";
        }

        $s .= Html::closeElement( 'tr' ) . "\n";

        return $s;
    }

    function getRowClass( $row ) {
        return '';
    }

    function getRowAttrs( $row ) {
        $class = $this->getRowClass( $row );
        if ( $class === '' ) {
            // Return an empty array to avoid clutter in HTML like class=""
            return array();
        } else {
            return array( 'class' => $this->getRowClass( $row ) );
        }
    }

    function getCellAttrs( $field, $value ) {
        return array( 'class' => 'TablePager_col_' . $field );
    }

    function getIndexField() {
        return $this->mSort;
    }

    function getTableClass() {
        return 'TablePager';
    }

    function getNavClass() {
        return 'TablePager_nav';
    }

    function getSortHeaderClass() {
        return 'TablePager_sort';
    }

    public function getNavigationBar() {
        if ( !$this->isNavigationBarShown() ) {
            return '';
        }

        $labels = array(
            'first' => 'table_pager_first',
            'prev' => 'table_pager_prev',
            'next' => 'table_pager_next',
            'last' => 'table_pager_last',
        );

        $linkTexts = array();
        $disabledTexts = array();
        foreach ( $labels as $type => $label ) {
            $msgLabel = $this->msg( $label )->escaped();
            $linkTexts[$type] = "<div class='TablePager_nav-enabled'>$msgLabel</div>";
            $disabledTexts[$type] = "<div class='TablePager_nav-disabled'>$msgLabel</div>";
        }
        $links = $this->getPagingLinks( $linkTexts, $disabledTexts );

        $s = Html::openElement( 'table', array( 'class' => $this->getNavClass() ) );
        $s .= Html::openElement( 'tr' ) . "\n";
        $width = 100 / count( $links ) . '%';
        foreach ( $labels as $type => $label ) {
            // We want every cell to have the same width. We could use table-layout: fixed; in CSS,
            // but it only works if we specify the width of a cell or the table and we don't want to.
            // There is no better way. <http://www.w3.org/TR/CSS2/tables.html#fixed-table-layout>
            $s .= Html::rawElement( 'td',
                array( 'style' => "width: $width;", 'class' => "TablePager_nav-$type" ),
                $links[$type] ) . "\n";
        }
        $s .= Html::closeElement( 'tr' ) . Html::closeElement( 'table' ) . "\n";
        return $s;
    }

    public function getModuleStyles() {
        return array( 'mediawiki.pager.tablePager' );
    }

    public function getLimitSelect( $attribs = array() ) {
        $select = new XmlSelect( 'limit', false, $this->mLimit );
        $select->addOptions( $this->getLimitSelectList() );
        foreach ( $attribs as $name => $value ) {
            $select->setAttribute( $name, $value );
        }
        return $select->getHTML();
    }

    public function getLimitSelectList() {
        # Add the current limit from the query string
        # to avoid that the limit is lost after clicking Go next time
        if ( !in_array( $this->mLimit, $this->mLimitsShown ) ) {
            $this->mLimitsShown[] = $this->mLimit;
            sort( $this->mLimitsShown );
        }
        $ret = array();
        foreach ( $this->mLimitsShown as $key => $value ) {
            # The pair is either $index => $limit, in which case the $value
            # will be numeric, or $limit => $text, in which case the $value
            # will be a string.
            if ( is_int( $value ) ) {
                $limit = $value;
                $text = $this->getLanguage()->formatNum( $limit );
            } else {
                $limit = $key;
                $text = $value;
            }
            $ret[$text] = $limit;
        }
        return $ret;
    }

    function getHiddenFields( $blacklist = array() ) {
        $blacklist = (array)$blacklist;
        $query = $this->getRequest()->getQueryValues();
        foreach ( $blacklist as $name ) {
            unset( $query[$name] );
        }
        $s = '';
        foreach ( $query as $name => $value ) {
            $s .= Html::hidden( $name, $value ) . "\n";
        }
        return $s;
    }

    function getLimitForm() {
        return Html::rawElement(
            'form',
            array(
                'method' => 'get',
                'action' => wfScript(),
            ),
            "\n" . $this->getLimitDropdown()
        ) . "\n";
    }

    function getLimitDropdown() {
        # Make the select with some explanatory text
        $msgSubmit = $this->msg( 'table_pager_limit_submit' )->escaped();

        return $this->msg( 'table_pager_limit' )
            ->rawParams( $this->getLimitSelect() )->escaped() .
            "\n<input type=\"submit\" value=\"$msgSubmit\"/>\n" .
            $this->getHiddenFields( array( 'limit' ) );
    }

    abstract function isFieldSortable( $field );

    abstract function formatValue( $name, $value );

    abstract function getDefaultSort();

    abstract function getFieldNames();
}