WebSVN – Applications.papyrus – Diff – /trunk/api/pear/Pager/Common.php


<?php
/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */
 
/**
 * Contains the Pager_Common class
 *
 * PHP versions 4 and 5
 *
 * LICENSE: Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * @category   HTML
 * @package    Pager
 * @author     Lorenzo Alberton <l dot alberton at quipo dot it>
 * @author     Richard Heyes <richard@phpguru.org>
 * @copyright  2003-2006 Lorenzo Alberton, Richard Heyes
 * @license    http://www.debian.org/misc/bsd.license  BSD License (3 Clause)
 * @version    CVS: $Id$
 * @link       http://pear.php.net/package/Pager
 */
 
/**
 * Two constants used to guess the path- and file-name of the page
 * when the user doesn't set any other value
 */
if (substr($_SERVER['PHP_SELF'], -1) == '/') {
    $http = !empty($_SERVER['HTTPS']) ? 'https://' : 'http://';
    define('CURRENT_FILENAME', '');
    define('CURRENT_PATHNAME', $http.$_SERVER['HTTP_HOST'].str_replace('\\', '/', $_SERVER['PHP_SELF']));
} else {
    define('CURRENT_FILENAME', preg_replace('/(.*)\?.*/', '\\1', basename($_SERVER['PHP_SELF'])));
    define('CURRENT_PATHNAME', str_replace('\\', '/', dirname($_SERVER['PHP_SELF'])));
}
/**
 * Error codes
 */
define('PAGER_OK',                         0);
define('ERROR_PAGER',                     -1);
define('ERROR_PAGER_INVALID',             -2);
define('ERROR_PAGER_INVALID_PLACEHOLDER', -3);
define('ERROR_PAGER_INVALID_USAGE',       -4);
define('ERROR_PAGER_NOT_IMPLEMENTED',     -5);
 
/**
 * Pager_Common - Common base class for [Sliding|Jumping] Window Pager
 * Extend this class to write a custom paging class
 *
 * @category   HTML
 * @package    Pager
 * @author     Lorenzo Alberton <l dot alberton at quipo dot it>
 * @author     Richard Heyes <richard@phpguru.org>
 * @copyright  2003-2005 Lorenzo Alberton, Richard Heyes
 * @license    http://www.php.net/license/3_0.txt  PHP License 3.0
 * @link       http://pear.php.net/package/Pager
 */
class Pager_Common
{
    // {{{ class vars
 
    /**
     * @var integer number of items
     * @access private
     */
    var $_totalItems;
 
    /**
     * @var integer number of items per page
     * @access private
     */
    var $_perPage     = 10;
 
    /**
     * @var integer number of page links for each window
     * @access private
     */
    var $_delta       = 10;
 
    /**
     * @var integer current page number
     * @access private
     */
    var $_currentPage = 1;
 
    /**
     * @var integer total pages number
     * @access private
     */
    var $_totalPages  = 1;
 
    /**
     * @var string CSS class for links
     * @access private
     */
    var $_linkClass   = '';
 
    /**
     * @var string wrapper for CSS class name
     * @access private
     */
    var $_classString = '';
 
    /**
     * @var string path name
     * @access private
     */
    var $_path        = CURRENT_PATHNAME;
 
    /**
     * @var string file name
     * @access private
     */
    var $_fileName    = CURRENT_FILENAME;
    
    /**
     * @var boolean If false, don't override the fileName option. Use at your own risk.
     * @access private
     */
    var $_fixFileName = true;
 
    /**
     * @var boolean you have to use FALSE with mod_rewrite
     * @access private
     */
    var $_append      = true;
 
    /**
     * @var string specifies which HTTP method to use
     * @access private
     */
    var $_httpMethod  = 'GET';
    
    /**
     * @var string specifies which HTML form to use
     * @access private
     */
    var $_formID  = '';
 
    /**
     * @var boolean whether or not to import submitted data
     * @access private
     */
    var $_importQuery = true;
 
    /**
     * @var string name of the querystring var for pageID
     * @access private
     */
    var $_urlVar      = 'pageID';
 
    /**
     * @var array data to pass through the link
     * @access private
     */
    var $_linkData    = array();
 
    /**
     * @var array additional URL vars
     * @access private
     */
    var $_extraVars   = array();
    
    /**
     * @var array URL vars to ignore
     * @access private
     */
    var $_excludeVars = array();
 
    /**
     * @var boolean TRUE => expanded mode (for Pager_Sliding)
     * @access private
     */
    var $_expanded    = true;
    
    /**
     * @var boolean TRUE => show accesskey attribute on <a> tags
     * @access private
     */
    var $_accesskey   = false;
 
    /**
     * @var string extra attributes for the <a> tag
     * @access private
     */
    var $_attributes  = '';
    
    /**
     * @var string onclick
     * @access private
     */
    var $_onclick = '';
 
    /**
     * @var string alt text for "first page" (use "%d" placeholder for page number)
     * @access private
     */
    var $_altFirst     = 'first page';
 
    /**
     * @var string alt text for "previous page"
     * @access private
     */
    var $_altPrev     = 'previous page';
 
    /**
     * @var string alt text for "next page"
     * @access private
     */
    var $_altNext     = 'next page';
 
    /**
     * @var string alt text for "last page" (use "%d" placeholder for page number)
     * @access private
     */
    var $_altLast     = 'last page';
 
    /**
     * @var string alt text for "page"
     * @access private
     */
    var $_altPage     = 'page';
 
    /**
     * @var string image/text to use as "prev" link
     * @access private
     */
    var $_prevImg     = '&lt;&lt; Back';
 
    /**
     * @var string image/text to use as "next" link
     * @access private
     */
    var $_nextImg     = 'Next &gt;&gt;';
 
    /**
     * @var string link separator
     * @access private
     */
    var $_separator   = '';
 
    /**
     * @var integer number of spaces before separator
     * @access private
     */
    var $_spacesBeforeSeparator = 0;
 
    /**
     * @var integer number of spaces after separator
     * @access private
     */
    var $_spacesAfterSeparator  = 1;
 
    /**
     * @var string CSS class name for current page link
     * @access private
     */
    var $_curPageLinkClassName  = '';
 
    /**
     * @var string Text before current page link
     * @access private
     */
    var $_curPageSpanPre        = '';
 
    /**
     * @var string Text after current page link
     * @access private
     */
    var $_curPageSpanPost       = '';
 
    /**
     * @var string Text before first page link
     * @access private
     */
    var $_firstPagePre  = '[';
 
    /**
     * @var string Text to be used for first page link
     * @access private
     */
    var $_firstPageText = '';
 
    /**
     * @var string Text after first page link
     * @access private
     */
    var $_firstPagePost = ']';
 
    /**
     * @var string Text before last page link
     * @access private
     */
    var $_lastPagePre   = '[';
 
    /**
     * @var string Text to be used for last page link
     * @access private
     */
    var $_lastPageText  = '';
 
    /**
     * @var string Text after last page link
     * @access private
     */
    var $_lastPagePost  = ']';
 
    /**
     * @var string Will contain the HTML code for the spaces
     * @access private
     */
    var $_spacesBefore  = '';
 
    /**
     * @var string Will contain the HTML code for the spaces
     * @access private
     */
    var $_spacesAfter   = '';
 
    /**
     * @var string $_firstLinkTitle
     * @access private
     */
    var $_firstLinkTitle = 'first page';
 
    /**
     * @var string $_nextLinkTitle
     * @access private
     */
    var $_nextLinkTitle = 'next page';
 
    /**
     * @var string $_prevLinkTitle
     * @access private
     */
    var $_prevLinkTitle = 'previous page';
 
    /**
     * @var string $_lastLinkTitle
     * @access private
     */
    var $_lastLinkTitle = 'last page';
 
    /**
     * @var string Text to be used for the 'show all' option in the select box
     * @access private
     */
    var $_showAllText   = '';
 
    /**
     * @var array data to be paged
     * @access private
     */
    var $_itemData      = null;
 
    /**
     * @var boolean If TRUE and there's only one page, links aren't shown
     * @access private
     */
    var $_clearIfVoid   = true;
 
    /**
     * @var boolean Use session for storing the number of items per page
     * @access private
     */
    var $_useSessions   = false;
 
    /**
     * @var boolean Close the session when finished reading/writing data
     * @access private
     */
    var $_closeSession  = false;
 
    /**
     * @var string name of the session var for number of items per page
     * @access private
     */
    var $_sessionVar    = 'setPerPage';
 
    /**
     * Pear error mode (when raiseError is called)
     * (see PEAR doc)
     *
     * @var int $_pearErrorMode
     * @access private
     */
    var $_pearErrorMode = null;
 
    // }}}
    // {{{ public vars
 
