Pager

Data paging class

This package is unmaintained.

Download latest release 2.5.1 (there might be newer Composer installable version)

License: BSD

Description

It takes an array of data as input and pages it according to various parameters.
It also builds links within a specified range, and allows complete customization of the output (it even works with front controllers and mod_rewrite).
Two operating modes available: "Jumping" and "Sliding" window style.

Documentation

Manual

Maintainers

Lorenzo Alberton (quipo) — lead, active
Richard Heyes (richard) — lead, inactive

Dependencies

Required

PHP (>= 5.6.0)
PEAR Installer (>= 1.4.0b1)

Releases

2.5.1 (stable, 2017-06-19)
Release notes

License: BSD

PHP 7 compatibility
2.5.0 (stable, 2017-06-19)
Release notes

License: BSD

PHP 7 compatibility
2.4.9 (stable, 2014-05-14)
Release notes

License: BSD

Get rid of baseinstalldir.
No code changes.
2.4.8 (stable, 2009-04-21)
Release notes

License: BSD

- request #15949: add autoSubmit option to getPerPageSelectBox() [Matt Rosenquist]
- fix potential issues with encoding in getPerPageSelectBox() and getPageSelectBox()
2.4.7 (stable, 2008-08-11)
Release notes

License: BSD

- fixed bug #13604: WARNINGS with PHP 5.3-dev [thanks to Chris Troup]
- request #13567: support for regexp in 'excludeVars' [thanks to Stefano Coletta]
- fixed bug #13913 empty prev/next image shown when only one page exists [cweiske]
- fixed bug #13881: fix for relative links (introduced in v.2.4.5) may cause some
issues with absolute links
2.4.6 (stable, 2008-03-27)
Release notes

License: BSD

- fixed bug #13316: NOTICE in getLinks() in Jumping mode
- fixed bug #13342: getLinks() returns wrong result with multi-byte arrays
- fixed bug #13469: getPerPageSelectBox() can produce invalid xhtml with no data
- fixed bug #13472: PHP 6 Removes get_magic_quotes_gpc()
- fixed bug #13506: POST method deletes querystring
- request #13509: added 'prevImgEmpty' and 'nextImgEmpty' options to show a disabled
prev/next page link when you are on the last/first page (cweiske)
2.4.5 (stable, 2008-02-23)
Release notes

License: BSD

- request #10869: added two reverse drivers in the /examples/ dir
- fixed a few PHP5 Strict Standards warnings (bug #12257 and #12934)
- Coding Standards fixes in the phpdoc blocks
- added 'PAGER_' prefix to internal constant names
- fixed bug #12267: correct detection of HTTPS on IIS (thanks to Carsten Wiedmann)
- fixed bug #12306: allow relative links
- fixed bug #12531: removed <u> tag from curPageSpan[Pre|Post] default options
in Pager_Sliding to make links HTML 4.01 strict
- request #12267: added $pager->linkTagsRaw array (same as $pager->linkTags but
as array) to play nice with HTML_Page2 (patch by Carsten Wiedmann)
- fixed bug #12796: curPageLinkClassName overrides curPageSpanPre and curPageSpanPost
- request #12797: added '%d' as a placeholder to altPage (by default, page number is appended)
- fixed bug #12837: if $_SESSION['setPerPage'] is set, Pager always uses it
2.4.4 (stable, 2007-07-29)
Release notes

License: BSD

