tk2/components/TKPagedView.php5

<?php

class TKPagedView extends TKContainer {
    private $callback = null;
    private $name = null;
    private $useAjax = false;
    private $saveState = false;
    private $tableId = '';

    public function __construct($name, $callback, $useAjax = false, $saveState = false) {
        parent::__construct();

        $this->callback = $callback;

        $this->name = $name;
        $this->useAjax = $useAjax;
        $this->saveState = $saveState;

        $this->setId('pagedView_' . $this->name);

        $this->addProperty('offset', self::PROP_NUMERIC);
        $this->addProperty('perPage', self::PROP_NUMERIC);
        $this->addProperty('sortBy', self::PROP_STRING);
        $this->addProperty('sortOrder', self::PROP_STRING);
        $this->addProperty('maxPerPage', self::PROP_NUMERIC);
        $this->addProperty('perPageInterval', self::PROP_NUMERIC);
        $this->addProperty('sortFields', self::PROP_ARRAY);
        $this->addProperty('headers', self::PROP_ARRAY);
        $this->addProperty('title', self::PROP_STRING);
        $this->addProperty('tableObjectClass', self::PROP_STRING);
        $this->addProperty('scrollable', self::PROP_BOOLEAN);
        $this->addProperty('animate', self::PROP_BOOLEAN);
        $this->addProperty('bottomNav', self::PROP_BOOLEAN);
        $this->addProperty('advancedNav', self::PROP_BOOLEAN);
        $this->addProperty('scrollHeight', self::PROP_STRING);
        $this->addProperty('scrollWidth', self::PROP_STRING);

        $this->addProperty('header_class', self::PROP_CLASS);
        $this->addProperty('count_class', self::PROP_CLASS);
        $this->addProperty('navigation_class', self::PROP_CLASS);
        $this->addProperty('nav_button_class', self::PROP_CLASS);
        $this->addProperty('nav_button_disabled_class', self::PROP_CLASS);
        $this->addProperty('nav_select_class', self::PROP_CLASS);
        $this->addProperty('nav_label_class', self::PROP_CLASS);
        $this->addProperty('table_class', self::PROP_CLASS);
        $this->addProperty('no_results_class', self::PROP_CLASS);

        $this->offset = isset($_REQUEST[$name . '_offset']) && ctype_digit((string) $_REQUEST[$name . '_offset'])
                                && $_REQUEST[$name . '_offset'] > 0 ? $_REQUEST[$name . '_offset'] : 0;

        $this->maxPerPage = 400;
        $this->perPageInterval = 25;
        $this->perPage = 25;
        $this->tableObjectClass = 'TKTable';
        $this->scrollHeight = '400px';
        $this->scrollWidth = '100%';
        $this->sortOrder = 'ASC';

        if($useAjax && $this->saveState && isset($_SESSION['PV_CONFIG_' . $this->name])) {
            $session = unserialize($_SESSION['PV_CONFIG_' . $this->name]);
            $this->offset = $session['offset'];
            $this->perPage = $session['perPage'];
            $this->sortBy = $session['sortBy'];
            $this->sortOrder = $session['sortOrder'];
        }
    }

    protected function build() {
        $cb = $this->callback;
        if(!is_callable($cb)) {
            $this->setError('Populate callback is not a valid callback!');
            return false;
        }

        if($this->sortBy == '' && count($this->sortFields) > 0)
            $this->sortBy = $this->sortFields[0];
        if($this->sortOrder !== 'ASC' && $this->sortOrder !== 'DESC')
            $this->sortOrder = 'ASC';

        list($data, $total) = call_user_func($cb, $this->name, $this->offset, $this->perPage, $this->sortBy, $this->sortOrder);
        if($data === false) {
            $this->setError('Failed to populate view!');
            return false;
        }

        $header = $this->buildHeader();
        $this->add($header);
        if(count($data) == 0) {
            $nrClass = Toolkit::classToString($this->no_results_class);
            $this->addText("<div$nrClass>No results</div>");
            return true;
        }

        if($this->offset >= $total)
            $this->offset = $total - ($total % $this->perPage);
        $start = $this->offset;
        $end = ($this->offset + $this->perPage > $total ? $total : $this->offset + $this->perPage);

        $posLabel = $this->buildPositionLabel($start, $end, $total);
        $table = $this->buildTable($data);
        $upperBBox = $this->buildButtonBox($start, $end, $total, 1);
        if($this->bottomNav)
            $lowerBBox = $this->buildButtonBox($start, $end, $total, 2);

        $this->add($posLabel);
        $this->add($upperBBox);
        $this->add($table);
        if($this->bottomNav)
            $this->add($lowerBBox);

        return true;
    }

