<?php

if (!defined('MEDIAWIKI')) {
    die(-1);
}

/**
 * Use TablePager for prettified Transactions listing. 
 */
class SkinzamTablePager extends TablePager {
    # Fields to be redeclared for default behavior

    protected $selectTables; # Array
    protected $selectFields = '*'; # Array
    protected $selectConds = array(); # Array
    protected $selectOptions = array();
    protected $selectJoinConditions = array();
    protected $sortableFields = '*'; # Array
    protected $tableClasses = array(); # Array
    protected $defaultSort; # String (field)
    public $mDefaultDirection = true; # Boolean (true=decrescent)
    public $forceDefaultLimit = 10; # if > 0 use instead of $wgUser->getOption( 'rclimit' )
    protected $messagesPrefix = 'sz-'; # String
    # Do not redeclare
    protected $fieldNames = null; # The main array fieldName => i18n
    protected $fieldFullNames = null; # Fallback array fieldName => fieldFullName for offset
    private $defaultTableClasses = array('TablePager');
    protected $even = true;
    private $header = '';
    private $footer = '';

    public function __construct() {
        parent::__construct();
        if ($this->forceDefaultLimit > 0)
            list( $this->mLimit, /* $offset */ ) = $this->mRequest->getLimitOffset($this->forceDefaultLimit, '');
    }