    /**
     * @var string Complete set of links
     * @access public
     */
    var $links = '';
 
    /**
     * @var string Complete set of link tags
     * @access public
     */
    var $linkTags = '';
 
    /**
     * @var array Array with a key => value pair representing
     *            page# => bool value (true if key==currentPageNumber).
     *            can be used for extreme customization.
     * @access public
     */
    var $range = array();
    
    /**
     * @var array list of available options (safety check)
     * @access private
     */
    var $_allowed_options = array(
        'totalItems',
        'perPage',
        'delta',
        'linkClass',
        'path',
        'fileName',
        'fixFileName',
        'append',
        'httpMethod',
        'formID',
        'importQuery',
        'urlVar',
        'altFirst',
        'altPrev',
        'altNext',
        'altLast',
        'altPage',
        'prevImg',
        'nextImg',
        'expanded',
        'accesskey',
        'attributes',
        'onclick',
        'separator',
        'spacesBeforeSeparator',
        'spacesAfterSeparator',
        'curPageLinkClassName',
        'curPageSpanPre',
        'curPageSpanPost',
        'firstPagePre',
        'firstPageText',
        'firstPagePost',
        'lastPagePre',
        'lastPageText',
        'lastPagePost',
        'firstLinkTitle',
        'nextLinkTitle',
        'prevLinkTitle',
        'lastLinkTitle',
        'showAllText',
        'itemData',
        'clearIfVoid',
        'useSessions',
        'closeSession',
        'sessionVar',
        'pearErrorMode',
        'extraVars',
        'excludeVars',
        'currentPage',
    );
 
    // }}}
    // {{{ build()
 
    /**
     * Generate or refresh the links and paged data after a call to setOptions()
     *
     * @access public
     */
    function build()
    {
        //reset
        $this->_pageData = array();
        $this->links = '';
 
        $this->_generatePageData();
        $this->_setFirstLastText();
 
        if ($this->_totalPages > (2 * $this->_delta + 1)) {
            $this->links .= $this->_printFirstPage();
        }
 
        $this->links .= $this->_getBackLink();
        $this->links .= $this->_getPageLinks();
        $this->links .= $this->_getNextLink();
 
        $this->linkTags .= $this->_getFirstLinkTag();
        $this->linkTags .= $this->_getPrevLinkTag();
        $this->linkTags .= $this->_getNextLinkTag();
        $this->linkTags .= $this->_getLastLinkTag();
 
        if ($this->_totalPages > (2 * $this->_delta + 1)) {
            $this->links .= $this->_printLastPage();
        }
    }
 
    // }}}
    // {{{ getPageData()
 
    /**
     * Returns an array of current pages data
     *
     * @param $pageID Desired page ID (optional)
     * @return array Page data
     * @access public
     */
    function getPageData($pageID = null)
    {
        $pageID = empty($pageID) ? $this->_currentPage : $pageID;
 
        if (!isset($this->_pageData)) {
            $this->_generatePageData();
        }
        if (!empty($this->_pageData[$pageID])) {
            return $this->_pageData[$pageID];
        }
        return array();
    }
 
    // }}}
    // {{{ getPageIdByOffset()
 
    /**
     * Returns pageID for given offset
     *
     * @param $index Offset to get pageID for
     * @return int PageID for given offset
     */
    function getPageIdByOffset($index)
    {
        $msg = '<b>PEAR::Pager Error:</b>'
              .' function "getPageIdByOffset()" not implemented.';
        return $this->raiseError($msg, ERROR_PAGER_NOT_IMPLEMENTED);
    }
 
    // }}}
    // {{{ getOffsetByPageId()
 
    /**
     * Returns offsets for given pageID. Eg, if you
     * pass it pageID one and your perPage limit is 10
     * it will return (1, 10). PageID of 2 would
     * give you (11, 20).
     *
     * @param integer PageID to get offsets for
     * @return array  First and last offsets
     * @access public
     */
    function getOffsetByPageId($pageid = null)
    {
        $pageid = isset($pageid) ? $pageid : $this->_currentPage;
        if (!isset($this->_pageData)) {
            $this->_generatePageData();
        }
 
        if (isset($this->_pageData[$pageid]) || is_null($this->_itemData)) {
            return array(
                        max(($this->_perPage * ($pageid - 1)) + 1, 1),
                        min($this->_totalItems, $this->_perPage * $pageid)
                   );
        } else {
            return array(0, 0);
        }
    }
 
    // }}}
    // {{{ getPageRangeByPageId()
 
    /**
     * @param integer PageID to get offsets for
     * @return array  First and last offsets
     */
    function getPageRangeByPageId($pageID)
    {
        $msg = '<b>PEAR::Pager Error:</b>'
              .' function "getPageRangeByPageId()" not implemented.';
        return $this->raiseError($msg, ERROR_PAGER_NOT_IMPLEMENTED);
    }
 
    // }}}
    // {{{ getLinks()
 
    /**
     * Returns back/next/first/last and page links,
     * both as ordered and associative array.
     *
     * NB: in original PEAR::Pager this method accepted two parameters,
     * $back_html and $next_html. Now the only parameter accepted is
     * an integer ($pageID), since the html text for prev/next links can
     * be set in the factory. If a second parameter is provided, then
     * the method act as it previously did. This hack was done to mantain
     * backward compatibility only.
     *
     * @param integer $pageID Optional pageID. If specified, links
     *                for that page are provided instead of current one.  [ADDED IN NEW PAGER VERSION]
     * @param  string $next_html HTML to put inside the next link [deprecated: use the factory instead]
     * @return array back/next/first/last and page links
     */
    function getLinks($pageID=null, $next_html='')
    {
        $msg = '<b>PEAR::Pager Error:</b>'
              .' function "getLinks()" not implemented.';
        return $this->raiseError($msg, ERROR_PAGER_NOT_IMPLEMENTED);
    }
 
    // }}}
    // {{{ getCurrentPageID()
 
    /**
     * Returns ID of current page
     *
     * @return integer ID of current page
     */
    function getCurrentPageID()
    {
        return $this->_currentPage;
    }
 
    // }}}
    // {{{ getNextPageID()
 
    /**
     * Returns next page ID. If current page is last page
	 * this function returns FALSE
	 *
	 * @return mixed Next page ID
     */
	function getNextPageID()
	{
		return ($this->getCurrentPageID() == $this->numPages() ? false : $this->getCurrentPageID() + 1);
	}
 
	// }}}
    // {{{ getPreviousPageID()
 
    /**
     * Returns previous page ID. If current page is first page
	 * this function returns FALSE
	 *
	 * @return mixed Previous pages' ID
     */
	function getPreviousPageID()
	{
		return $this->isFirstPage() ? false : $this->getCurrentPageID() - 1;
	}
 
    // }}}
    // {{{ numItems()
 
    /**
     * Returns number of items
     *
     * @return int Number of items
     */
    function numItems()
    {
        return $this->_totalItems;
    }
 
    // }}}
    // {{{ numPages()
 
    /**
     * Returns number of pages
     *
     * @return int Number of pages
     */
    function numPages()
    {
        return (int)$this->_totalPages;
    }
 
    // }}}
    // {{{ isFirstPage()
 
    /**
     * Returns whether current page is first page
     *
     * @return bool First page or not
     */
    function isFirstPage()
    {
        return ($this->_currentPage < 2);
    }
 
    // }}}
    // {{{ isLastPage()
 
    /**
     * Returns whether current page is last page
     *
     * @return bool Last page or not
     */
    function isLastPage()
    {
        return ($this->_currentPage == $this->_totalPages);
    }
 
    // }}}
    // {{{ isLastPageComplete()
 
    /**
     * Returns whether last page is complete
     *
     * @return bool Last age complete or not
     */
    function isLastPageComplete()
    {
        return !($this->_totalItems % $this->_perPage);
    }
 
    // }}}
    // {{{ _generatePageData()
 
    /**
     * Calculates all page data
     * @access private
     */
    function _generatePageData()
    {
        // Been supplied an array of data?
        if (!is_null($this->_itemData)) {
            $this->_totalItems = count($this->_itemData);
        }
        $this->_totalPages = ceil((float)$this->_totalItems / (float)$this->_perPage);
        $i = 1;
        if (!empty($this->_itemData)) {
            foreach ($this->_itemData as $key => $value) {
                $this->_pageData[$i][$key] = $value;
                if (count($this->_pageData[$i]) >= $this->_perPage) {
                    $i++;
                }
            }
        } else {
            $this->_pageData = array();
        }
 
        //prevent URL modification
        $this->_currentPage = min($this->_currentPage, $this->_totalPages);
    }
 
    // }}}
    // {{{ _renderLink()
 