    protected function buildHeader() {
        if(count($this->header_class) > 0)
            $class = ' class="' . implode(' ', $this->header_class) . '"';
        else
            $class = '';
        $header = new TKLabel('<h3' . $class . '>' . $this->title . '</h3>');
        $header->class += $this->header_class;
        return $header;
    }

    protected function buildPositionLabel($start, $end, $total) {
        $dStart = $start + 1;
        $dEnd = $end;
        if($dEnd > $total)
            $dEnd = $total;
        $label = new TKLabel("$dStart to $dEnd of $total");
        $label->class += $this->count_class;
        return $label;
    }

    protected function buildButtonBox($start, $end, $total, $number) {
        $hbox = new TKHBox();
        $hbox->append('class', $this->navigation_class);

        $this->buildPageSelector($start, $end, $total, $number, $hbox);
        if($this->advancedNav) {
            $this->buildResultsPerPageSelector($start, $end, $total, $number, $hbox);
            if(count($this->sortFields) > 0)
                $this->buildSortSelector($start, $end, $total, $number, $hbox);
        }

        return $hbox;
    }

    protected function buildPageSelector($start, $end, $total, $number, $hbox) {
        $totalPages = ceil($total / $this->perPage);
        $curPage = floor($start / $this->perPage);

        $navButtonC = $this->getTranslatedClass('nav_button');
        $navMixedC = $this->getTranslatedClass('nav_button_disabled');

        if($this->offset > 0) {
            if($this->useAjax) {
                $hbox->addLabel('<a href="javascript:void(0)"' . $navButtonC
                        . '>&lt;&lt;</a>')->onclick = $this->buildAjax(0);
                $hbox->addLabel('<a href="javascript:void(0)"' . $navButtonC
                        . '>&lt;</a>')->onclick = $this->buildAjax($start - $this->perPage);
            }
            else {
                $hbox->addText('<a href="' . $this->buildURL(0) . '"' . $navButtonC . '>&lt;&lt;</a>');
                $hbox->addText('<a href="' . $this->buildURL($start - $this->perPage) . '"' . $navButtonC . '>&lt;</a>');
            }
        }
        else {
            $hbox->addText('<span' . $navMixedC . '>&lt;&lt;</span>');
            $hbox->addText('<span' . $navMixedC . '>&lt;</span>');
        }

        $min = $curPage - 2 < 0 ? 0 : $curPage - 2;
        $max = $curPage + 2 >= $totalPages ? $totalPages - 1 : $curPage + 2;
        if($min > 0)
            $hbox->addText('<span' . $navMixedC . '>...</span>');
        for($i = $min; $i <= $max; $i++) {
            if($i == $curPage)
                $hbox->addText('<span' . $navMixedC . '>' . ($i + 1) . '</span>');
            else {
                if($this->useAjax)
                    $hbox->addLabel('<a href="javascript:void(0)"' . $navButtonC
                                        . '>' . ($i + 1) . '</a>')->onclick = $this->buildAjax($i * $this->perPage);
                else
                    $hbox->addText("<a href=\"" . $this->buildURL($i * $this->perPage) . '"'
                                        . $navButtonC . '>' . ($i + 1) . '</a>');
            }
        }
        if($max < $totalPages - 1)
            $hbox->addText('<span' . $navMixedC . '>...</span>');

        if($end < $total) {
            $endPage = intval($total / $this->perPage) * $this->perPage;
            if($endPage == $total)
                $endPage -= $this->perPage;
            if($this->useAjax) {
                $hbox->addLabel('<a href="javascript:void(0)"' . $navButtonC
                        . '>&gt;</a>')->onclick = $this->buildAjax($start + $this->perPage);
                $hbox->addLabel('<a href="javascript:void(0)"' . $navButtonC
                        . '>&gt;&gt;</a>')->onclick = $this->buildAjax($endPage);
            }
            else {
                $hbox->addText('<a href="' . $this->buildURL($start + $this->perPage) . '"' . $navButtonC
                        . '>&gt;</a>');
                $hbox->addText('<a href="' . $this->buildURL($endPage) . '"' . $navButtonC
                        . '>&gt;&gt;</a>');
            }
        }
        else {
            $hbox->addText('<span' . $navMixedC . '>&gt;</span>');
            $hbox->addText('<span' . $navMixedC . '>&gt;&gt;</span>');
        }
    }