    /**
     * ABSTRACT! Can be redeclared, don't forget to call parent and merge results.
     * Format a table cell. The return value should be HTML, but use an empty
     * string not &#160; for empty cells. Do not include the <td> and </td>.
     *
     * The current result row is available as $this->mCurrentRow, in case you
     * need more context.
     *
     * @param $name String: the database field name
     * @param $value String: the value retrieved from the database
     */
    function formatValue($name, $value) {
        return $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
     *
     * @param $field The column
     * @param $value The cell contents
     * @return Associative array
     */
    function getCellAttrs($field, $value) {
        $classes = $this->getCellClasses($field, $value);
        $classes[] = $field;

        return array('class' => implode(' ', $classes));
    }

    /**
     * SEMI-ABSTRACT! Can be redeclared, don't forget to call parent and merge results.
     * Get array of class names to be applied to the given row.
     *
     * @param $row Object: the database result row
     * @return Array
     */
    function getCellClasses($field, $value) {
        return array();
    }

    /**
     * Get class names to be applied to the given row.
     *
     * @param $row Object: the database result row
     * @return Array
     */
    function getRowAttrs($row) {
        $classes = $this->getRowClasses($row);

        # Apply class="even" to every even row (theader included)
        if ($this->even)
            $classes[] = 'mw-line-even';
        else
            $classes[] = 'mw-line-odd';
        $this->even = !$this->even;

        return array('class' => implode(' ', $classes));
    }

    /**
     * SEMI-ABSTRACT! Can be redeclared.
     * Get array of class names to be applied to the given row.
     *
     * @param $row Object: the database result row
     * @return Array
     */
    function getRowClasses($row) {
        return array();
    }

    /**
     * Use this function to pass the name of db tables
     * 
     * @param string $selectTable 
     */
    public function setSelectTables($selectTables) {
        $this->selectTables = $selectTables;
    }

    /**
     * Use this function to pass an array of fields to be displayed ('*' for all).
     * 
     * @param array $selectFields 
     */
    public function setSelectFields($selectFields) {
        $this->selectFields = $selectFields;
        $this->setFieldNames();
    }

    /**
     * Use this function to pass an array of SQL conditions for the query.
     * 
     * @param array $selectConds 
     */
    public function setSelectConds($selectConds) {
        $this->selectConds = $selectConds;
    }

    /**
     * Use this function to pass an array of SQL options for the query.
     * 
     * @param array $selectOptions 
     */
    public function setSelectOptions($selectOptions) {
        $this->selectOptions = $selectOptions;
    }

    /**
     * Use this function to pass an array of SQL join conditions for the query.
     * 
     * @param array $selectJoinConditions 
     */
    public function setSelectJoinConditions($selectJoinConditions) {
        $this->selectJoinConditions = $selectJoinConditions;
    }

    /**
     * Use this function to pass an array of fields to be made sortable ('*' for all).
     *
     * @param array $sortableFields 
     */
    public function setFieldSortable($sortableFields) {
        $this->sortableFields = $sortableFields;
    }

    /**
     * Determine if $field should be sortable
     * 
     * @param string $field
     * @return boolean 
     */
    function isFieldSortable($field) {
        if (!is_array($this->sortableFields)) {
            if ($this->sortableFields === '*') {
                return true;
            } else {
                return false;
            }
        } else if (in_array($field, $this->sortableFields))
            return true;
    }

    /**
     * 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
     *
     * @return Array
     */
    function getQueryInfo() {
        $infos = array();
        $infos['tables'] = $this->selectTables;
        $infos['fields'] = $this->selectFields;
        $infos['conds'] = $this->selectConds;
        $infos['options'] = $this->selectOptions;
        $infos['join_conds'] = $this->selectJoinConditions;
        return $infos;
    }

    /**
     * Get class names to be applied to table
     * 
     * @return string 
     */
    function getTableClass() {
        return implode(' ', array_merge($this->tableClasses, $this->defaultTableClasses));
    }

    /**
     * Set class names to be applied to table
     * 
     */
    public function setTableClass($classes) {
        if (!is_array($classes))
            $classes = explode(' ', $classes);

        $this->tableClasses = array_merge($this->tableClasses, $classes);
    }

    /**
     * Get default field for sorting
     * 
     */
    function getDefaultSort() {
        return $this->defaultSort;
    }

    /**
     * Set default field for sorting
     * 
     */
    public function setDefaultSort($field) {
        $this->defaultSort = $field;
    }

    function setFieldNames($fieldNames = null) {
        if (is_null($fieldNames))
            foreach ($this->selectFields as $field) {
                $alias = $this->getAliasFromString($field);
                $fieldNames[$alias] = htmlspecialchars($alias);
                $fieldFullNames[$alias] = $field;
            }
        $this->fieldNames = $fieldNames;
        $this->fieldFullNames = $fieldFullNames;
    }

    /**
     *
     * @param String $fieldName
     * @return String The field name without table prefix 
     */
    private function getAliasFromString($fieldName) {
        $burst = explode('.', $fieldName);
        return end($burst);
    }

    /**
     * Get array of field names to be displayed in thead
     * 
     */
    function getFieldNames() {
        if (is_null($this->fieldNames))
            $this->setFieldNames();
        return $this->fieldNames;
    }

    /**
     *
     * @return String FullName of Sort String 
     */
    function getIndexField() {
        return $this->fieldFullNames[$this->getAliasFromString($this->mSort)];
    }

    /**
     * Set prefix for i18n messages
     * 
     */
    public function setMessagesPrefix($prefix) {
        $this->messagesPrefix = $prefix;
    }

    /**
     * Set Header Text
     *
     * @param string $html 
     */
    public function setHeader($html) {
        $this->header = Html::rawElement('div', array('class' => 'table_header informations'), $html);
    }

    /**
     * Set Footer Text
     *
     * @param string $html 
     */
    public function setFooter($html) {
        $this->footer = Html::rawElement('div', array('class' => 'table_footer informations'), $html);
    }

    /**
     *
     * @return string 
     */
    public function getHeader() {
        return $this->header;
    }

    /**
     *
     * @return string 
     */
    public function getFooter() {
        return $this->footer;
    }

    /**
     *
     * @param String $html
     * @return String 
     */
    public function makeHeader($html) {
        $this->setHeader($html);
        return $this->header;
    }

    /**
     *
     * @param String $html
     * @return String 
     */
    public function makeFooter($html) {
        $this->setFooter($html);
        return $this->footer;
    }

    /**
     * Easy Form Printout
     *
     * @return string 
     */
    public function getWholeHtml() {
        return $this->getHeader()
                . $this->getBody()
                . $this->getNavigationBar()
                . $this->getFooter();
    }

}