    /**
     * Renders a link using the appropriate method
     *
     * @param altText Alternative text for this link (title property)
     * @param linkText Text contained by this link
     * @return string The link in string form
     * @access private
     */
    function _renderLink($altText, $linkText)
    {
        if ($this->_httpMethod == 'GET') {
            if ($this->_append) {
                $href = '?' . $this->_http_build_query_wrapper($this->_linkData);
            } else {
                $href = str_replace('%d', $this->_linkData[$this->_urlVar], $this->_fileName);
            }
            $onclick = '';
            if (array_key_exists($this->_urlVar, $this->_linkData)) {
                $onclick = str_replace('%d', $this->_linkData[$this->_urlVar], $this->_onclick);
            }
            return sprintf('<a href="%s"%s%s%s%s title="%s">%s</a>',
                           htmlentities($this->_url . $href),
                           empty($this->_classString) ? '' : ' '.$this->_classString,
                           empty($this->_attributes)  ? '' : ' '.$this->_attributes,
                           empty($this->_accesskey)   ? '' : ' accesskey="'.$this->_linkData[$this->_urlVar].'"',
                           empty($onclick)            ? '' : ' onclick="'.$onclick.'"',
                           $altText,
                           $linkText
            );
        } elseif ($this->_httpMethod == 'POST') {
            return sprintf("<a href='javascript:void(0)' onclick='%s'%s%s%s title='%s'>%s</a>",
                           $this->_generateFormOnClick($this->_url, $this->_linkData),
                           empty($this->_classString) ? '' : ' '.$this->_classString,
                           empty($this->_attributes)  ? '' : ' '.$this->_attributes,
                           empty($this->_accesskey)   ? '' : ' accesskey=\''.$this->_linkData[$this->_urlVar].'\'',
                           $altText,
                           $linkText
            );
        }
        return '';
    }
 
    // }}}
    // {{{ _generateFormOnClick()
 
    /**
     * Mimics http_build_query() behavior in the way the data
     * in $data will appear when it makes it back to the server.
     *  For example:
     * $arr =  array('array' => array(array('hello', 'world'),
     *                                'things' => array('stuff', 'junk'));
     * http_build_query($arr)
     * and _generateFormOnClick('foo.php', $arr)
     * will yield
     * $_REQUEST['array'][0][0] === 'hello'
     * $_REQUEST['array'][0][1] === 'world'
     * $_REQUEST['array']['things'][0] === 'stuff'
     * $_REQUEST['array']['things'][1] === 'junk'
     *
     * However, instead of  generating a query string, it generates
     * Javascript to create and submit a form.
     *
     * @param string $formAction where the form should be submitted
     * @param array  $data the associative array of names and values
     * @return string A string of javascript that generates a form and submits it
     * @access private
     */
    function _generateFormOnClick($formAction, $data)
    {
        // Check we have an array to work with
        if (!is_array($data)) {
            trigger_error(
                '_generateForm() Parameter 1 expected to be Array or Object. Incorrect value given.',
                E_USER_WARNING
            );
            return false;
        }
 
        if (!empty($this->_formID)) {
            $str = 'var form = document.getElementById("'.$this->_formID.'"); var input = ""; ';
        } else {
            $str = 'var form = document.createElement("form"); var input = ""; ';
        }
        
        // We /shouldn't/ need to escape the URL ...
        $str .= sprintf('form.action = "%s"; ', htmlentities($formAction));
        $str .= sprintf('form.method = "%s"; ', $this->_httpMethod);
        foreach ($data as $key => $val) {
            $str .= $this->_generateFormOnClickHelper($val, $key);
        }
 
        if (empty($this->_formID)) {
            $str .= 'document.getElementsByTagName("body")[0].appendChild(form);';
        }
        
        $str .= 'form.submit(); return false;';
        return $str;
    }
 
    // }}}
    // {{{ _generateFormOnClickHelper
 
    /**
     * This is used by _generateFormOnClick(). 
     * Recursively processes the arrays, objects, and literal values.
     *
     * @param data Data that should be rendered
     * @param prev The name so far
     * @return string A string of Javascript that creates form inputs
     *                representing the data
     * @access private
     */
    function _generateFormOnClickHelper($data, $prev = '')
    {
        $str = '';
        if (is_array($data) || is_object($data)) {
            // foreach key/visible member
            foreach ((array)$data as $key => $val) {
                // append [$key] to prev
                $tempKey = sprintf('%s[%s]', $prev, $key);
                $str .= $this->_generateFormOnClickHelper($val, $tempKey);
            }
        } else {  // must be a literal value
            // escape newlines and carriage returns
            $search  = array("\n", "\r");
            $replace = array('\n', '\n');
            $escapedData = str_replace($search, $replace, $data);
            // am I forgetting any dangerous whitespace?
            // would a regex be faster?
            // if it's already encoded, don't encode it again
            if (!$this->_isEncoded($escapedData)) {
                $escapedData = urlencode($escapedData);
            }
            $escapedData = htmlentities($escapedData, ENT_QUOTES, 'UTF-8');
 
            $str .= 'input = document.createElement("input"); ';
            $str .= 'input.type = "hidden"; ';
            $str .= sprintf('input.name = "%s"; ', $prev);
            $str .= sprintf('input.value = "%s"; ', $escapedData);
            $str .= 'form.appendChild(input); ';
        }
        return $str;
    }
 
    // }}}
    // {{{ _getLinksData()
 
    /**
     * Returns the correct link for the back/pages/next links
     *
     * @return array Data
     * @access private
     */
    function _getLinksData()
    {
        $qs = array();
        if ($this->_importQuery) {
            if ($this->_httpMethod == 'POST') {
                $qs = $_POST;
            } elseif ($this->_httpMethod == 'GET') {
                $qs = $_GET;
            }
        }
 
 
 
 
        foreach ($this->_excludeVars as $exclude) {
            if (array_key_exists($exclude, $qs)) {
                unset($qs[$exclude]);
            }
        }
        if (count($this->_extraVars)){
            $this->_recursive_urldecode($this->_extraVars);
            $qs = array_merge($qs, $this->_extraVars);
        }
        if (count($qs) && get_magic_quotes_gpc()){
            $this->_recursive_stripslashes($qs);
        }
        return $qs;
    }
 
    // }}}
    // {{{ _recursive_stripslashes()
    
    /**
     * Helper method
     * @param mixed $var
     * @access private
     */
    function _recursive_stripslashes(&$var)
    {
        if (is_array($var)) {
            foreach (array_keys($var) as $k) {
                $this->_recursive_stripslashes($var[$k]);
            }
        } else {
            $var = stripslashes($var);
        }
    }
 
    // }}}
    // {{{ _recursive_urldecode()
 
    /**
     * Helper method
     * @param mixed $var
     * @access private
     */
    function _recursive_urldecode(&$var)
    {
        if (is_array($var)) {
            foreach (array_keys($var) as $k) {
                $this->_recursive_urldecode($var[$k]);
            }
        } else {
            $trans_tbl = array_flip(get_html_translation_table(HTML_ENTITIES));
            $var = strtr($var, $trans_tbl);
        }
    }
 
    // }}}
    // {{{ _getBackLink()
 
    /**
     * Returns back link
     *
     * @param $url  URL to use in the link  [deprecated: use the factory instead]
     * @param $link HTML to use as the link [deprecated: use the factory instead]
     * @return string The link
     * @access private
     */
    function _getBackLink($url='', $link='')
    {
        //legacy settings... the preferred way to set an option
        //now is passing it to the factory
        if (!empty($url)) {
            $this->_path = $url;
        }
        if (!empty($link)) {
            $this->_prevImg = $link;
        }
        $back = '';
        if ($this->_currentPage > 1) {
            $this->_linkData[$this->_urlVar] = $this->getPreviousPageID();
            $back = $this->_renderLink($this->_altPrev, $this->_prevImg)
                  . $this->_spacesBefore . $this->_spacesAfter;
        }
        return $back;
    }
 
    // }}}
    // {{{ _getPageLinks()
 
    /**
     * Returns pages link
     *
     * @param $url  URL to use in the link [deprecated: use the factory instead]
     * @return string Links
     * @access private
     */
    function _getPageLinks($url='')
    {
        $msg = '<b>PEAR::Pager Error:</b>'
              .' function "_getPageLinks()" not implemented.';
        return $this->raiseError($msg, ERROR_PAGER_NOT_IMPLEMENTED);
    }
 
    // }}}
    // {{{ _getNextLink()
 
