Ticket #261: function.pagination.php

<?php
/**
* @package    jelix
* @subpackage jtpl_plugin
* @author     Loic Mathaud <loic@mathaud.net>
* @copyright  Loic Mathaud 2007
* @contributor Christian Tritten (christian.tritten@laposte.net)
* @copyright  2007 Christian Tritten
* @link        http://www.jelix.org
* @licence    GNU Lesser General Public Licence see LICENCE file or http://www.gnu.org/licenses/lgpl.html
*/

/**
* displays page links
*
* @param jTpl $tpl template engine
* @param string $action selector of the action 
* @param array $actionParams parameters for the action
* @param object $pageCounter jPageCounter object
* @param string $paramName name of the parameter in the actionParams which will content the page number
* @param array $displayProperties properties for the links display
*/
function jtpl_function_html_pagination($tpl, $action, $actionParams,
                $pageCounter, $paramName = 'page', $displayProperties = array()) {


    // If there are at least two pages of results
    if ($pageCounter->getTotalItems() > $pageCounter->getItemsPerPage()) {
        $jUrlEngine = jUrl::getEngine();

        $urlaction = jUrl::get($action, $actionParams, jUrl::JURLACTION);

        $defaultDisplayProperties = array('start-label' => '|&lt;',
                                          'prev-label'  => '&lt;',
                                          'next-label'  => '&gt;',
                                          'end-label'   => '&gt;|',
                                          'area-size'   => 0);

        if (is_array($displayProperties) && count($displayProperties) > 0) {
            $displayProperties = array_merge($defaultDisplayProperties, $displayProperties);
        } else {
            $displayProperties = $defaultDisplayProperties;
        }
        
        $current_page = $pageCounter->getCurrentPage();
        $total_pages = $pageCounter->getTotalPages();  

        // Links display 
        echo '<ul class="pagelinks">';

        // Start and Prev Links
        if ($current_page > 1) {
            // Calculate start page url
            $urlaction->params[$paramName] = 1;
            $urlStartPage = $jUrlEngine->create($urlaction);

            // Calculate previous page url
            $urlaction->params[$paramName] = $current_page - 1;
            $urlPrevPage = $jUrlEngine->create($urlaction);
        
            // Start link
            if (!empty($displayProperties['start-label'])) {
                echo '<li class="pagelinks-start">';
                echo '<a href="', $urlStartPage->toString(true), '">', $displayProperties['start-label'], '</a>';
                echo '</li>', "\n";
            }

            // Previous link
            if (!empty($displayProperties['prev-label'])) {
                echo '<li class="pagelinks-prev">';
                echo '<a href="', $urlPrevPage->toString(true), '">', $displayProperties['prev-label'], '</a>';
                echo '</li>', "\n";
            }
            
            // Prev Area Links
            $area_start = $current_page - $displayProperties['area-size'];
            if ($displayProperties['area-size'] == 0 || $area_start <= 0) {
                $area_start = 1;
            }
            for ($i = $area_start; $i < $current_page; $i++) {
                $urlaction->params[$paramName] = $i;
                $url = $jUrlEngine->create($urlaction);
                echo '<li><a href="', $url->toString(true), '">', $i, '</a></li>', "\n";
            }
        }

        // Current page
        echo '<li class="pagelinks-current">', $current_page, '</li>',"\n";

        // Next and End Links
        if ($current_page < $total_pages) {
            // Next Area Links
            $area_end = $current_page + $displayProperties['area-size'];
            if ($displayProperties['area-size'] == 0 || $area_end > $total_pages) {
                $area_end = $total_pages;
            }
            
            for ($i = $current_page + 1; $i <= $area_end; $i++) {
                $urlaction->params[$paramName] = $i;
                $url = $jUrlEngine->create($urlaction);
                echo '<li><a href="', $url->toString(true), '">', $i, '</a></li>', "\n";
            }
        
            // Calculate next page url
            $urlaction->params[$paramName] = $current_page + 1;
            $urlNextPage = $jUrlEngine->create($urlaction);

            // Calculate end page url
            $urlaction->params[$paramName] = $total_pages;
            $urlEndPage = $jUrlEngine->create($urlaction);

        
            // Next link
            if (!empty($displayProperties['next-label'])) {
                echo '<li class="pagelinks-next">';
                echo '<a href="', $urlNextPage->toString(true), '">', $displayProperties['next-label'], '</a>';
                   echo '</li>', "\n";
            }

            // End link
            if (!empty($displayProperties['end-label'])) {
                echo '<li class="pagelinks-end">';
                echo '<a href="', $urlEndPage->toString(true), '">', $displayProperties['end-label'], '</a>';
                   echo '</li>', "\n";
            }
        }

        echo '</ul>';
    }
}

?>