cvs: pear /PEAR/Pager_Sliding Sliding.php package.xml /PEAR/Pager_Sliding/examples Sliding_example1.php Sliding_example2.php Sliding_example3.php
Sliding_example4.php
| From: | Lorenzo Alberton | Date: | Sun, 08 Dec 2002 12:08:41 +0000 |
| Subject: | cvs: pear /PEAR/Pager_Sliding Sliding.php package.xml /PEAR/Pager_Sliding/examples Sliding_example1.php Sliding_example2.php Sliding_example3.php Sliding_example4.php |
||
| Groups: | php.pear.cvs | ||
| Request: | Send a blank email to pear-cvs+get-7774@lists.php.net to get a copy of this message | ||
quipo Sun Dec 8 07:08:41 2002 EDT
Added files:
/pear/PEAR/Pager_Sliding Sliding.php package.xml
/pear/PEAR/Pager_Sliding/examples Sliding_example1.php
Sliding_example2.php
Sliding_example3.php
Sliding_example4.php
Log:
Index: pear/PEAR/Pager_Sliding/Sliding.php +++ pear/PEAR/Pager_Sliding/Sliding.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ // // $Id: Sliding.php,v 1.1 2002/12/08 12:08:40 quipo Exp $ /** * Pager_Sliding - Sliding Window Pager * * Usage examples can be found in the doc provided * * @author Lorenzo Alberton <l.alberton at quipo.it> * @version $Id: Sliding.php,v 1.1 2002/12/08 12:08:40 quipo Exp $ */ define('CURRENT_FILENAME', basename($_SERVER['PHP_SELF'])); define('CURRENT_PATHNAME', str_replace('\\','/',dirname($_SERVER['PHP_SELF']))); class Pager_Sliding { // {{{ private class vars var $_totalItems; var $_perPage = 10; var $_delta = 2; var $_currentPage = 1; var $_linkClass = ''; var $_classString = ''; var $_path = CURRENT_PATHNAME; var $_fileName = CURRENT_FILENAME; var $_append = true; var $_urlVar = 'pageID'; var $_altPrev = 'previous page'; var $_altNext = 'next page'; var $_altPage = 'page'; var $_prevImg = '«'; var $_nextImg = '»'; var $_expanded = false; var $_separator = '|'; var $_spacesBeforeSeparator = 3; var $_spacesAfterSeparator = 3; var $_curPageLinkClassName = ''; var $_curPageSpanPre = ''; var $_curPageSpanPost = ''; var $_firstPagePre = '['; var $_firstPagePost = ']'; var $_lastPagePre = '['; var $_lastPagePost = ']'; var $_spacesBefore = ''; var $_spacesAfter = ''; var $_itemData = null; var $_clearIfVoid = true; // }}} /** * String with a complete set of links * @var string */ var $links = ''; /** * Array with a key => value pair representing * page# => bool value (true if key==currentPageNumber). * can be used for extreme customization. * @var string */ var $range = array(); // {{{ Pager_Sliding() /** * Constructor * * ------------------------------------------------------------------------- * VALID options are (default values are set some lines before): * - totalItems (int): # of items to page. * - perPage (int): # of items per page. * - delta (int): # of page #s to show before and after the current * one * - expanded (bool): if true, window size is always 2*delta+1 * - linkClass (string): name of CSS class used for link styling. * - append (bool): if true pageID is appended as GET value to the * URL - if false it is embedded in the URL * according to "fileName" specs * - path (string): complete path to the page (without the page name) * - fileName (string): name of the page, with a %d if append=true * - urlVar (string): name of pageNumber URL var, for example "pageID" * - altPrev (string): alt text to display for prev page, on prev link. * - altNext (string): alt text to display for next page, on next link. * - altPage (string): alt text to display before the page number. * - prevImg (string): sth (it can be text such as "<< PREV" or an * <img/> as well...) to display instead of "<<". * - nextImg (string): same as prevImg, used for NEXT link, instead of * the default value, which is ">>". * - separator (string): what to use to separate numbers (can be an * <img/>, a comma, an hyphen, or whatever. * - spacesBeforeSeparator * (int): number of spaces before the separator. * - firstPagePre (string): * string used before first page number (can be an * <img/>, a "{", an empty string, or whatever. * - firstPagePost (string): * string used after first page number (can be an * <img/>, a "}", an empty string, or whatever. * - lastPagePre (string): * similar to firstPagePre. * - lastPagePost (string): * similar to firstPagePost. * - spacesAfterSeparator * (int): number of spaces after the separator. * - curPageLinkClassName * (string): name of CSS class used for current page link. * - clearIfVoid(bool): if there's only one page, don't display pager. * - itemData (array): array of items to page. * ------------------------------------------------------------------------- * REQUIRED options are: * - fileName IF append==false (default is true) * - itemData OR totalItems (if itemData is set, totalItems is overwritten) * ------------------------------------------------------------------------- * * @param mixed $options An associative array of option names and * their values. */ function Pager_Sliding($options) { $this->_setOptions($options); $this->_generatePageData(); if ($this->_totalPages > (2 * $this->_delta + 1)) { $this->links .= $this->_printFirstPage(); } $this->links .= $this->_getBackLink(); $this->links .= $this->_getPageLinks(); $this->links .= $this->_getNextLink(); 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 */ function getPageData($pageID = null) { if (isset($pageID)) { if (!empty($this->_pageData[$pageID])) { return $this->_pageData[$pageID]; } else { return false; } } if (!isset($this->_pageData)) { $this->_generatePageData(); } return $this->getPageData($this->_currentPage); } // }}} // {{{ getPageIdByOffset() /** * "Overload" PEAR::Pager method. VOID. Not needed here... * @param $index Offset to get pageID for * @deprecated */ function getPageIdByOffset($index) { } // }}} // {{{ getOffsetByPageId() /** * Returns offsets for given pageID. Eg, if you pass it pageID 5 and your * delta is 2 it will return you 3 and 7. PageID of 6 would give you 4 and 8 * * NB: The behaviour of this function could be misleading: * I didn't know if leave it, but I did for compatibility with PEAR::Pager. * It could raise some confusion when pageID is within delta positions from * an extreme: in fact this method returns also the extremes, while * $this->_getPageLinks leaves them out. This happens because I conceived * Pager_Sliding this way: if pageID is NOT an extreme, show first and * last page within brackets: [1] << 5 | _6_ | 7 >> [15] * So when dealing with pageID within delta positions from an extreme, * this method would return the extreme as well, while $this->_getPageLinks * would return (for instance) 2 | _3_ | 4 | 5 even if pageID is 3 and * delta is 2. * In other words: consider this method deprecated and/or subject to changes * * @param pageID PageID to get offsets for * @return array First and last offsets * @deprecated */ function getOffsetByPageId($pageid = null) { $pageid = isset($pageid) ? $pageid : $this->_currentPage; if (!isset($this->_pageData)) { $this->_generatePageData(); } if (isset($this->_pageData[$pageid]) OR $this->_itemData === null) { return array( max($pageid - $this->_delta, 1), min($pageid + $this->_delta, $this->numPages())); } else { return array(0,0); } } // }}} // {{{ 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 pages' 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 == 1); } // }}} // {{{ 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 page complete or not */ function isLastPageComplete() { return !($this->_totalItems % $this->_perPage); } // }}} // {{{ getLinks() /** * Returns back/next/first/last and page links, * both as ordered and associative array. * * @return array back/pages/next/first/last/all links */ function getLinks() { $back = str_replace(' ','', $this->_getBackLink()); $next = str_replace(' ','', $this->_getNextLink()); $pages = $this->_getPageLinks(); $first = $this->_printFirstPage(); $last = $this->_printLastPage(); $all = $this->links; return array( $back, $pages, trim($next), $first, $last, $all, 'back' => $back, 'pages' => $pages, 'next' => $next, 'first' => $first, 'last' => $last, 'all' => $all ); } // }}} // {{{ _getPageLinks() /** * Returns pages link * * @return string Links * @access private */ function _getPageLinks() { $links = ''; if ($this->_totalPages > (2 * $this->_delta + 1)) { if($this->_expanded) { if(($this->_totalPages - $this->_delta) <= $this->_currentPage) { $_expansion_before = $this->_currentPage - ($this->_totalPages - $this->_delta); if($this->_currentPage != $this->_totalPages) $_expansion_before++; } else { $_expansion_before = 0; } for($i = $this->_currentPage - $this->_delta - $_expansion_before; $_expansion_before; $_expansion_before--, $i++) { if(($i != $this->_currentPage + $this->_delta) && ($i != $this->_totalPages - 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } $_expansion_after = 0; for($i = $this->_currentPage - $this->_delta; ($i <= $this->_currentPage + $this->_delta) && ($i < $this->_totalPages); $i++) { if($i<2 && $i!=$this->_currentPage) { $_expansion_after++; continue; } // check when to print separator if(($i != $this->_currentPage + $this->_delta) && ($i != $this->_totalPages - 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } if($i == $this->_currentPage) { $this->range[$i] = true; $links .= $this->_curPageSpanPre . $i . $this->_curPageSpanPost . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } else { $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } if($this->_currentPage == $this->_totalPages) { $this->range[$this->_currentPage] = true; $links .= $this->_separator . $this->_spacesAfter . $this->_curPageSpanPre . $this->_totalPages . $this->_curPageSpanPost; } if($this->_expanded && $_expansion_after) { $links .= $this->_separator . $this->_spacesAfter; for($i = $this->_currentPage + $this->_delta +1; $_expansion_after; $_expansion_after--, $i++) { if(($_expansion_after != 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } } else { //if $this->_totalPages <= (2*Delta+1) show them all for ($i=1; $i<=$this->_totalPages; $i++) { if($i != $this->_currentPage) { $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i); } else { $this->range[$i] = true; $links .= $this->_curPageSpanPre . $i . $this->_curPageSpanPost; } $links .= $this->_spacesBefore . (($i != $this->_totalPages) ? $this->_separator.$this->_spacesAfter : ''); } } if($this->_clearIfVoid) { //If there's only one page, don't display links if($this->numPages() < 2) $links = ''; } return $links; } // }}} // {{{ _getBackLink() /** * Returns back link * * @param $url URL to use in the link * @param $link HTML to use as the link * @return string The link * @access private */ function _getBackLink() //function _getBackLink($url, $link = '<< Back') { if ($this->_currentPage > 1) { $back = sprintf('<a href="%s" %s title="%s">%s</a>', ( $this->_append ? $this->_url.$this->getPreviousPageID() : $this->_url.sprintf($this->_fileName, $this->getPreviousPageID()) ), $this->_classString, $this->_altPrev, $this->_prevImg) . $this->_spacesBefore . $this->_spacesAfter; } else { $back = ''; } return $back; } // }}} // {{{ _getNextLink() /** * Returns next link * * @param $url URL to use in the link * @param $link HTML to use as the link * @return string The link * @access private */ function _getNextLink() //function _getNextLink($url, $link = 'Next >>') { if ($this->_currentPage < $this->_totalPages) { $next = $this->_spacesAfter . sprintf('<a href="%s" %s title="%s">%s</a>', ( $this->_append ? $this->_url.$this->getNextPageID() : $this->_url.sprintf($this->_fileName, $this->getNextPageID()) ), $this->_classString, $this->_altNext, $this->_nextImg) . $this->_spacesBefore . $this->_spacesAfter; } else { $next = ''; } return $next; } // }}} // {{{ _printFirstPage() /** * Print [1] * * @access private */ function _printFirstPage() { if ($this->isFirstPage()) { return ''; } else { return sprintf('<a href="%s" %s title="%s">%s1%s</a>', ( $this->_append ? $this->_url.'1' : $this->_url.sprintf($this->_fileName, 1) ), $this->_classString, $this->_altPage.' 1', $this->_firstPagePre, $this->_firstPagePost) . $this->_spacesBefore . $this->_spacesAfter; } } // }}} // {{{ _printLastPage() /** * Print [numPages()] * * @access private */ function _printLastPage() { if ($this->isLastPage()) { return ''; } else { return sprintf('<a href="%s" %s title="%s">%s%d%s</a>', ( $this->_append ? $this->_url.$this->numPages() : $this->_url.sprintf($this->_fileName, $this->numPages()) ), $this->_classString, $this->_altPage.' '.$this->numPages(), $this->_lastPagePre, $this->numPages(), $this->_lastPagePost); } } // }}} // {{{ _generatePageData() /** * Calculates all page data * * @access private */ function _generatePageData() { if ($this->_itemData !== null) { $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(); } } // }}} // {{{ _getLinksUrl() /** * Returns the correct link for the back/pages/next links * * @return string Url * @access private */ function _getLinksUrl() { global $_SERVER; // Sort out query string to prevent messy urls $querystring = array(); $qs = array(); if (!empty($_SERVER['QUERY_STRING'])) { $qs = explode('&', $_SERVER['QUERY_STRING']); for ($i=0, $cnt=count($qs); $i<$cnt; $i++) { list($name, $value) = explode('=', $qs[$i]); if ($name != $this->_urlVar) { $qs[$name] = $value; } unset($qs[$i]); } } foreach ($qs as $name => $value) { $querystring[] = $name . '=' . $value; } return '?' . implode('&', $querystring) . (!empty($querystring) ? '&' : '') . $this->_urlVar .'='; } // }}} // {{{ _setOptions() /** * 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'); PEAR::raiseError($msg, $code, $this->_pearErrorMode); } // }}} // {{{ _setOptions() /** * Set and sanitize options * * @param mixed $options An associative array of option names and * their values. * @access private */ function _setOptions($options) { global $HTTP_GET_VARS; $allowed_options = array( 'totalItems', 'perPage', 'delta', 'linkClass', 'path', 'fileName', 'append', 'urlVar', 'altPrev', 'altNext', 'altPage', 'prevImg', 'nextImg', 'expanded', 'separator', 'spacesBeforeSeparator', 'spacesAfterSeparator', 'curPageLinkClassName', 'firstPagePre', 'firstPagePost', 'lastPagePre', 'lastPagePost', 'itemData', 'clearIfVoid' ); foreach($options as $key => $value) { if(in_array($key, $allowed_options) && ($value !== null)) { $this->{'_' . $key} = $value; } } $this->_fileName = ltrim($this->_fileName, '/'); //strip leading slash $this->_path = rtrim($this->_path, '/'); //strip trailing slash if($this->_append) { $this->_fileName = CURRENT_FILENAME; //avoid easy-verified user error; $this->_url = $this->_path.'/'.$this->_fileName.$this->_getLinksUrl(); } else { if(!strstr($this->_fileName,'%d')) { $msg = '<b>Pager_Sliding Error:</b>' .' "fileName" format not valid. Use "%d" as placeholder.'; return $this->raiseError($msg, -1); } $this->_url = $this->_path.'/'; } if(strlen($this->_linkClass)) { $this->_classString = 'class="'.$this->_linkClass.'"'; } else { $this->_classString = ''; } if(strlen($this->_curPageLinkClassName)) { $this->_curPageSpanPre = '<span class="'.$this->_curPageLinkClassName.'">'; $this->_curPageSpanPost = '</span>'; } else { $this->_curPageSpanPre = '<b><u>'; $this->_curPageSpanPost = '</u></b>'; } if($this->_perPage < 1) { //avoid easy-verified user error $this->_perPage = 1; } for($i=0; $i<$this->_spacesBeforeSeparator; $i++) { $this->_spacesBefore .= ' '; } for($i=0; $i<$this->_spacesAfterSeparator; $i++) { $this->_spacesAfter .= ' '; } $this->_currentPage = max((int)@$HTTP_GET_VARS[$this->_urlVar], 1); } // }}} } ?> Index: pear/PEAR/Pager_Sliding/package.xml +++ pear/PEAR/Pager_Sliding/package.xml <?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE package SYSTEM "../package.dtd"> <package version="1.0"> <name>Pager_Sliding</name> <summary>Sliding Window Pager.</summary> <description> It takes an array of data as input and page it according to various parameters. It also builds links within a specified range, and allows complete customization of the output (it even works with mod_rewrite). It is compatible with PEAR::Pager's API </description> <license>PHP License</license> <maintainers> <maintainer> <user>quipo</user> <name>Lorenzo Alberton</name> <email>l.alberton@quipo.it</email> <role>lead</role> </maintainer> </maintainers> <release> <version>1.1.6</version> <date>2002-11-22</date> <state>stable</state> <notes> This is the first release. </notes> <filelist> <dir name="/" baseinstalldir="Pager"> <file role="php" name="Sliding.php" /> <file role="doc" name="examples/Sliding_example1.php"> <file role="doc" name="examples/Sliding_example2.php"> <file role="doc" name="examples/Sliding_example3.php"> <file role="doc" name="examples/Sliding_example4.php"> </dir> </filelist> </release> </package> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example1.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example1.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding example 1</title> <style type="text/css"> <!-- myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example3.php">Example3</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 1</h2> <pre> SETTINGS: $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); </pre> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre><?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> <pre> NB: <b>echo $pager->links</b> is the same as <b>$links = $pager->getLinks(); echo $links['all']; </b> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example2.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example2.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example3.php">Example3</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 2</h2> <?php $params = array( 'separator' => ',', 'spacesBeforeSeparator' => 0, 'spacesAfterSeparator' => 3, 'perPage' => 3, 'delta' => 3, 'urlVar' => 'ID', 'altPrev' => 'Pagina precedente', 'altNext' => 'Pagina successiva', 'altPage' => 'pagina n.', 'prevImg' => '<img src="prev.gif" border="0" />', 'nextImg' => '<img src="next.gif" border="0" />', 'linkClass' => 'myClass', 'firstPagePre' => '', 'firstPagePost' => '', 'lastPagePre' => '{', 'lastPagePost' => '}', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <pre> SETTINGS: $params = array( 'separator' => ',', 'spacesBeforeSeparator' => 0, 'spacesAfterSeparator' => 3, 'perPage' => 3, 'delta' => 3, 'urlVar' => 'ID', 'altPrev' => 'Pagina precedente', 'altNext' => 'Pagina successiva', 'altPage' => 'pagina n.', 'prevImg' => '<img src="prev.gif" />', 'nextImg' => '<img src="next.gif" />', 'linkClass' => 'myClass', 'firstPagePre' => '', 'firstPagePost' => '', 'lastPagePre' => '{', 'lastPagePost' => '}', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); </pre> <hr /> <b>Have a look at:</b><br /> - separator <i>(comma instead of pipe)</i>,<br /> - alt text <i>("pagina" instead of "page")</i>, <br /> - img used as prev/next links <i>(image instead of « »)</i>, <br /> - different urlVar used than default <i>("ID" instead of "pageID")</i>,<br /> - CSS <i>(red links)</i>,<br /> - number of page numbers showed <i>(delta=3 instead of 2)</i>,<br /> - last page embraced by curly braces <i>(instead of [9])</i>,<br /> - first page not embraced by anything <i>(instead of [1])</i><br /> <br /> <br /> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example3.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example3.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 3</h2> <?php $month = 'september'; $params = array( 'append' => false, 'urlVar' => 'num', 'path' => 'http://myserver.com/articles/' . $month, 'fileName' => 'art%d.html', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z'), 'perPage' => 3 ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <h3>This shows how this Pager can be used with mod_rewrite</h3> <h5 style="color: red; font-weight: 700;">NB: on this server mod_rewrite is not active, so links won't work, but have a look at the status bar to see how url is written.</h5> <br /> <pre> Let's suppose we have a .htaccess like this: ----------------------------------- RewriteEngine on #Options FollowSymlinks RewriteBase / RewriteRule ^articles/([a-z]{1,12})/art([0-9]{1,4})\.html$ /article.php?num=$2&month=$1 [L] ----------------------------------- It should transform an url like: /articles/march/art15.html into: /article.php?num=15&month=march </pre> <br /> <hr /> <pre> SETTINGS: $month = 'september'; $params = array( 'append' => false, 'urlVar' => 'num', 'path' => 'http://myserver.com/articles/' . $month, 'fileName' => 'art%d.html', //Pager replaces "%d" with page number... 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z'), 'perPage' => 3 ); $pager = &new Pager_Sliding($params); </pre> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example4.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example4.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example3.php">Example3</a> - <a href="../">home</a> <hr /> <h2>Example 4</h2> <?php $params = array( 'perPage' => 3, 'delta' => 2, 'expanded' => true, 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <pre> SETTINGS: $params = array( 'perPage' => 3, 'delta' => 2, 'expanded' => true, 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); </pre> <hr /> <b>Have a look at "expanded" mode:</b> Window width is always 2*$delta+1 <br /> <br /> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html>
Index: pear/PEAR/Pager_Sliding/Sliding.php +++ pear/PEAR/Pager_Sliding/Sliding.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ // // $Id: Sliding.php,v 1.1 2002/12/08 12:08:40 quipo Exp $ /** * Pager_Sliding - Sliding Window Pager * * Usage examples can be found in the doc provided * * @author Lorenzo Alberton <l.alberton at quipo.it> * @version $Id: Sliding.php,v 1.1 2002/12/08 12:08:40 quipo Exp $ */ define('CURRENT_FILENAME', basename($_SERVER['PHP_SELF'])); define('CURRENT_PATHNAME', str_replace('\\','/',dirname($_SERVER['PHP_SELF']))); class Pager_Sliding { // {{{ private class vars var $_totalItems; var $_perPage = 10; var $_delta = 2; var $_currentPage = 1; var $_linkClass = ''; var $_classString = ''; var $_path = CURRENT_PATHNAME; var $_fileName = CURRENT_FILENAME; var $_append = true; var $_urlVar = 'pageID'; var $_altPrev = 'previous page'; var $_altNext = 'next page'; var $_altPage = 'page'; var $_prevImg = '«'; var $_nextImg = '»'; var $_expanded = false; var $_separator = '|'; var $_spacesBeforeSeparator = 3; var $_spacesAfterSeparator = 3; var $_curPageLinkClassName = ''; var $_curPageSpanPre = ''; var $_curPageSpanPost = ''; var $_firstPagePre = '['; var $_firstPagePost = ']'; var $_lastPagePre = '['; var $_lastPagePost = ']'; var $_spacesBefore = ''; var $_spacesAfter = ''; var $_itemData = null; var $_clearIfVoid = true; // }}} /** * String with a complete set of links * @var string */ var $links = ''; /** * Array with a key => value pair representing * page# => bool value (true if key==currentPageNumber). * can be used for extreme customization. * @var string */ var $range = array(); // {{{ Pager_Sliding() /** * Constructor * * ------------------------------------------------------------------------- * VALID options are (default values are set some lines before): * - totalItems (int): # of items to page. * - perPage (int): # of items per page. * - delta (int): # of page #s to show before and after the current * one * - expanded (bool): if true, window size is always 2*delta+1 * - linkClass (string): name of CSS class used for link styling. * - append (bool): if true pageID is appended as GET value to the * URL - if false it is embedded in the URL * according to "fileName" specs * - path (string): complete path to the page (without the page name) * - fileName (string): name of the page, with a %d if append=true * - urlVar (string): name of pageNumber URL var, for example "pageID" * - altPrev (string): alt text to display for prev page, on prev link. * - altNext (string): alt text to display for next page, on next link. * - altPage (string): alt text to display before the page number. * - prevImg (string): sth (it can be text such as "<< PREV" or an * <img/> as well...) to display instead of "<<". * - nextImg (string): same as prevImg, used for NEXT link, instead of * the default value, which is ">>". * - separator (string): what to use to separate numbers (can be an * <img/>, a comma, an hyphen, or whatever. * - spacesBeforeSeparator * (int): number of spaces before the separator. * - firstPagePre (string): * string used before first page number (can be an * <img/>, a "{", an empty string, or whatever. * - firstPagePost (string): * string used after first page number (can be an * <img/>, a "}", an empty string, or whatever. * - lastPagePre (string): * similar to firstPagePre. * - lastPagePost (string): * similar to firstPagePost. * - spacesAfterSeparator * (int): number of spaces after the separator. * - curPageLinkClassName * (string): name of CSS class used for current page link. * - clearIfVoid(bool): if there's only one page, don't display pager. * - itemData (array): array of items to page. * ------------------------------------------------------------------------- * REQUIRED options are: * - fileName IF append==false (default is true) * - itemData OR totalItems (if itemData is set, totalItems is overwritten) * ------------------------------------------------------------------------- * * @param mixed $options An associative array of option names and * their values. */ function Pager_Sliding($options) { $this->_setOptions($options); $this->_generatePageData(); if ($this->_totalPages > (2 * $this->_delta + 1)) { $this->links .= $this->_printFirstPage(); } $this->links .= $this->_getBackLink(); $this->links .= $this->_getPageLinks(); $this->links .= $this->_getNextLink(); 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 */ function getPageData($pageID = null) { if (isset($pageID)) { if (!empty($this->_pageData[$pageID])) { return $this->_pageData[$pageID]; } else { return false; } } if (!isset($this->_pageData)) { $this->_generatePageData(); } return $this->getPageData($this->_currentPage); } // }}} // {{{ getPageIdByOffset() /** * "Overload" PEAR::Pager method. VOID. Not needed here... * @param $index Offset to get pageID for * @deprecated */ function getPageIdByOffset($index) { } // }}} // {{{ getOffsetByPageId() /** * Returns offsets for given pageID. Eg, if you pass it pageID 5 and your * delta is 2 it will return you 3 and 7. PageID of 6 would give you 4 and 8 * * NB: The behaviour of this function could be misleading: * I didn't know if leave it, but I did for compatibility with PEAR::Pager. * It could raise some confusion when pageID is within delta positions from * an extreme: in fact this method returns also the extremes, while * $this->_getPageLinks leaves them out. This happens because I conceived * Pager_Sliding this way: if pageID is NOT an extreme, show first and * last page within brackets: [1] << 5 | _6_ | 7 >> [15] * So when dealing with pageID within delta positions from an extreme, * this method would return the extreme as well, while $this->_getPageLinks * would return (for instance) 2 | _3_ | 4 | 5 even if pageID is 3 and * delta is 2. * In other words: consider this method deprecated and/or subject to changes * * @param pageID PageID to get offsets for * @return array First and last offsets * @deprecated */ function getOffsetByPageId($pageid = null) { $pageid = isset($pageid) ? $pageid : $this->_currentPage; if (!isset($this->_pageData)) { $this->_generatePageData(); } if (isset($this->_pageData[$pageid]) OR $this->_itemData === null) { return array( max($pageid - $this->_delta, 1), min($pageid + $this->_delta, $this->numPages())); } else { return array(0,0); } } // }}} // {{{ 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 pages' 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 == 1); } // }}} // {{{ 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 page complete or not */ function isLastPageComplete() { return !($this->_totalItems % $this->_perPage); } // }}} // {{{ getLinks() /** * Returns back/next/first/last and page links, * both as ordered and associative array. * * @return array back/pages/next/first/last/all links */ function getLinks() { $back = str_replace(' ','', $this->_getBackLink()); $next = str_replace(' ','', $this->_getNextLink()); $pages = $this->_getPageLinks(); $first = $this->_printFirstPage(); $last = $this->_printLastPage(); $all = $this->links; return array( $back, $pages, trim($next), $first, $last, $all, 'back' => $back, 'pages' => $pages, 'next' => $next, 'first' => $first, 'last' => $last, 'all' => $all ); } // }}} // {{{ _getPageLinks() /** * Returns pages link * * @return string Links * @access private */ function _getPageLinks() { $links = ''; if ($this->_totalPages > (2 * $this->_delta + 1)) { if($this->_expanded) { if(($this->_totalPages - $this->_delta) <= $this->_currentPage) { $_expansion_before = $this->_currentPage - ($this->_totalPages - $this->_delta); if($this->_currentPage != $this->_totalPages) $_expansion_before++; } else { $_expansion_before = 0; } for($i = $this->_currentPage - $this->_delta - $_expansion_before; $_expansion_before; $_expansion_before--, $i++) { if(($i != $this->_currentPage + $this->_delta) && ($i != $this->_totalPages - 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } $_expansion_after = 0; for($i = $this->_currentPage - $this->_delta; ($i <= $this->_currentPage + $this->_delta) && ($i < $this->_totalPages); $i++) { if($i<2 && $i!=$this->_currentPage) { $_expansion_after++; continue; } // check when to print separator if(($i != $this->_currentPage + $this->_delta) && ($i != $this->_totalPages - 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } if($i == $this->_currentPage) { $this->range[$i] = true; $links .= $this->_curPageSpanPre . $i . $this->_curPageSpanPost . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } else { $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } if($this->_currentPage == $this->_totalPages) { $this->range[$this->_currentPage] = true; $links .= $this->_separator . $this->_spacesAfter . $this->_curPageSpanPre . $this->_totalPages . $this->_curPageSpanPost; } if($this->_expanded && $_expansion_after) { $links .= $this->_separator . $this->_spacesAfter; for($i = $this->_currentPage + $this->_delta +1; $_expansion_after; $_expansion_after--, $i++) { if(($_expansion_after != 1)) { $_print_separator_flag = true; } else { $_print_separator_flag = false; } $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i) . $this->_spacesBefore . ($_print_separator_flag ? $this->_separator.$this->_spacesAfter : ''); } } } else { //if $this->_totalPages <= (2*Delta+1) show them all for ($i=1; $i<=$this->_totalPages; $i++) { if($i != $this->_currentPage) { $this->range[$i] = false; $links .= sprintf('<a href="%s" %s title="%s">%d</a>', ( $this->_append ? $this->_url.$i : $this->_url.sprintf($this->_fileName, $i) ), $this->_classString, $this->_altPage.' '.$i, $i); } else { $this->range[$i] = true; $links .= $this->_curPageSpanPre . $i . $this->_curPageSpanPost; } $links .= $this->_spacesBefore . (($i != $this->_totalPages) ? $this->_separator.$this->_spacesAfter : ''); } } if($this->_clearIfVoid) { //If there's only one page, don't display links if($this->numPages() < 2) $links = ''; } return $links; } // }}} // {{{ _getBackLink() /** * Returns back link * * @param $url URL to use in the link * @param $link HTML to use as the link * @return string The link * @access private */ function _getBackLink() //function _getBackLink($url, $link = '<< Back') { if ($this->_currentPage > 1) { $back = sprintf('<a href="%s" %s title="%s">%s</a>', ( $this->_append ? $this->_url.$this->getPreviousPageID() : $this->_url.sprintf($this->_fileName, $this->getPreviousPageID()) ), $this->_classString, $this->_altPrev, $this->_prevImg) . $this->_spacesBefore . $this->_spacesAfter; } else { $back = ''; } return $back; } // }}} // {{{ _getNextLink() /** * Returns next link * * @param $url URL to use in the link * @param $link HTML to use as the link * @return string The link * @access private */ function _getNextLink() //function _getNextLink($url, $link = 'Next >>') { if ($this->_currentPage < $this->_totalPages) { $next = $this->_spacesAfter . sprintf('<a href="%s" %s title="%s">%s</a>', ( $this->_append ? $this->_url.$this->getNextPageID() : $this->_url.sprintf($this->_fileName, $this->getNextPageID()) ), $this->_classString, $this->_altNext, $this->_nextImg) . $this->_spacesBefore . $this->_spacesAfter; } else { $next = ''; } return $next; } // }}} // {{{ _printFirstPage() /** * Print [1] * * @access private */ function _printFirstPage() { if ($this->isFirstPage()) { return ''; } else { return sprintf('<a href="%s" %s title="%s">%s1%s</a>', ( $this->_append ? $this->_url.'1' : $this->_url.sprintf($this->_fileName, 1) ), $this->_classString, $this->_altPage.' 1', $this->_firstPagePre, $this->_firstPagePost) . $this->_spacesBefore . $this->_spacesAfter; } } // }}} // {{{ _printLastPage() /** * Print [numPages()] * * @access private */ function _printLastPage() { if ($this->isLastPage()) { return ''; } else { return sprintf('<a href="%s" %s title="%s">%s%d%s</a>', ( $this->_append ? $this->_url.$this->numPages() : $this->_url.sprintf($this->_fileName, $this->numPages()) ), $this->_classString, $this->_altPage.' '.$this->numPages(), $this->_lastPagePre, $this->numPages(), $this->_lastPagePost); } } // }}} // {{{ _generatePageData() /** * Calculates all page data * * @access private */ function _generatePageData() { if ($this->_itemData !== null) { $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(); } } // }}} // {{{ _getLinksUrl() /** * Returns the correct link for the back/pages/next links * * @return string Url * @access private */ function _getLinksUrl() { global $_SERVER; // Sort out query string to prevent messy urls $querystring = array(); $qs = array(); if (!empty($_SERVER['QUERY_STRING'])) { $qs = explode('&', $_SERVER['QUERY_STRING']); for ($i=0, $cnt=count($qs); $i<$cnt; $i++) { list($name, $value) = explode('=', $qs[$i]); if ($name != $this->_urlVar) { $qs[$name] = $value; } unset($qs[$i]); } } foreach ($qs as $name => $value) { $querystring[] = $name . '=' . $value; } return '?' . implode('&', $querystring) . (!empty($querystring) ? '&' : '') . $this->_urlVar .'='; } // }}} // {{{ _setOptions() /** * 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'); PEAR::raiseError($msg, $code, $this->_pearErrorMode); } // }}} // {{{ _setOptions() /** * Set and sanitize options * * @param mixed $options An associative array of option names and * their values. * @access private */ function _setOptions($options) { global $HTTP_GET_VARS; $allowed_options = array( 'totalItems', 'perPage', 'delta', 'linkClass', 'path', 'fileName', 'append', 'urlVar', 'altPrev', 'altNext', 'altPage', 'prevImg', 'nextImg', 'expanded', 'separator', 'spacesBeforeSeparator', 'spacesAfterSeparator', 'curPageLinkClassName', 'firstPagePre', 'firstPagePost', 'lastPagePre', 'lastPagePost', 'itemData', 'clearIfVoid' ); foreach($options as $key => $value) { if(in_array($key, $allowed_options) && ($value !== null)) { $this->{'_' . $key} = $value; } } $this->_fileName = ltrim($this->_fileName, '/'); //strip leading slash $this->_path = rtrim($this->_path, '/'); //strip trailing slash if($this->_append) { $this->_fileName = CURRENT_FILENAME; //avoid easy-verified user error; $this->_url = $this->_path.'/'.$this->_fileName.$this->_getLinksUrl(); } else { if(!strstr($this->_fileName,'%d')) { $msg = '<b>Pager_Sliding Error:</b>' .' "fileName" format not valid. Use "%d" as placeholder.'; return $this->raiseError($msg, -1); } $this->_url = $this->_path.'/'; } if(strlen($this->_linkClass)) { $this->_classString = 'class="'.$this->_linkClass.'"'; } else { $this->_classString = ''; } if(strlen($this->_curPageLinkClassName)) { $this->_curPageSpanPre = '<span class="'.$this->_curPageLinkClassName.'">'; $this->_curPageSpanPost = '</span>'; } else { $this->_curPageSpanPre = '<b><u>'; $this->_curPageSpanPost = '</u></b>'; } if($this->_perPage < 1) { //avoid easy-verified user error $this->_perPage = 1; } for($i=0; $i<$this->_spacesBeforeSeparator; $i++) { $this->_spacesBefore .= ' '; } for($i=0; $i<$this->_spacesAfterSeparator; $i++) { $this->_spacesAfter .= ' '; } $this->_currentPage = max((int)@$HTTP_GET_VARS[$this->_urlVar], 1); } // }}} } ?> Index: pear/PEAR/Pager_Sliding/package.xml +++ pear/PEAR/Pager_Sliding/package.xml <?xml version="1.0" encoding="ISO-8859-1" ?> <!DOCTYPE package SYSTEM "../package.dtd"> <package version="1.0"> <name>Pager_Sliding</name> <summary>Sliding Window Pager.</summary> <description> It takes an array of data as input and page it according to various parameters. It also builds links within a specified range, and allows complete customization of the output (it even works with mod_rewrite). It is compatible with PEAR::Pager's API </description> <license>PHP License</license> <maintainers> <maintainer> <user>quipo</user> <name>Lorenzo Alberton</name> <email>l.alberton@quipo.it</email> <role>lead</role> </maintainer> </maintainers> <release> <version>1.1.6</version> <date>2002-11-22</date> <state>stable</state> <notes> This is the first release. </notes> <filelist> <dir name="/" baseinstalldir="Pager"> <file role="php" name="Sliding.php" /> <file role="doc" name="examples/Sliding_example1.php"> <file role="doc" name="examples/Sliding_example2.php"> <file role="doc" name="examples/Sliding_example3.php"> <file role="doc" name="examples/Sliding_example4.php"> </dir> </filelist> </release> </package> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example1.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example1.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding example 1</title> <style type="text/css"> <!-- myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example3.php">Example3</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 1</h2> <pre> SETTINGS: $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); </pre> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre><?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> <pre> NB: <b>echo $pager->links</b> is the same as <b>$links = $pager->getLinks(); echo $links['all']; </b> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example2.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example2.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example3.php">Example3</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 2</h2> <?php $params = array( 'separator' => ',', 'spacesBeforeSeparator' => 0, 'spacesAfterSeparator' => 3, 'perPage' => 3, 'delta' => 3, 'urlVar' => 'ID', 'altPrev' => 'Pagina precedente', 'altNext' => 'Pagina successiva', 'altPage' => 'pagina n.', 'prevImg' => '<img src="prev.gif" border="0" />', 'nextImg' => '<img src="next.gif" border="0" />', 'linkClass' => 'myClass', 'firstPagePre' => '', 'firstPagePost' => '', 'lastPagePre' => '{', 'lastPagePost' => '}', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <pre> SETTINGS: $params = array( 'separator' => ',', 'spacesBeforeSeparator' => 0, 'spacesAfterSeparator' => 3, 'perPage' => 3, 'delta' => 3, 'urlVar' => 'ID', 'altPrev' => 'Pagina precedente', 'altNext' => 'Pagina successiva', 'altPage' => 'pagina n.', 'prevImg' => '<img src="prev.gif" />', 'nextImg' => '<img src="next.gif" />', 'linkClass' => 'myClass', 'firstPagePre' => '', 'firstPagePost' => '', 'lastPagePre' => '{', 'lastPagePost' => '}', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); </pre> <hr /> <b>Have a look at:</b><br /> - separator <i>(comma instead of pipe)</i>,<br /> - alt text <i>("pagina" instead of "page")</i>, <br /> - img used as prev/next links <i>(image instead of « »)</i>, <br /> - different urlVar used than default <i>("ID" instead of "pageID")</i>,<br /> - CSS <i>(red links)</i>,<br /> - number of page numbers showed <i>(delta=3 instead of 2)</i>,<br /> - last page embraced by curly braces <i>(instead of [9])</i>,<br /> - first page not embraced by anything <i>(instead of [1])</i><br /> <br /> <br /> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example3.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example3.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example4.php">Example4</a> - <a href="../">home</a> <hr /> <h2>Example 3</h2> <?php $month = 'september'; $params = array( 'append' => false, 'urlVar' => 'num', 'path' => 'http://myserver.com/articles/' . $month, 'fileName' => 'art%d.html', 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z'), 'perPage' => 3 ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <h3>This shows how this Pager can be used with mod_rewrite</h3> <h5 style="color: red; font-weight: 700;">NB: on this server mod_rewrite is not active, so links won't work, but have a look at the status bar to see how url is written.</h5> <br /> <pre> Let's suppose we have a .htaccess like this: ----------------------------------- RewriteEngine on #Options FollowSymlinks RewriteBase / RewriteRule ^articles/([a-z]{1,12})/art([0-9]{1,4})\.html$ /article.php?num=$2&month=$1 [L] ----------------------------------- It should transform an url like: /articles/march/art15.html into: /article.php?num=15&month=march </pre> <br /> <hr /> <pre> SETTINGS: $month = 'september'; $params = array( 'append' => false, 'urlVar' => 'num', 'path' => 'http://myserver.com/articles/' . $month, 'fileName' => 'art%d.html', //Pager replaces "%d" with page number... 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z'), 'perPage' => 3 ); $pager = &new Pager_Sliding($params); </pre> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html> Index: pear/PEAR/Pager_Sliding/examples/Sliding_example4.php +++ pear/PEAR/Pager_Sliding/examples/Sliding_example4.php <?php // +----------------------------------------------------------------------+ // | PEAR :: Pager_Sliding Example | // +----------------------------------------------------------------------+ // | Copyright (c) 1997-2002 The PHP Group | // +----------------------------------------------------------------------+ // | This source file is subject to version 2.0 of the PHP license, | // | that is bundled with this package in the file LICENSE, and is | // | available at through the world-wide-web at | // | http://www.php.net/license/2_02.txt. | // | If you did not receive a copy of the PHP license and are unable to | // | obtain it through the world-wide-web, please send a note to | // | license@php.net so we can mail you a copy immediately. | // +----------------------------------------------------------------------+ // | Author: Lorenzo Alberton <l.alberton at quipo.it> | // +----------------------------------------------------------------------+ require_once 'Pager/Sliding.php'; $params['totalItems'] = 800; $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <html> <head> <title>Pager_Sliding examples</title> <style type="text/css"> <!-- a.myClass { color: red; font-family: verdana; font-size: 10pt; } myClass2 { color: #222; font-family: verdana; font-size: 8pt; } // --> </style> </head> <body> <h1>Pager_Sliding</h1> <hr /> <span class="myClass2">Author: Lorenzo Alberton <l.alberton at quipo.it></span> <br /> go to <a href="SWPager_example1.php">Example1</a> - <a href="SWPager_example2.php">Example2</a> - <a href="SWPager_example3.php">Example3</a> - <a href="../">home</a> <hr /> <h2>Example 4</h2> <?php $params = array( 'perPage' => 3, 'delta' => 2, 'expanded' => true, 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); $data = $pager->getPageData(); $links = $pager->getLinks(); ?> <pre> SETTINGS: $params = array( 'perPage' => 3, 'delta' => 2, 'expanded' => true, 'itemData' => array('a','b','c','d','e','f','g','h','i','j','k','l','m','n','o','p','q','r','s','t','u','v','w','x','y','z') ); $pager = &new Pager_Sliding($params); </pre> <hr /> <b>Have a look at "expanded" mode:</b> Window width is always 2*$delta+1 <br /> <br /> <table border="1" width="500" summary="example 1"> <tr> <td colspan="3" align="center"> <?php echo $links['all']; ?> </td> </tr> <tr> <td colspan="3"> <pre>PAGED DATA: <?php print_r($data); ?></pre> </td> </tr> </table> <h4>Results from methods:</h4> <pre> getCurrentPageID()...: <?php var_dump($pager->getCurrentPageID()); ?> getNextPageID()......: <?php var_dump($pager->getNextPageID()); ?> getPreviousPageID()..: <?php var_dump($pager->getPreviousPageID()); ?> numItems()...........: <?php var_dump($pager->numItems()); ?> numPages()...........: <?php var_dump($pager->numPages()); ?> isFirstPage()........: <?php var_dump($pager->isFirstPage()); ?> isLastPage().........: <?php var_dump($pager->isLastPage()); ?> isLastPageComplete().: <?php var_dump($pager->isLastPageComplete()); ?> $pager->range........: <?php var_dump($pager->range); ?> </pre> <hr /> </body> </html>