    /**
     * Returns next link
     *
     * @param $url  URL to use in the link  [deprecated: use the factory instead]
     * @param $link HTML to use as the link [deprecated: use the factory instead]
     * @return string The link
     * @access private
     */
    function _getNextLink($url='', $link='')
    {
        //legacy settings... the preferred way to set an option
        //now is passing it to the factory
        if (!empty($url)) {
            $this->_path = $url;
        }
        if (!empty($link)) {
            $this->_nextImg = $link;
        }
        $next = '';
        if ($this->_currentPage < $this->_totalPages) {
            $this->_linkData[$this->_urlVar] = $this->getNextPageID();
            $next = $this->_spacesAfter
                  . $this->_renderLink($this->_altNext, $this->_nextImg)
                  . $this->_spacesBefore . $this->_spacesAfter;
        }
        return $next;
    }
 
    // }}}
    // {{{ _getFirstLinkTag()
 
    /**
     * @return string
     * @access private
     */
    function _getFirstLinkTag()
    {
        if ($this->isFirstPage() || ($this->_httpMethod != 'GET')) {
            return '';
        }
        return sprintf('<link rel="first" href="%s" title="%s" />'."\n",
            $this->_getLinkTagUrl(1),
            $this->_firstLinkTitle
        );
    }
 
    // }}}
    // {{{ _getPrevLinkTag()
 
    /**
     * Returns previous link tag
     *
     * @return string the link tag
     * @access private
     */
    function _getPrevLinkTag()
    {
        if ($this->isFirstPage() || ($this->_httpMethod != 'GET')) {
            return '';
        }
        return sprintf('<link rel="previous" href="%s" title="%s" />'."\n",
            $this->_getLinkTagUrl($this->getPreviousPageID()),
            $this->_prevLinkTitle
        );
    }
 
    // }}}
    // {{{ _getNextLinkTag()
 
    /**
     * Returns next link tag
     *
     * @return string the link tag
     * @access private
     */
    function _getNextLinkTag()
    {
        if ($this->isLastPage() || ($this->_httpMethod != 'GET')) {
            return '';
        }
        return sprintf('<link rel="next" href="%s" title="%s" />'."\n",
            $this->_getLinkTagUrl($this->getNextPageID()),
            $this->_nextLinkTitle
        );
    }
 
    // }}}
    // {{{ _getLastLinkTag()
 
    /**
     * @return string the link tag
     * @access private
     */
    function _getLastLinkTag()
    {
        if ($this->isLastPage() || ($this->_httpMethod != 'GET')) {
            return '';
        }
        return sprintf('<link rel="last" href="%s" title="%s" />'."\n",
            $this->_getLinkTagUrl($this->_totalPages),
            $this->_lastLinkTitle
        );
    }
 
    // }}}
    // {{{ _getLinkTagUrl()
 
    /**
     * Helper method
     * @return string the link tag url
     * @access private
     */
    function _getLinkTagUrl($pageID)
    {
        $this->_linkData[$this->_urlVar] = $pageID;
        if ($this->_append) {
            $href = '?' . $this->_http_build_query_wrapper($this->_linkData);
        } else {
            $href = str_replace('%d', $this->_linkData[$this->_urlVar], $this->_fileName);
        }
        return htmlentities($this->_url . $href);
    }
    
    // }}}
    // {{{ getPerPageSelectBox()
 
    /**
     * Returns a string with a XHTML SELECT menu,
     * useful for letting the user choose how many items per page should be
     * displayed. If parameter useSessions is TRUE, this value is stored in
     * a session var. The string isn't echoed right now so you can use it
     * with template engines.
     *
     * @param integer $start
     * @param integer $end
     * @param integer $step
     * @param boolean $showAllData If true, perPage is set equal to totalItems.
     * @param array   (or string $optionText for BC reasons)
     *                - 'optionText': text to show in each option.
     *                  Use '%d' where you want to see the number of pages selected.
     *                - 'attributes': (html attributes) Tag attributes or
     *                  HTML attributes (id="foo" pairs), will be inserted in the
     *                  <select> tag
     * @return string xhtml select box
     * @access public
     */
    function getPerPageSelectBox($start=5, $end=30, $step=5, $showAllData=false, $extraParams=array())
    {
        require_once 'Pager/HtmlWidgets.php';
        $widget =& new Pager_HtmlWidgets($this);
        return $widget->getPerPageSelectBox($start, $end, $step, $showAllData, $extraParams);
    }
 
    // }}}
    // {{{ getPageSelectBox()
 
    /**
     * Returns a string with a XHTML SELECT menu with the page numbers,
     * useful as an alternative to the links
     *
     * @param array   - 'optionText': text to show in each option.
     *                  Use '%d' where you want to see the number of pages selected.
     *                - 'autoSubmit': if TRUE, add some js code to submit the
     *                  form on the onChange event
     * @param string   $extraAttributes (html attributes) Tag attributes or
     *                  HTML attributes (id="foo" pairs), will be inserted in the
     *                  <select> tag
     * @return string xhtml select box
     * @access public
     */
    function getPageSelectBox($params = array(), $extraAttributes = '')
    {
        require_once 'Pager/HtmlWidgets.php';
        $widget =& new Pager_HtmlWidgets($this);
        return $widget->getPageSelectBox($params, $extraAttributes);
    }
 
    // }}}
    // {{{ _printFirstPage()
 
    /**
     * Print [1]
     *
     * @return string String with link to 1st page,
     *                or empty string if this is the 1st page.
     * @access private
     */
    function _printFirstPage()
    {
        if ($this->isFirstPage()) {
            return '';
        }
        $this->_linkData[$this->_urlVar] = 1;
        return $this->_renderLink(
                str_replace('%d', 1, $this->_altFirst),
                $this->_firstPagePre . $this->_firstPageText . $this->_firstPagePost
        ) . $this->_spacesBefore . $this->_spacesAfter;
    }
 
    // }}}
    // {{{ _printLastPage()
 
    /**
     * Print [numPages()]
     *
     * @return string String with link to last page,
     *                or empty string if this is the 1st page.
     * @access private
     */
    function _printLastPage()
    {
        if ($this->isLastPage()) {
            return '';
        }
        $this->_linkData[$this->_urlVar] = $this->_totalPages;
        return $this->_renderLink(
                str_replace('%d', $this->_totalPages, $this->_altLast),
                $this->_lastPagePre . $this->_lastPageText . $this->_lastPagePost
        );
    }
 
    // }}}
    // {{{ _setFirstLastText()
 
    /**
     * sets the private _firstPageText, _lastPageText variables
     * based on whether they were set in the options
     *
     * @access private
     */
    function _setFirstLastText()
    {
        if ($this->_firstPageText == '') {
            $this->_firstPageText = '1';
        }
        if ($this->_lastPageText == '') {
            $this->_lastPageText = $this->_totalPages;
        }
    }
 
    // }}}
    // {{{ _http_build_query_wrapper()
    
    /**
     * This is a slightly modified version of the http_build_query() function;
     * it heavily borrows code from PHP_Compat's http_build_query().
     * The main change is the usage of htmlentities instead of urlencode,
     * since it's too aggressive
     *
     * @author Stephan Schmidt <schst@php.net>
     * @author Aidan Lister <aidan@php.net>
     * @author Lorenzo Alberton <l dot alberton at quipo dot it>
     * @param array $data
     * @return string
     * @access private
     */
    function _http_build_query_wrapper($data)
    {
        $data = (array)$data;
        if (empty($data)) {
            return '';
        }
        $separator = ini_get('arg_separator.output');
        if ($separator == '&amp;') {
            $separator = '&'; //the string is escaped by htmlentities anyway...
        }
        $tmp = array ();
        foreach ($data as $key => $val) {
            if (is_scalar($val)) {
                //array_push($tmp, $key.'='.$val);
                $val = urlencode($val);
                array_push($tmp, $key .'='. str_replace('%2F', '/', $val));
                continue;
            }
            // If the value is an array, recursively parse it
            if (is_array($val)) {
                array_push($tmp, $this->__http_build_query($val, htmlentities($key)));
                continue;
            }
        }
        return implode($separator, $tmp);
    }
 
    // }}}
    // {{{ __http_build_query()
 
    /**
     * Helper function
     * @author Stephan Schmidt <schst@php.net>
     * @author Aidan Lister <aidan@php.net>
     * @access private
     */
    function __http_build_query($array, $name)
    {
        $tmp = array ();
        $separator = ini_get('arg_separator.output');
        if ($separator == '&amp;') {
            $separator = '&'; //the string is escaped by htmlentities anyway...
        }
        foreach ($array as $key => $value) {
            if (is_array($value)) {
                //array_push($tmp, $this->__http_build_query($value, sprintf('%s[%s]', $name, $key)));
                array_push($tmp, $this->__http_build_query($value, $name.'%5B'.$key.'%5D'));
            } elseif (is_scalar($value)) {
                //array_push($tmp, sprintf('%s[%s]=%s', $name, htmlentities($key), htmlentities($value)));
                array_push($tmp, $name.'%5B'.htmlentities($key).'%5D='.htmlentities($value));
            } elseif (is_object($value)) {
                //array_push($tmp, $this->__http_build_query(get_object_vars($value), sprintf('%s[%s]', $name, $key)));
                array_push($tmp, $this->__http_build_query(get_object_vars($value), $name.'%5B'.$key.'%5D'));
            }
        }
        return implode($separator, $tmp);
    }
 