- handle UNION queries in the Wrapper (bug #9601)
- getPerPagerSelectBox() with $showAllData = true and $start > $totalItems was
returning an empty select menu (bug #9946)
- added 'onclick' option (request #11241)
- fixed bug #11697: Pager_Jumping::build() lose first and last page string concatenation
2.4.3 (stable, 2006-12-03)
Release notes

License: BSD

- fixed issue with SSL (bug #7936)
- items set in 'excludeVars' array were removed from the URL even if they were
also set in the 'extraVars' array (bug #8969)
- added new option 'checkMaxLimit' to getPerPageSelectBox(): if true, Pager checks
if $end is bigger than $totalItems, and doesn't show the extra select options
- moved Pager.php to the pear root and added a wrapper in the old location
to adhere to PEAR policies (bug #2169)
- switched to package.xml v2
2.4.2 (stable, 2006-06-07)
Release notes

License: BSD

- fix double escaping of arg_separator when php.ini's arg_separator.output = "&"
2.4.1 (stable, 2006-05-06)
Release notes

License: BSD

- more flexible implementation of the factory pattern allowing people to use custom
renderer classes that are not part of the Pager package (thanks to Martin Jansen)
2.4.0 (stable, 2006-04-23)
Release notes

License: BSD

- added host to CURRENT_PATHNAME constant
- added accesskey option (if true, accesskey attributes are added to the links)
- fixed multibyte string issues with httpMethod==POST (bug #6812)
- return empty array instead of FALSE in getPageData() on bad pageID (request #6986)
- added Pager_HtmlWidgets class containing the methods getPerPageSelectBox()
(moved from Pager_Common) and getPageSelectBox() (new, request #6998).
The class is lazy-loaded when calling one of the two above methods from Pager.
- Improved rewriteCountQuery() function in the Pager Wrapper.
- added getOption($name) and getOptions() methods (request #7413)
- changed _setOptions() [private] to setOptions() [public]
- added build() to refresh the links and the paged data after a new call to setOptions()
- added 'attributes' option to set extra attributes for the <a> tag (request #7452)
2.3.6 (stable, 2006-02-03)
Release notes

License: BSD

- fixed bug #6680: error with fileName parameter having an extra "%" character
2.3.5 (stable, 2006-01-20)
Release notes

License: BSD

- remove flicker (caused by href="#") during POST requests (request #6005)
- added "formID" option to reuse an existing form in POST requests
(thanks to Marc Veldman)
- fixed bug #6529: problem with fields with quotes during POST requests
2.3.4 (stable, 2005-09-28)
Release notes

License: BSD

- changed license to BSD
- fixed bug #4897 (multibyte chars not handled correctly)
2.3.3 (stable, 2005-07-04)
Release notes

License: PHP

- improved Pager_Wrapper and added tests
- urlencoded square brackets (bug #4337)
NB: We recommend that users of Pager < 2.3.0 immediately upgrade the package,
otherwise they might be susceptible to XSS attacks
2.3.2 (stable, 2005-06-03)
Release notes

License: PHP

- autodetect HTTP method used, when not specified,
instead of forcing "GET" (bug #4277)
- added "altFirst" and "altLast" options to set the
"title" attribute of the first and last page links
2.3.1 (stable, 2005-05-02)
Release notes

License: PHP

- fixed various issues with __http_build_query() and escaped entities
- if the value of "arg_separator.output" in php.ini is "&", don't encode it again
- tweaked Pager_Wrapper query rewriting function, now it is fully case insensitive
2.3.0 (stable, 2005-04-22)
Release notes

License: PHP

- tweaked Pager_Wrapper query rewriting function
2.3.0RC2 (beta, 2005-04-06)
Release notes

License: PHP

- fixed possible querystring duplication with front controllers
2.3.0RC1 (beta, 2005-04-01)
Release notes

License: PHP

- internal refactoring: added POST support: set the preferred http method
('GET' or 'POST') with the 'httpMethod' option.
- used $_GET instead of reparsing the querystring
[thanks to Nikolas 'Atrus' Coukouma]
(fixed bugs #3450, #3878 and #3451)
- added 'importQuery' boolean option to ignore the url vars entirely (bug #3449)
- added 'excludeVars' array option to selectively exclude some url vars (bug #2461)
- countless code optimizations
- added many new test cases to the testsuite
2.2.7 (stable, 2005-03-18)
Release notes

License: PHP

- added Pager_Wrapper_Eclipse() function in the /examples/Pager_Wrapper example
(thanks to Matte Edens)
- added support for statements with subqueries in the Pager Wrappers
(thanks to Tobias Kuckuck)
- fixed bug #3451 (arrays in extraVars not handled correctly)
2.2.6 (stable, 2005-02-04)
Release notes

License: PHP

- better 'currentPage' option support (thanks to Andrew Nagy)
- fixed typo (thanks to Massimiliano Arione)
2.2.5 (stable, 2005-01-17)
Release notes

License: PHP

- allowed use of a javascript function in the fileName [bugs #2555 and #2754]
- added Pager_Wrapper_DBDO() function in the /examples/Pager_Wrapper example
(thanks to garak AT studenti DOT it)
- replaced urlencode() with htmlentities() because it was too aggressive
[bugs #2908, #3043 and #3212]
- added 'currentPage' option (patch by Kendrick Vargas)
2.2.4 (stable, 2004-11-20)
Release notes

License: PHP

- fixed "Notice: Undefined property: _totalPages" [bug #2714]
- enforce errors (which weren't displayed at all)
- fixed Pager_Wrapper (examples dir) with GROUP BY queries
- changed $_GET to $_REQUEST. POST values should be valid too, now.
- Pager can be used on a DirectoryIndex script, now (patch by ieure) [bug #2617]
2.2.3 (stable, 2004-08-17)
Release notes

License: PHP

- just the last one of a set of array values given as GET parameters
(i.e. site.php?foo[]=1&foo[]=2&foo[]=3) was carried on (bug #1904).
- make 4th parameter of getPerPageSelectBox() an array, and add an
"attribute" parameter to allow extra attributes for the select tag.
- added an example to show how this class can be used with big database
resultsets efficiently.
- prevent XSS attacks (bug #2131), thanks to sou_sk at nifty dot com
2.2.2 (stable, 2004-05-18)
Release notes

License: PHP

- set correct selected value for getPerPageSelectBox even when "useSession"
option is false (bug #1263).
- added two parameters to getPerPageSelectBox():
* $showAllData (if true, an <option> to show
all the data is displayed in the generated <select>);
* $optionText (text to show in each <option>; use '%d' where you want to see
the number of pages selected)
- added showAllText option for alternate text in the $showAllData <option>
(the default is the number of total items).
- fixed getPageData() when $pageID is specified (bug #1377) (thanks to Ian Eure)
- added tests for getPageData()
- avoid duplicate vars in querystring when using 'extraVars' option (bug #1383)
(thanks to pauluz at gazeta dot pl)
2.2.1 (stable, 2004-04-15)
Release notes

License: PHP

- PHP5 compatibility (fixed bug #812)
- Forced ucfirst() on filename too
2.2.0 (stable, 2004-01-23)
Release notes

License: PHP

- Fixed handling of errors raised in common base class
- Added an 'extraVars' option to add vars to the querystring
- Added <link> tags building (patch by Joerg Bruckmann)
- Fixed Bug #589 (common.php raise a notice if the querystring has no '=' character)
- Use '&' instead of '&' in urls for better XHTML conformance
2.1.0 (stable, 2003-12-22)
Release notes

License: PHP

- Added getPageRangeByPageId()
- Fix getOffsetByPageId() in Pager_Jumping when totalItems == 0.
- Fix getOffsetByPageId() in Pager_Sliding for BC with Pager 1.x and Pager_Jumping.
N.B.: its previous (not-indended) behaviour is now provided by the new getPageRangeByPageId() method.
- Fix isFirstPage() when totalItems == 0
- Added test suite.
2.0 (stable, 2003-09-10)
Release notes

License: PHP

- New major version.
- Pager and Pager_Sliding are now merged in the same package.
Every option available in Pager_Sliding is now also available
in Pager. The API is the same as the old one, BC is kept 100%.
- Switch between "Jumping" and "Sliding" window mode just setting
an option.
- Improved error handling.
1.0.8 (stable, 2003-09-10)
Release notes

License: PHP

- Minor patch for script_name vs php_self (not included in v.1.0.7)
- Prevent URL modification
1.0.7 (stable, 2002-12-02)
Release notes

License: PHP

Minor patch for script_name vs php_self
1.0.6 (stable, 2002-09-08)
Release notes

License: PHP

Updated to no longer require an array of data. Now
can be used with just a number of items. Thanks to
Christian Dickmann for the patch.
1.0.5 (stable, 2002-07-27)
Release notes

License: PHP

Changed getCurrentPage() to getCurrentPageID() and
added getNextPageID() and getPreviousPageID()
1.0.4 (stable, 2002-06-29)
Release notes

License: PHP

Changed getCurrentPage() to getCurrentPageID() and
added getNextPageID() and getPreviousPageID()
1.0.3 (stable, 2002-06-01)
Release notes

License: PHP

Couple of minor bugs
1.0.2 (stable, 2002-06-01)
Release notes

License: PHP

Applied patch from Christian Dickmann adding getCurrentPage(), numItems()
and optional CSS class for links.
1.0.1 (stable, 2002-05-27)
Release notes

License: PHP

o No longer barfs with no querystring
o Now works with associative data array

Bugs

ID	Status	Type	Version	Date	Summary
#441	Closed	Bug		2003-12-16	Pager does not escape '&' in links
#589	Closed	Bug		2004-01-15	common.php raise a notice if the querystring has no '=' character
#652	Closed	Bug		2004-01-31	Test depends on non existant ../simpletest/
#812	Closed	Bug		2004-02-20	PHP5: assign to $this ==> Fatal Error
#1263	Closed	Bug		2004-04-22	default for getPerPageSelectBox only from session
#1377	Closed	Bug		2004-05-10	getPageData() returns no data when $pageID is specified.
#1383	Closed	Bug		2004-05-11	Duplicate vars in QUERY_STRING (_getLinksUrl() function)
#1589	Closed	Bug		2004-06-09	output doesn't seem to be XHTML compliant
#1898	Closed	Bug		2004-07-16	Documentation problem-- minor.
#1904	Closed	Bug		2004-07-17	Pager drops GET values although append = true
#2103	Closed	Bug		2004-08-10	can not set "curPageSpanPre" and "curPageSpanPost"
#2131	Closed	Req		2004-08-16	PEAR::Pager allows XSS attack
#2169	Closed	Bug		2004-08-20	Pager.php installed into the wrong place
#2171	Closed	Bug		2004-08-20	Constructor Errors break BC for extended classes
#2174	Closed	Bug		2004-08-20	E_NOTICE messages
#2461	Closed	Req		2004-10-05	would be nice to be able to exclude given vars from url
#2555	Closed	Req		2004-10-18	post form are not allowed
#2617	Closed	Bug		2004-10-25	[PATCH] 'append' Links are broken when used on index pages
#2754	Closed	Req		2004-11-15	It's not possible to use javascript as the urlVar
#2908	Closed	Bug		2004-12-06	Invalid GET returning array values
#2989	Bogus	Bug		2004-12-19	Wrong parsing of arrays in QUERY_STRING
#3043	Closed	Bug		2004-12-28	Pager + mod_rewrite, recursive urlencode() breaks rewrite handler
#3212	Closed	Bug		2005-01-15	rawurlencode call breaks some links in _getLinksUrl
#3254	Closed	Bug		2005-01-20	problem when URL variable contains a space
#3350	Closed	Bug		2005-02-01	path or _url error with getLinks or _setOptions
#3449	Closed	Req		2005-02-12	Exclude query vars entirely
#3450	Closed	Req		2005-02-12	Use $_GET instead of reparsing
#3451	Closed	Req		2005-02-12	Use http_build_query
#3639	Bogus	Bug		2005-02-28	perPage not working, returns extra rows
#3878	Closed	Req		2005-03-18	POST method support
#4277	Closed	Req		2005-05-04	$_POST['pageID'] works only with httpMethod => 'POST'
#4337	Closed	Bug		2005-05-12	New version breaks encoding.
#4422	Bogus	Req		2005-05-24	I'd like to be able to override the get/post/querystring values
#4496	Closed	Req		2005-05-31	New Feature to add first and last pages with diffs
#4654	Closed	Bug		2005-06-21	FILENAME overriding User Supplied filename variable (append)
#4735	Bogus	Bug		2005-07-04	input variable not cleaned enough
#4866	No Feedback	Bug		2005-07-19	unwanted htmlentities() in Common.php
#4895	Closed	Req		2005-07-22	Replace b and u tags with span?
#4897	Closed	Bug		2005-07-23	incorrect links when include Multibyte String
#4934	Bogus	Req		2005-07-28	Bad page number
#4946	Bogus	Req		2005-07-29	Allow for different url separator
#5159	Bogus	Req		2005-08-20	May I use mod_rewrite?
#5605	Closed	Req		2005-10-04	Add DBDO::getLinks() to Pager_Wrapper_DBDO()
#6005	Closed	Req		2005-11-17	During POST request, use href="javascript:void(0);" instead of href="#"
#6529	Closed	Bug		2006-01-19	form with filed containing value single-quote
#6680	Closed	Bug	2.3.5	2006-02-03	fileName parameter crashes with %
#6697	Closed	Bug		2006-02-05	Use REQUEST_URI instead of PHP_SELF for href generation
#6812	Closed	Bug	2.3.6	2006-02-17	htmlentities in _generateFormOnClickHelper($data, $prev = '') mangles utf8 valu
#6986	Closed	Req	2.3.6	2006-03-01	On bad pageID to getPageData, return empty array instead of FALSE.
#6987	Closed	Req	2.3.6	2006-03-01	No way to modify destination URL when using method 'POST'
#6998	Closed	Req	2.3.6	2006-03-02	Direct page select
#7072	Bogus	Bug	2.3.6	2006-03-09	Invalid XHTML markup
#7073	Bogus	Bug	2.3.6	2006-03-09	Some title tags are not changed
#7127	Closed	Bug	2.3.6	2006-03-15	problem with rewriteCountQuery function
#7243	Bogus	Bug	CVS	2006-03-29	spacesAfterSeparator and spacesBeforeSeparator are not Working
#7283	Closed	Req	2.3.6	2006-04-03	proposals to getPerPageSelectBox
#7323	Bogus	Req	2.3.6	2006-04-06	Cannot localize text for "last page" and "first page"
#7388	Closed	Bug	2.3.6	2006-04-13	unvalid XHTML code "onClick"
#7413	Closed	Req	2.3.6	2006-04-17	Query options
#7452	Closed	Req	CVS	2006-04-21	Missing extra attributes option
#7453	Wont fix	Req	CVS	2006-04-21	Pager's output is not very readable
#7657	Closed	Bug	2.4.1	2006-05-18	not compatible with autoload
#7782	Bogus	Req	2.4.1	2006-06-01	Why should I see all the pages in the first time?
#7936	Closed	Bug	2.4.2	2006-06-19	pager seems not to work with SSL
#8088	Duplicate	Bug	2.4.2	2006-06-30	Pager don't respect ssl mode
#8969	Closed	Req	2.4.2	2006-10-11	excludeVars with extraVars at the same time
#9136	Bogus	Bug	2.4.2	2006-10-22	When append is false, query string is removed
#9601	Closed	Bug	2.4.3	2006-12-12	rewriteCountQuery (Page_Wrapper.php) does not handle query with 'UNION' keyword
#9782	Spam	Req	2.4.3	2007-01-09	None
#9946	Closed	Bug	2.4.3	2007-01-25	Update to Pager (bug fix in file HTMLWidgets.php)
#10085	Closed	Bug	2.4.3	2007-02-13	using GET vars for paging and UTF8 on page pager urls get messed up
#10244	Bogus	Bug	2.4.3	2007-03-02	function Pager_Wrapper_MDB2 don't work
#10869	Closed	Req	2.4.3	2007-04-28	Reverse page count
#11241	Closed	Req	2.4.3	2007-06-06	add onclick support (patch included)
#11294	Closed	Bug		2007-06-12	Fatal error: Call to undefined method Pager_Sliding::build()
#11697	Closed	Req	2.4.3	2007-07-28	Pager_Jumping::build() lose first and last page string concatenation
#12257	Closed	Bug	2.4.4	2007-10-16	Strict Standards error messages from pager.
#12267	Closed	Req	2.4.4	2007-10-17	some changes/correction
#12306	Closed	Bug	2.4.4	2007-10-22	Can't make relative links with only a filename.
#12531	Closed	Req	2.4.4	2007-11-26	Pager links are not HTML 4.01 strict
#12796	Closed	Bug	2.4.4	2007-12-30	curPageLinkClassName override curPageSpanPre and curPageSpanPost
#12797	Closed	Req	2.4.4	2007-12-30	Two feature request altPage and Jumping mode
#12837	Closed	Bug	2.4.4	2008-01-06	If $_SESSION['setPerPage'] be set, Pager always uses it
#12934	Closed	Bug	2.4.4	2008-01-20	Have a problem from Strict standards
#13316	Closed	Bug	2.4.5	2008-03-05	Notice message appearing
#13342	Closed	Bug	2.4.5	2008-03-08	getLinks() return the wrong result.
#13380	Bogus	Req	2.4.5	2008-03-12	deactivated next/prev links
#13410	Closed	Bug	2.4.5	2008-03-17	'linkTagsRaw' without '$' mark typo miss
#13440	Closed	Bug	2.4.5	2008-03-19	setPerPage in URL overrides perPage option
#13469	Closed	Bug	2.4.5	2008-03-23	getPerPageSelectBox can produce invalid xhtml
#13472	Closed	Bug	2.4.5	2008-03-23	PHP 6 Removes get_magic_quotes_gpc
#13506	Closed	Bug	2.4.5	2008-03-26	POST method deletes querystring
#13507	Duplicate	Bug	2.4.5	2008-03-26	POST method deletes querystring
#13509	Closed	Req	2.4.5	2008-03-26	prev/next images when no prev/next link is needed
#13517	Duplicate	Bug	2.4.5	2008-03-27	Warning is disabled if warning output is enabled
#13530	No Feedback	Bug	2.4.6	2008-03-29	Multibyte post data broken when you click the Pager link with onclick
#13543	Closed	Doc	2.4.6	2008-03-30	Missing documentation for title attributes in link tags
#13567	Closed	Req	2.4.6	2008-04-02	Support for regexp in $_excludeVars
#13604	Closed	Bug	2.4.6	2008-04-05	Warnings
#13881	Closed	Bug		2008-05-12	render(DATAGRID_RENDER_PAGER) HTML incorrect with setUrlFormat()
#13913	Closed	Bug	2.4.6	2008-05-16	empty prev/next image shown when only one page exists
#14974	Wont fix	Bug	2.4.7	2008-11-07	Doesn't Conform to php strict standards
#15860	Bogus	Bug	2.4.7	2009-02-02	Possible regression of Bug #7657
#15901	Wont fix	Req		2009-02-16	New pager option
#15949	Closed	Req		2009-02-26	Add auto_submit option to getPerPageSelectBox
#16474	Bogus	Bug	2.4.8	2009-07-26	Pager Class creation error
#17309	Open	Bug	2.4.8	2010-04-13	Improper url-encoding for POST forms
#17811	No Feedback	Bug	2.4.8	2010-08-24	pagination urls have trailing /
#17812	Duplicate	Bug	2.4.8	2010-08-24	pagination urls have trailing /
#18208	Closed	Doc	SVN	2011-01-21	invalid info in "Pager and big db resultsets" section
#18299	Closed	Bug	2.4.8	2011-02-23	After upgrading to PHP 5.3.5
#18983	Assigned	Req	2.4.8	2011-11-11	Enhanced link formatting with <li> tags
#19603	Wont fix	Req	2.4.8	2012-09-12	use dirname(__FILE__) for include path
#19739	Closed	Bug	2.4.8	2012-12-10	Pager-savebc.php installed in wrong directory
#19801	No Feedback	Bug	2.4.8	2013-01-27	Undefined HTTP_HOST
#20537	Closed	Bug		2015-04-28	Error with php 5.4.40
#20569	Open	Bug	2.4.9	2015-07-10	extraVars not used when append=false
#21032	Closed	Bug	Unknown	2016-02-21	Pager & PHP 7