    protected function buildResultsPerPageSelector($start, $end, $total, $number, $hbox) {
        $select = new TKSelect('ResultsPerPage');

        $maxPerPage = min($this->maxPerPage, ($total % $this->perPageInterval == 0 ? $total : $total +  $this->perPageInterval));
        for($i = $this->perPageInterval; $i <= $maxPerPage; $i += $this->perPageInterval) {
            $select->addOption($i, $i);
        }
        $select->selected = $this->perPage;

        $select->onchange = "Toolkit.PagedView['{$this->getId()}'].value = this.options[this.selectedIndex].value;"
            . $this->buildAjax("Toolkit.PagedView['{$this->getId()}'].value * Math.floor(" . $this->offset
            . " / Toolkit.PagedView['{$this->getId()}'].value)", "Toolkit.PagedView['{$this->getId()}'].value");
        $form = <<<END_FORM
            {$select->render()}
            <label for="{$select->getId()}"> results per page</label>
END_FORM;
        $hbox->addText($form);
    }

    protected function buildSortSelector($start, $end, $total, $number, $hbox) {
        $sortSelect = new TKSelect('SortBy');
        $sortSelect->class += $this->nav_select_class;

        foreach($this->sortFields as $i => $field)
            $sortSelect->addOption($field, $field);
        $sortSelect->selected = $this->sortBy;

        $sortSelect->onchange = "Toolkit.doPagedView('{$this->getId()}', '{$this->name}', '{$this->offset}', '{$this->offset}',"
                                . "'{$this->perPage}', this.options[this.selectedIndex].value, '{$this->sortOrder}')";

        $orderSelect = new TKSelect('Ordering');
        $orderSelect->class += $this->nav_select_class;
        $orderSelect->addOption('ASC', 'Ascending');
        $orderSelect->addOption('DESC', 'Descending');
        $orderSelect->selected = $this->sortOrder;

        $orderSelect->onchange = "Toolkit.doPagedView('{$this->getId()}', '{$this->name}', '{$this->offset}', '{$this->offset}',"
                                . "'{$this->perPage}', '{$this->sortBy}', this.options[this.selectedIndex].value)";

        $labelClass = $this->getTranslatedClass('nav_label');

        $form = <<<END_FORM
        <label $labelClass for="{$sortSelect->getId()}">, sorted by</label>
        {$sortSelect->render()}
        <label $labelClass for="{$orderSelect->getId()}">in</label>
        {$orderSelect->render()}
        <label $labelClass for="{$orderSelect->getId()}">order</label>
END_FORM;
        $hbox->addText($form);
    }

    private function buildURL($offset) {
        $info = parse_url($_SERVER['REQUEST_URI']);
        if(isset($info['query']))
            parse_str($info['query'], $vars);
        else
            $vars = array();
        $pos = strpos($_SERVER['REQUEST_URI'], '?');
        if($pos === false)
            $uriBase = $_SERVER['REQUEST_URI'];
        else
            $uriBase = substr($_SERVER['REQUEST_URI'], 0, $pos);

        if($offset > 0)
            $vars[$this->name . '_offset'] = $offset;
        else
            unset($vars[$this->name . '_offset']);

        if($this->sortBy != '')
            $vars[$this->name . '_sortBy'] = $this->sortBy;
        else
            unset($vars[$this->name . '_sortBy']);

        $ret = http_build_query($vars);
        if($ret != '')
            $ret = $uriBase . '?' . $ret;
        else
            $ret = $uriBase;

        return $ret;
    }

    private function buildAjax($offset, $perPage = null) {
        $id = $this->getId();

        if(is_null($perPage))
            $perPage = $this->perPage;

        return "Toolkit.doPagedView('$id', '{$this->name}', '{$this->offset}', $offset, $perPage, '{$this->sortBy}')";
    }

    protected function buildTable($data) {
        if(count($data) == 0)
            return new TKLabel("<p><i>No results</i></p>");

        $tableObjectClass = $this->tableObjectClass;
        // no safe way to protect this from failing if $tableObjectClass is invalid
        //  so we'll just let the script abort (should be a developer error anyways
        //  so not a concern for users...fingers crossed)
        $table = new $tableObjectClass(false);

        $table->class = 'tkPagedListingTable';
        $table->append('class', $this->table_class);
        $table->style['margin-bottom'] = 0;

        foreach($this->headers as $header) {
            if(is_array($header)) {
                $hName = key($header);
                $hColspan = current($header);
                $table->addTextTo('header', $hName, array('colspan' => $hColspan));
            }
            else
                $table->addTextTo('header', $header);
        }

        foreach($data as $row) {
            $table->addRow();
            foreach($row as $cell) {
                if(is_string($cell) || ctype_digit((string) $cell))
                    $table->addText($cell);
                else if(is_object($cell) && $cell instanceof TKComponent)
                    $table->add($cell);
                else if(is_array($cell)) {
                    $params = array();
                    if(isset($cell['colspan']))
                        $params['colspan'] = $cell['colspan'];
                    if(isset($cell['style']))
                        $params['style'] = $cell['style'];
                    if(isset($cell['class']))
                        $params['class'] = $cell['class'];
                    if(is_string($cell[0]) || ctype_digit((string) $cell[0]))
                        $table->addText($cell[0], $params);
                    else if(is_object($cell[0]) && $cell instanceof TKComponent)
                        $table->add($cell[0], $params);
                    else
                        $table->addText('&nbsp;', $params);
                }
                else
                    $table->addText('&nbsp;');
            }
        }

        if($this->scrollable) {
            $sv = new TKScrollPane();
            $sv->style['height'] = $this->scrollHeight;
            $sv->style['width'] = $this->scrollWidth;
            $sv->add($table);
            $ret = $sv;
        }
        else
            $ret = $table;
        $ret->setId($this->name . '_table_' . $this->offset);
        if($this->animate && isset($_REQUEST[$this->name . '_isAjax']))
            $ret->style['opacity'] = '0';
        else
            $ret->style['opacity'] = '100';
        return $ret;
    }