    // }}}
    // {{{ _isEncoded()
 
    /**
     * Helper function
     * Check if a string is an encoded multibyte string
     * @param string $string
     * @return boolean
     * @access private
     */
    
    function _isEncoded($string)
    {
        $hexchar = '&#[\dA-Fx]{2,};';
        return preg_match("/^(\s|($hexchar))*$/Uims", $string) ? true : false;
    }
 
    // }}}
    // {{{ raiseError()
 
    /**
     * conditionally includes PEAR base class and raise an error
     *
     * @param string $msg  Error message
     * @param int    $code Error code
     * @access private
     */
    function raiseError($msg, $code)
    {
        include_once 'PEAR.php';
        if (empty($this->_pearErrorMode)) {
            $this->_pearErrorMode = PEAR_ERROR_RETURN;
        }
        return PEAR::raiseError($msg, $code, $this->_pearErrorMode);
    }
 
    // }}}
    // {{{ setOptions()
 
    /**
     * Set and sanitize options
     *
     * @param mixed $options    An associative array of option names and
     *                          their values.
     * @return integer error code (PAGER_OK on success)
     * @access public
     */
    function setOptions($options)
    {
        foreach ($options as $key => $value) {
            if (in_array($key, $this->_allowed_options) && (!is_null($value))) {
                $this->{'_' . $key} = $value;
            }
        }
 
        //autodetect http method
        if (!isset($options['httpMethod'])
            && !isset($_GET[$this->_urlVar])
            && isset($_POST[$this->_urlVar])
        ) {
            $this->_httpMethod = 'POST';
        } else {
            $this->_httpMethod = strtoupper($this->_httpMethod);
        }
 
        $this->_fileName = ltrim($this->_fileName, '/');  //strip leading slash
        $this->_path     = rtrim($this->_path, '/');      //strip trailing slash
 
        if ($this->_append) {
            if ($this->_fixFileName) {
                $this->_fileName = CURRENT_FILENAME; //avoid possible user error;
            }
            $this->_url = $this->_path.'/'.$this->_fileName;
        } else {
            $this->_url = $this->_path;
            if (strncasecmp($this->_fileName, 'javascript', 10) != 0) {
                $this->_url .= '/';
            }
            if (strpos($this->_fileName, '%d') === false) {
                trigger_error($this->errorMessage(ERROR_PAGER_INVALID_USAGE), E_USER_WARNING);
            }
        }
 
        $this->_classString = '';
        if (strlen($this->_linkClass)) {
            $this->_classString = 'class="'.$this->_linkClass.'"';
        }
 
        if (strlen($this->_curPageLinkClassName)) {
            $this->_curPageSpanPre  = '<span class="'.$this->_curPageLinkClassName.'">';
            $this->_curPageSpanPost = '</span>';
        }
 
        $this->_perPage = max($this->_perPage, 1); //avoid possible user errors
 
        if ($this->_useSessions && !isset($_SESSION)) {
            session_start();
        }
        if (!empty($_REQUEST[$this->_sessionVar])) {
            $this->_perPage = max(1, (int)$_REQUEST[$this->_sessionVar]);
            if ($this->_useSessions) {
                $_SESSION[$this->_sessionVar] = $this->_perPage;
            }
        }
 
        if (!empty($_SESSION[$this->_sessionVar])) {
             $this->_perPage = $_SESSION[$this->_sessionVar];
        }
 
        if ($this->_closeSession) {
            session_write_close();
        }
 
        $this->_spacesBefore = str_repeat('&nbsp;', $this->_spacesBeforeSeparator);
        $this->_spacesAfter  = str_repeat('&nbsp;', $this->_spacesAfterSeparator);
 
        if (isset($_REQUEST[$this->_urlVar]) && empty($options['currentPage'])) {
            $this->_currentPage = (int)$_REQUEST[$this->_urlVar];
        }
        $this->_currentPage = max($this->_currentPage, 1);
        $this->_linkData = $this->_getLinksData();
 
        return PAGER_OK;
    }
 
    // }}}
    // {{{ getOption()
    
    /**
     * Return the current value of a given option
     *
     * @param string option name
     * @return mixed option value
     */
    function getOption($name)
    {
        if (!in_array($name, $this->_allowed_options)) {
            $msg = '<b>PEAR::Pager Error:</b>'
                  .' invalid option: '.$name;
            return $this->raiseError($msg, ERROR_PAGER_INVALID);
        }
        return $this->{'_' . $name};
    }
 
    // }}}
    // {{{ getOptions()
 
    /**
     * Return an array with all the current pager options
     *
     * @return array list of all the pager options
     */
    function getOptions()
    {
        $options = array();
        foreach ($this->_allowed_options as $option) {
            $options[$option] = $this->{'_' . $option};
        }
        return $options;
    }
 
    // }}}
    // {{{ errorMessage()
 
    /**
     * Return a textual error message for a PAGER error code
     *
     * @param   int     $code error code
     * @return  string  error message
     * @access public
     */
    function errorMessage($code)
    {
        static $errorMessages;
        if (!isset($errorMessages)) {
            $errorMessages = array(
                ERROR_PAGER                     => 'unknown error',
                ERROR_PAGER_INVALID             => 'invalid',
                ERROR_PAGER_INVALID_PLACEHOLDER => 'invalid format - use "%d" as placeholder.',
                ERROR_PAGER_INVALID_USAGE       => 'if $options[\'append\'] is set to false, '
                                                  .' $options[\'fileName\'] MUST contain the "%d" placeholder.',
                ERROR_PAGER_NOT_IMPLEMENTED     => 'not implemented'
            );
        }
 
        return '<b>PEAR::Pager error:</b> '. (isset($errorMessages[$code]) ?
            $errorMessages[$code] : $errorMessages[ERROR_PAGER]);
    }
 
    // }}}
}
?>

Rev 848	Rev 1713
1	`<?php`	1	`<?php`
2	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */`	2	`/* vim: set expandtab tabstop=4 shiftwidth=4 softtabstop=4: */`
3		3
4	`/**`	4	`/**`
5	`* Contains the Pager_Common class`	5	`* Contains the Pager_Common class`
6	`*`	6	`*`
7	`* PHP versions 4 and 5`	7	`* PHP versions 4 and 5`
8	`*`	8	`*`
9	`* LICENSE: Redistribution and use in source and binary forms, with or without`	9	`* LICENSE: Redistribution and use in source and binary forms, with or without`
10	`* modification, are permitted provided that the following conditions are met:`	10	`* modification, are permitted provided that the following conditions are met:`
11	`* 1. Redistributions of source code must retain the above copyright`	11	`* 1. Redistributions of source code must retain the above copyright`
12	`* notice, this list of conditions and the following disclaimer.`	12	`* notice, this list of conditions and the following disclaimer.`
13	`* 2. Redistributions in binary form must reproduce the above copyright`	13	`* 2. Redistributions in binary form must reproduce the above copyright`
14	`* notice, this list of conditions and the following disclaimer in the`	14	`* notice, this list of conditions and the following disclaimer in the`
15	`* documentation and/or other materials provided with the distribution.`	15	`* documentation and/or other materials provided with the distribution.`
16	`* 3. The name of the author may not be used to endorse or promote products`	16	`* 3. The name of the author may not be used to endorse or promote products`
17	`* derived from this software without specific prior written permission.`	17	`* derived from this software without specific prior written permission.`
18	`*`	18	`*`
19	`* THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED`	19	`* THIS SOFTWARE IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR IMPLIED`
20	`* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF`	20	`* WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF`
21	`* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`	21	`* MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.`
22	`* IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY`	22	`* IN NO EVENT SHALL THE FREEBSD PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY`
23	`* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES`	23	`* DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES`
24	`* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;`	24	`* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;`
25	`* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND`	25	`* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND`
26	`* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`	26	`* ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT`
27	`* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`	27	`* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF`
28	`* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`	28	`* THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`
29	`*`	29	`*`
30	`* @category HTML`	30	`* @category HTML`
31	`* @package Pager`	31	`* @package Pager`
32	`* @author Lorenzo Alberton <l dot alberton at quipo dot it>`	32	`* @author Lorenzo Alberton <l dot alberton at quipo dot it>`
33	`* @author Richard Heyes <richard@phpguru.org>`	33	`* @author Richard Heyes <richard@phpguru.org>`
34	`* @copyright 2003-2006 Lorenzo Alberton, Richard Heyes`	34	`* @copyright 2003-2006 Lorenzo Alberton, Richard Heyes`
35	`* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)`	35	`* @license http://www.debian.org/misc/bsd.license BSD License (3 Clause)`
36	`* @version CVS: $Id$`	36	`* @version CVS: $Id$`
37	`* @link http://pear.php.net/package/Pager`	37	`* @link http://pear.php.net/package/Pager`
38	`*/`	38	`*/`
39		39
40	`/**`	40	`/**`
41	`* Two constants used to guess the path- and file-name of the page`	41	`* Two constants used to guess the path- and file-name of the page`
42	`* when the user doesn't set any other value`	42	`* when the user doesn't set any other value`
43	`*/`	43	`*/`
44	`if (substr($_SERVER['PHP_SELF'], -1) == '/') {`	44	`if (substr($_SERVER['PHP_SELF'], -1) == '/') {`
-		45	`$http = !empty($_SERVER['HTTPS']) ? 'https://' : 'http://';`
45	`define('CURRENT_FILENAME', '');`	46	`define('CURRENT_FILENAME', '');`
46	`define('CURRENT_PATHNAME', 'http://'.$_SERVER['HTTP_HOST'].str_replace('\\', '/', $_SERVER['PHP_SELF']));`	47	`define('CURRENT_PATHNAME', $http.$_SERVER['HTTP_HOST'].str_replace('\\', '/', $_SERVER['PHP_SELF']));`
47	`} else {`	48	`} else {`
48	`define('CURRENT_FILENAME', preg_replace('/(.)\?./', '\\1', basename($_SERVER['PHP_SELF'])));`	49	`define('CURRENT_FILENAME', preg_replace('/(.)\?./', '\\1', basename($_SERVER['PHP_SELF'])));`
49	`define('CURRENT_PATHNAME', str_replace('\\', '/', dirname($_SERVER['PHP_SELF'])));`	50	`define('CURRENT_PATHNAME', str_replace('\\', '/', dirname($_SERVER['PHP_SELF'])));`
50	`}`	51	`}`
51	`/**`	52	`/**`
52	`* Error codes`	53	`* Error codes`
53	`*/`	54	`*/`
54	`define('PAGER_OK', 0);`	55	`define('PAGER_OK', 0);`
55	`define('ERROR_PAGER', -1);`	56	`define('ERROR_PAGER', -1);`
56	`define('ERROR_PAGER_INVALID', -2);`	57	`define('ERROR_PAGER_INVALID', -2);`
57	`define('ERROR_PAGER_INVALID_PLACEHOLDER', -3);`	58	`define('ERROR_PAGER_INVALID_PLACEHOLDER', -3);`
58	`define('ERROR_PAGER_INVALID_USAGE', -4);`	59	`define('ERROR_PAGER_INVALID_USAGE', -4);`
59	`define('ERROR_PAGER_NOT_IMPLEMENTED', -5);`	60	`define('ERROR_PAGER_NOT_IMPLEMENTED', -5);`
60		61
61	`/**`	62	`/**`
62	`* Pager_Common - Common base class for [Sliding\|Jumping] Window Pager`	63	`* Pager_Common - Common base class for [Sliding\|Jumping] Window Pager`
63	`* Extend this class to write a custom paging class`	64	`* Extend this class to write a custom paging class`
64	`*`	65	`*`
65	`* @category HTML`	66	`* @category HTML`
66	`* @package Pager`	67	`* @package Pager`
67	`* @author Lorenzo Alberton <l dot alberton at quipo dot it>`	68	`* @author Lorenzo Alberton <l dot alberton at quipo dot it>`
68	`* @author Richard Heyes <richard@phpguru.org>`	69	`* @author Richard Heyes <richard@phpguru.org>`
69	`* @copyright 2003-2005 Lorenzo Alberton, Richard Heyes`	70	`* @copyright 2003-2005 Lorenzo Alberton, Richard Heyes`
70	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`	71	`* @license http://www.php.net/license/3_0.txt PHP License 3.0`
71	`* @link http://pear.php.net/package/Pager`	72	`* @link http://pear.php.net/package/Pager`
72	`*/`	73	`*/`
73	`class Pager_Common`	74	`class Pager_Common`
74	`{`	75	`{`
75	`// {{{ class vars`	76	`// {{{ class vars`
76		77
77	`/**`	78	`/**`
78	`* @var integer number of items`	79	`* @var integer number of items`
79	`* @access private`	80	`* @access private`
80	`*/`	81	`*/`
81	`var $_totalItems;`	82	`var $_totalItems;`
82		83
83	`/**`	84	`/**`
84	`* @var integer number of items per page`	85	`* @var integer number of items per page`
85	`* @access private`	86	`* @access private`
86	`*/`	87	`*/`
87	`var $_perPage = 10;`	88	`var $_perPage = 10;`
88		89
89	`/**`	90	`/**`
90	`* @var integer number of page links for each window`	91	`* @var integer number of page links for each window`
91	`* @access private`	92	`* @access private`
92	`*/`	93	`*/`
93	`var $_delta = 10;`	94	`var $_delta = 10;`
94		95
95	`/**`	96	`/**`
96	`* @var integer current page number`	97	`* @var integer current page number`
97	`* @access private`	98	`* @access private`
98	`*/`	99	`*/`
99	`var $_currentPage = 1;`	100	`var $_currentPage = 1;`
100		101
101	`/**`	102	`/**`
102	`* @var integer total pages number`	103	`* @var integer total pages number`
103	`* @access private`	104	`* @access private`
104	`*/`	105	`*/`
105	`var $_totalPages = 1;`	106	`var $_totalPages = 1;`
106		107
107	`/**`	108	`/**`
108	`* @var string CSS class for links`	109	`* @var string CSS class for links`
109	`* @access private`	110	`* @access private`
110	`*/`	111	`*/`
111	`var $_linkClass = '';`	112	`var $_linkClass = '';`
112		113
113	`/**`	114	`/**`
114	`* @var string wrapper for CSS class name`	115	`* @var string wrapper for CSS class name`
115	`* @access private`	116	`* @access private`
116	`*/`	117	`*/`
117	`var $_classString = '';`	118	`var $_classString = '';`
118		119
119	`/**`	120	`/**`
120	`* @var string path name`	121	`* @var string path name`
121	`* @access private`	122	`* @access private`
122	`*/`	123	`*/`
123	`var $_path = CURRENT_PATHNAME;`	124	`var $_path = CURRENT_PATHNAME;`
124		125
125	`/**`	126	`/**`
126	`* @var string file name`	127	`* @var string file name`
127	`* @access private`	128	`* @access private`
128	`*/`	129	`*/`
129	`var $_fileName = CURRENT_FILENAME;`	130	`var $_fileName = CURRENT_FILENAME;`
130		131
131	`/**`	132	`/**`
132	`* @var boolean If false, don't override the fileName option. Use at your own risk.`	133	`* @var boolean If false, don't override the fileName option. Use at your own risk.`
133	`* @access private`	134	`* @access private`
134	`*/`	135	`*/`
135	`var $_fixFileName = true;`	136	`var $_fixFileName = true;`
136		137
137	`/**`	138	`/**`
138	`* @var boolean you have to use FALSE with mod_rewrite`	139	`* @var boolean you have to use FALSE with mod_rewrite`
139	`* @access private`	140	`* @access private`
140	`*/`	141	`*/`
141	`var $_append = true;`	142	`var $_append = true;`
142		143
143	`/**`	144	`/**`
144	`* @var string specifies which HTTP method to use`	145	`* @var string specifies which HTTP method to use`
145	`* @access private`	146	`* @access private`
146	`*/`	147	`*/`
147	`var $_httpMethod = 'GET';`	148	`var $_httpMethod = 'GET';`
148		149
149	`/**`	150	`/**`
150	`* @var string specifies which HTML form to use`	151	`* @var string specifies which HTML form to use`
151	`* @access private`	152	`* @access private`
152	`*/`	153	`*/`
153	`var $_formID = '';`	154	`var $_formID = '';`
154		155
155	`/**`	156	`/**`
156	`* @var boolean whether or not to import submitted data`	157	`* @var boolean whether or not to import submitted data`
157	`* @access private`	158	`* @access private`
158	`*/`	159	`*/`
159	`var $_importQuery = true;`	160	`var $_importQuery = true;`
160		161
161	`/**`	162	`/**`
162	`* @var string name of the querystring var for pageID`	163	`* @var string name of the querystring var for pageID`
163	`* @access private`	164	`* @access private`
164	`*/`	165	`*/`
165	`var $_urlVar = 'pageID';`	166	`var $_urlVar = 'pageID';`
166		167
167	`/**`	168	`/**`
168	`* @var array data to pass through the link`	169	`* @var array data to pass through the link`
169	`* @access private`	170	`* @access private`
170	`*/`	171	`*/`
171	`var $_linkData = array();`	172	`var $_linkData = array();`
172		173
173	`/**`	174	`/**`
174	`* @var array additional URL vars`	175	`* @var array additional URL vars`
175	`* @access private`	176	`* @access private`
176	`*/`	177	`*/`
177	`var $_extraVars = array();`	178	`var $_extraVars = array();`
178		179
179	`/**`	180	`/**`
180	`* @var array URL vars to ignore`	181	`* @var array URL vars to ignore`
181	`* @access private`	182	`* @access private`
182	`*/`	183	`*/`
183	`var $_excludeVars = array();`	184	`var $_excludeVars = array();`
184		185
185	`/**`	186	`/**`
186	`* @var boolean TRUE => expanded mode (for Pager_Sliding)`	187	`* @var boolean TRUE => expanded mode (for Pager_Sliding)`
187	`* @access private`	188	`* @access private`
188	`*/`	189	`*/`
189	`var $_expanded = true;`	190	`var $_expanded = true;`
190		191
191	`/**`	192	`/**`
192	`* @var boolean TRUE => show accesskey attribute on <a> tags`	193	`* @var boolean TRUE => show accesskey attribute on <a> tags`
193	`* @access private`	194	`* @access private`
194	`*/`	195	`*/`
195	`var $_accesskey = false;`	196	`var $_accesskey = false;`
196		197
197	`/**`	198	`/**`
198	`* @var string extra attributes for the <a> tag`	199	`* @var string extra attributes for the <a> tag`
199	`* @access private`	200	`* @access private`
200	`*/`	201	`*/`
201	`var $_attributes = '';`	202	`var $_attributes = '';`
-		203
-		204	`/**`
-		205	`* @var string onclick`
-		206	`* @access private`
-		207	`*/`
-		208	`var $_onclick = '';`
202		209
203	`/**`	210	`/**`
204	`* @var string alt text for "first page" (use "%d" placeholder for page number)`	211	`* @var string alt text for "first page" (use "%d" placeholder for page number)`
205	`* @access private`	212	`* @access private`
206	`*/`	213	`*/`
207	`var $_altFirst = 'first page';`	214	`var $_altFirst = 'first page';`
208		215
209	`/**`	216	`/**`
210	`* @var string alt text for "previous page"`	217	`* @var string alt text for "previous page"`
211	`* @access private`	218	`* @access private`
212	`*/`	219	`*/`
213	`var $_altPrev = 'previous page';`	220	`var $_altPrev = 'previous page';`
214		221
215	`/**`	222	`/**`
216	`* @var string alt text for "next page"`	223	`* @var string alt text for "next page"`
217	`* @access private`	224	`* @access private`
218	`*/`	225	`*/`
219	`var $_altNext = 'next page';`	226	`var $_altNext = 'next page';`
220		227
221	`/**`	228	`/**`
222	`* @var string alt text for "last page" (use "%d" placeholder for page number)`	229	`* @var string alt text for "last page" (use "%d" placeholder for page number)`
223	`* @access private`	230	`* @access private`
224	`*/`	231	`*/`
225	`var $_altLast = 'last page';`	232	`var $_altLast = 'last page';`
226		233
227	`/**`	234	`/**`
228	`* @var string alt text for "page"`	235	`* @var string alt text for "page"`
229	`* @access private`	236	`* @access private`
230	`*/`	237	`*/`
231	`var $_altPage = 'page';`	238	`var $_altPage = 'page';`
232		239
233	`/**`	240	`/**`
234	`* @var string image/text to use as "prev" link`	241	`* @var string image/text to use as "prev" link`
235	`* @access private`	242	`* @access private`
236	`*/`	243	`*/`
237	`var $_prevImg = '<< Back';`	244	`var $_prevImg = '<< Back';`
238		245
239	`/**`	246	`/**`
240	`* @var string image/text to use as "next" link`	247	`* @var string image/text to use as "next" link`
241	`* @access private`	248	`* @access private`
242	`*/`	249	`*/`
243	`var $_nextImg = 'Next >>';`	250	`var $_nextImg = 'Next >>';`
244		251
245	`/**`	252	`/**`
246	`* @var string link separator`	253	`* @var string link separator`
247	`* @access private`	254	`* @access private`
248	`*/`	255	`*/`
249	`var $_separator = '';`	256	`var $_separator = '';`
250		257
251	`/**`	258	`/**`
252	`* @var integer number of spaces before separator`	259	`* @var integer number of spaces before separator`
253	`* @access private`	260	`* @access private`
254	`*/`	261	`*/`
255	`var $_spacesBeforeSeparator = 0;`	262	`var $_spacesBeforeSeparator = 0;`
256		263
257	`/**`	264	`/**`
258	`* @var integer number of spaces after separator`	265	`* @var integer number of spaces after separator`
259	`* @access private`	266	`* @access private`
260	`*/`	267	`*/`
261	`var $_spacesAfterSeparator = 1;`	268	`var $_spacesAfterSeparator = 1;`
262		269
263	`/**`	270	`/**`
264	`* @var string CSS class name for current page link`	271	`* @var string CSS class name for current page link`
265	`* @access private`	272	`* @access private`
266	`*/`	273	`*/`
267	`var $_curPageLinkClassName = '';`	274	`var $_curPageLinkClassName = '';`
268		275
269	`/**`	276	`/**`
270	`* @var string Text before current page link`	277	`* @var string Text before current page link`
271	`* @access private`	278	`* @access private`
272	`*/`	279	`*/`
273	`var $_curPageSpanPre = '';`	280	`var $_curPageSpanPre = '';`
274		281
275	`/**`	282	`/**`
276	`* @var string Text after current page link`	283	`* @var string Text after current page link`
277	`* @access private`	284	`* @access private`
278	`*/`	285	`*/`
279	`var $_curPageSpanPost = '';`	286	`var $_curPageSpanPost = '';`
280		287
281	`/**`	288	`/**`
282	`* @var string Text before first page link`	289	`* @var string Text before first page link`
283	`* @access private`	290	`* @access private`
284	`*/`	291	`*/`
285	`var $_firstPagePre = '[';`	292	`var $_firstPagePre = '[';`
286		293
287	`/**`	294	`/**`
288	`* @var string Text to be used for first page link`	295	`* @var string Text to be used for first page link`
289	`* @access private`	296	`* @access private`
290	`*/`	297	`*/`
291	`var $_firstPageText = '';`	298	`var $_firstPageText = '';`
292		299
293	`/**`	300	`/**`
294	`* @var string Text after first page link`	301	`* @var string Text after first page link`
295	`* @access private`	302	`* @access private`
296	`*/`	303	`*/`
297	`var $_firstPagePost = ']';`	304	`var $_firstPagePost = ']';`
298		305
299	`/**`	306	`/**`
300	`* @var string Text before last page link`	307	`* @var string Text before last page link`
301	`* @access private`	308	`* @access private`
302	`*/`	309	`*/`
303	`var $_lastPagePre = '[';`	310	`var $_lastPagePre = '[';`
304		311
305	`/**`	312	`/**`
306	`* @var string Text to be used for last page link`	313	`* @var string Text to be used for last page link`
307	`* @access private`	314	`* @access private`
308	`*/`	315	`*/`
309	`var $_lastPageText = '';`	316	`var $_lastPageText = '';`
310		317
311	`/**`	318	`/**`
312	`* @var string Text after last page link`	319	`* @var string Text after last page link`
313	`* @access private`	320	`* @access private`
314	`*/`	321	`*/`
315	`var $_lastPagePost = ']';`	322	`var $_lastPagePost = ']';`
316		323
317	`/**`	324	`/**`
318	`* @var string Will contain the HTML code for the spaces`	325	`* @var string Will contain the HTML code for the spaces`
319	`* @access private`	326	`* @access private`
320	`*/`	327	`*/`
321	`var $_spacesBefore = '';`	328	`var $_spacesBefore = '';`
322		329
323	`/**`	330	`/**`
324	`* @var string Will contain the HTML code for the spaces`	331	`* @var string Will contain the HTML code for the spaces`
325	`* @access private`	332	`* @access private`
326	`*/`	333	`*/`
327	`var $_spacesAfter = '';`	334	`var $_spacesAfter = '';`
328		335
329	`/**`	336	`/**`
330	`* @var string $_firstLinkTitle`	337	`* @var string $_firstLinkTitle`
331	`* @access private`	338	`* @access private`
332	`*/`	339	`*/`
333	`var $_firstLinkTitle = 'first page';`	340	`var $_firstLinkTitle = 'first page';`
334		341
335	`/**`	342	`/**`
336	`* @var string $_nextLinkTitle`	343	`* @var string $_nextLinkTitle`
337	`* @access private`	344	`* @access private`
338	`*/`	345	`*/`
339	`var $_nextLinkTitle = 'next page';`	346	`var $_nextLinkTitle = 'next page';`
340		347
341	`/**`	348	`/**`
342	`* @var string $_prevLinkTitle`	349	`* @var string $_prevLinkTitle`
343	`* @access private`	350	`* @access private`
344	`*/`	351	`*/`
345	`var $_prevLinkTitle = 'previous page';`	352	`var $_prevLinkTitle = 'previous page';`
346		353
347	`/**`	354	`/**`
348	`* @var string $_lastLinkTitle`	355	`* @var string $_lastLinkTitle`
349	`* @access private`	356	`* @access private`
350	`*/`	357	`*/`
351	`var $_lastLinkTitle = 'last page';`	358	`var $_lastLinkTitle = 'last page';`
352		359
353	`/**`	360	`/**`
354	`* @var string Text to be used for the 'show all' option in the select box`	361	`* @var string Text to be used for the 'show all' option in the select box`
355	`* @access private`	362	`* @access private`
356	`*/`	363	`*/`
357	`var $_showAllText = '';`	364	`var $_showAllText = '';`
358		365
359	`/**`	366	`/**`
360	`* @var array data to be paged`	367	`* @var array data to be paged`
361	`* @access private`	368	`* @access private`
362	`*/`	369	`*/`
363	`var $_itemData = null;`	370	`var $_itemData = null;`
364		371
365	`/**`	372	`/**`
366	`* @var boolean If TRUE and there's only one page, links aren't shown`	373	`* @var boolean If TRUE and there's only one page, links aren't shown`
367	`* @access private`	374	`* @access private`
368	`*/`	375	`*/`
369	`var $_clearIfVoid = true;`	376	`var $_clearIfVoid = true;`
370		377
371	`/**`	378	`/**`
372	`* @var boolean Use session for storing the number of items per page`	379	`* @var boolean Use session for storing the number of items per page`
373	`* @access private`	380	`* @access private`
374	`*/`	381	`*/`
375	`var $_useSessions = false;`	382	`var $_useSessions = false;`
376		383
377	`/**`	384	`/**`
378	`* @var boolean Close the session when finished reading/writing data`	385	`* @var boolean Close the session when finished reading/writing data`
379	`* @access private`	386	`* @access private`
380	`*/`	387	`*/`
381	`var $_closeSession = false;`	388	`var $_closeSession = false;`
382		389
383	`/**`	390	`/**`
384	`* @var string name of the session var for number of items per page`	391	`* @var string name of the session var for number of items per page`
385	`* @access private`	392	`* @access private`
386	`*/`	393	`*/`
387	`var $_sessionVar = 'setPerPage';`	394	`var $_sessionVar = 'setPerPage';`
388		395
389	`/**`	396	`/**`
390	`* Pear error mode (when raiseError is called)`	397	`* Pear error mode (when raiseError is called)`
391	`* (see PEAR doc)`	398	`* (see PEAR doc)`
392	`*`	399	`*`
393	`* @var int $_pearErrorMode`	400	`* @var int $_pearErrorMode`
394	`* @access private`	401	`* @access private`
395	`*/`	402	`*/`
396	`var $_pearErrorMode = null;`	403	`var $_pearErrorMode = null;`
397		404
398	`// }}}`	405	`// }}}`
399	`// {{{ public vars`	406	`// {{{ public vars`
400		407
401	`/**`	408	`/**`
402	`* @var string Complete set of links`	409	`* @var string Complete set of links`
403	`* @access public`	410	`* @access public`
404	`*/`	411	`*/`
405	`var $links = '';`	412	`var $links = '';`
406		413
407	`/**`	414	`/**`
408	`* @var string Complete set of link tags`	415	`* @var string Complete set of link tags`
409	`* @access public`	416	`* @access public`
410	`*/`	417	`*/`
411	`var $linkTags = '';`	418	`var $linkTags = '';`
412		419
413	`/**`	420	`/**`
414	`* @var array Array with a key => value pair representing`	421	`* @var array Array with a key => value pair representing`
415	`* page# => bool value (true if key==currentPageNumber).`	422	`* page# => bool value (true if key==currentPageNumber).`
416	`* can be used for extreme customization.`	423	`* can be used for extreme customization.`
417	`* @access public`	424	`* @access public`
418	`*/`	425	`*/`
419	`var $range = array();`	426	`var $range = array();`
420		427
421	`/**`	428	`/**`
422	`* @var array list of available options (safety check)`	429	`* @var array list of available options (safety check)`
423	`* @access private`	430	`* @access private`
424	`*/`	431	`*/`
425	`var $_allowed_options = array(`	432	`var $_allowed_options = array(`
426	`'totalItems',`	433	`'totalItems',`
427	`'perPage',`	434	`'perPage',`
428	`'delta',`	435	`'delta',`
429	`'linkClass',`	436	`'linkClass',`
430	`'path',`	437	`'path',`
431	`'fileName',`	438	`'fileName',`
432	`'fixFileName',`	439	`'fixFileName',`
433	`'append',`	440	`'append',`
434	`'httpMethod',`	441	`'httpMethod',`
435	`'formID',`	442	`'formID',`
436	`'importQuery',`	443	`'importQuery',`
437	`'urlVar',`	444	`'urlVar',`
438	`'altFirst',`	445	`'altFirst',`
439	`'altPrev',`	446	`'altPrev',`
440	`'altNext',`	447	`'altNext',`
441	`'altLast',`	448	`'altLast',`
442	`'altPage',`	449	`'altPage',`
443	`'prevImg',`	450	`'prevImg',`
444	`'nextImg',`	451	`'nextImg',`
445	`'expanded',`	452	`'expanded',`
446	`'accesskey',`	453	`'accesskey',`
447	`'attributes',`	454	`'attributes',`
-		455	`'onclick',`
448	`'separator',`	456	`'separator',`
449	`'spacesBeforeSeparator',`	457	`'spacesBeforeSeparator',`
450	`'spacesAfterSeparator',`	458	`'spacesAfterSeparator',`
451	`'curPageLinkClassName',`	459	`'curPageLinkClassName',`
452	`'curPageSpanPre',`	460	`'curPageSpanPre',`
453	`'curPageSpanPost',`	461	`'curPageSpanPost',`
454	`'firstPagePre',`	462	`'firstPagePre',`
455	`'firstPageText',`	463	`'firstPageText',`
456	`'firstPagePost',`	464	`'firstPagePost',`
457	`'lastPagePre',`	465	`'lastPagePre',`
458	`'lastPageText',`	466	`'lastPageText',`
459	`'lastPagePost',`	467	`'lastPagePost',`
460	`'firstLinkTitle',`	468	`'firstLinkTitle',`
461	`'nextLinkTitle',`	469	`'nextLinkTitle',`
462	`'prevLinkTitle',`	470	`'prevLinkTitle',`
463	`'lastLinkTitle',`	471	`'lastLinkTitle',`
464	`'showAllText',`	472	`'showAllText',`
465	`'itemData',`	473	`'itemData',`
466	`'clearIfVoid',`	474	`'clearIfVoid',`
467	`'useSessions',`	475	`'useSessions',`
468	`'closeSession',`	476	`'closeSession',`
469	`'sessionVar',`	477	`'sessionVar',`
470	`'pearErrorMode',`	478	`'pearErrorMode',`
471	`'extraVars',`	479	`'extraVars',`
472	`'excludeVars',`	480	`'excludeVars',`
473	`'currentPage',`	481	`'currentPage',`
474	`);`	482	`);`
475		483
476	`// }}}`	484	`// }}}`
477	`// {{{ build()`	485	`// {{{ build()`
478		486
479	`/**`	487	`/**`
480	`* Generate or refresh the links and paged data after a call to setOptions()`	488	`* Generate or refresh the links and paged data after a call to setOptions()`
481	`*`	489	`*`
482	`* @access public`	490	`* @access public`
483	`*/`	491	`*/`
484	`function build()`	492	`function build()`
485	`{`	493	`{`
-		494	`//reset`
-		495	`$this->_pageData = array();`
-		496	`$this->links = '';`
-		497
486	`$msg = '<b>PEAR::Pager Error:</b>'`	498	`$this->_generatePageData();`
-		499	`$this->_setFirstLastText();`
-		500

Subversion Repositories Applications.papyrus

(root)/trunk/api/pear/Pager/Common.php @ 2150 – Rev 848 → 1713