    protected function renderContainer($class, $style, $events, $id) {
        $this->build();

        $html = "<div $id$class[0]$style[0]$events>";

        foreach($this->getChildrenBySlot('main') as $cid => $comp) {
            if(is_object($comp))
                $html .= $comp->render();
            else
                $html .= $comp;
        }

        $html .= '</div>';

        if($this->useAjax && !Toolkit::issetJS('tk2_doPagedView')) {
            $js = <<<END_JAVASCRIPT
Toolkit.PagedView = {};
Toolkit.doPagedView = function(id, name, oldOffset, offset, perPage, sortBy, sortOrder) {
    var params = {};
    params[name + '_isAjax'] = true;
    params[name + '_offset'] = offset;
    params[name + '_perPage'] = perPage;
    params[name + '_sortBy'] = sortBy;
    params[name + '_sortOrder'] = sortOrder;
    new Ajax.Request('$_SERVER[REQUEST_URI]', {
        method: 'post',
        parameters: params,
        onSuccess: function(transport) {
END_JAVASCRIPT;
            if($this->animate) {
                $js .= <<<END_JAVASCRIPT

            new Effect.Opacity(name + '_table_' + oldOffset, { from: 1.0, to: 0, duration: 0.2, afterFinish: function() {
                $(id).replace(transport.responseText);
                new Effect.Opacity(name + '_table_' + offset, { from: 0, to: 1.0, duration: 0.3, queue: 'end' });
            }});
END_JAVASCRIPT;
            }
            else
                $js .= "\t\t\t$(id).update(transport.responseText);\n";
            $js .= <<<END_JAVASCRIPT

        },
        onFailure: function() {
            alert('Something went wrong...');
        }
    });
}
END_JAVASCRIPT;
            Toolkit::globalAddExtraJS('tk2_doPagedView', $js);
            Toolkit::globalAddExtraJS('tk2_doPagedView' . $this->getId(), "Toolkit.PagedView['{$this->getId()}'] = {}");
        }
        else
            Toolkit::globalAddExtraJS('tk2_doPagedView' . $this->getId(), "Toolkit.PagedView['{$this->getId()}'] = {}");

        return $html;
    }

    public function handleAjax() {
        if(!$this->useAjax || !isset($_REQUEST[$this->name . '_isAjax']))
            return;
        STimer::enable(false);
        $this->offset = isset($_REQUEST[$this->name . '_offset']) ? $_REQUEST[$this->name . '_offset'] : 0;
        if(isset($_REQUEST[$this->name . '_perPage'])) {
            $perPage = $_REQUEST[$this->name . '_perPage'];
            if(ctype_digit($perPage) && $perPage % $this->perPageInterval == 0 && $perPage <= $this->maxPerPage)
                $this->perPage = $perPage;
        }
        if(isset($_REQUEST[$this->name . '_sortBy'])) {
            $sortBy = $_REQUEST[$this->name . '_sortBy'];
            if($sortBy != '' && in_array($sortBy, $this->sortFields))
                $this->sortBy = $sortBy;
        }
        if(isset($_REQUEST[$this->name . '_sortOrder'])) {
            $sortOrder = $_REQUEST[$this->name . '_sortOrder'];
            if($sortOrder === 'ASC' || $sortOrder === 'DESC')
                $this->sortOrder = $sortOrder;
        }
        $html = $this->render();
        if($this->saveState) {
            $_SESSION['PV_CONFIG_' . $this->name] = serialize(array('offset' => $this->offset, 'perPage' => $this->perPage,
                                                                'sortBy' => $this->sortBy, 'sortOrder' => $this->sortOrder));
        }
        print $html;
        exit;
    }
}

?>

---