PaginatorTest.php 31 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979
  1. <?php
  2. /**
  3. * Zend Framework
  4. *
  5. * LICENSE
  6. *
  7. * This source file is subject to the new BSD license that is bundled
  8. * with this package in the file LICENSE.txt.
  9. * It is also available through the world-wide-web at this URL:
  10. * http://framework.zend.com/license/new-bsd
  11. * If you did not receive a copy of the license and are unable to
  12. * obtain it through the world-wide-web, please send an email
  13. * to license@zend.com so we can send you a copy immediately.
  14. *
  15. * @category Zend
  16. * @package Zend_Paginator
  17. * @subpackage UnitTests
  18. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  19. * @license http://framework.zend.com/license/new-bsd New BSD License
  20. * @version $Id$
  21. */
  22. // Call Zend_PaginatorTest::main() if this source file is executed directly.
  23. if (!defined('PHPUnit_MAIN_METHOD')) {
  24. define('PHPUnit_MAIN_METHOD', 'Zend_PaginatorTest::main');
  25. }
  26. /**
  27. * Test helper
  28. */
  29. require_once dirname(__FILE__) . '/../TestHelper.php';
  30. /**
  31. * @see Zend_Paginator
  32. */
  33. require_once 'Zend/Paginator.php';
  34. /**
  35. * @see Zend_Paginator_AdapterAggregate
  36. */
  37. require_once 'Zend/Paginator/AdapterAggregate.php';
  38. /**
  39. * @see PHPUnit_Framework_TestCase
  40. */
  41. require_once 'PHPUnit/Framework/TestCase.php';
  42. /**
  43. * @see Zend_Config_Xml
  44. */
  45. require_once 'Zend/Config/Xml.php';
  46. /**
  47. * @see Zend_Db_Adapter_Pdo_Sqlite
  48. */
  49. require_once 'Zend/Db/Adapter/Pdo/Sqlite.php';
  50. /**
  51. * @see Zend_View
  52. */
  53. require_once 'Zend/View.php';
  54. /**
  55. * @see Zend_Controller_Action_HelperBroker
  56. */
  57. require_once 'Zend/Controller/Action/HelperBroker.php';
  58. /**
  59. * @see Zend_View_Helper_PaginationControl
  60. */
  61. require_once 'Zend/View/Helper/PaginationControl.php';
  62. /**
  63. * @see Zf4207
  64. */
  65. require_once 'Zend/Paginator/_files/Zf4207.php';
  66. /**
  67. * @see TestTable
  68. */
  69. require_once 'Zend/Paginator/_files/TestTable.php';
  70. /**
  71. * @see Zend_Cache
  72. */
  73. require_once 'Zend/Cache.php';
  74. /**
  75. * @see Zend_Filter_Callback
  76. */
  77. require_once 'Zend/Filter/Callback.php';
  78. /**
  79. * @category Zend
  80. * @package Zend_Paginator
  81. * @subpackage UnitTests
  82. * @copyright Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  83. * @license http://framework.zend.com/license/new-bsd New BSD License
  84. * @group Zend_Paginator
  85. */
  86. class Zend_PaginatorTest extends PHPUnit_Framework_TestCase
  87. {
  88. /**
  89. * Runs the test methods of this class.
  90. *
  91. * @return void
  92. */
  93. public static function main()
  94. {
  95. $suite = new PHPUnit_Framework_TestSuite(__CLASS__);
  96. $result = PHPUnit_TextUI_TestRunner::run($suite);
  97. }
  98. /**
  99. * Paginator instance
  100. *
  101. * @var Zend_Paginator
  102. */
  103. protected $_paginator = null;
  104. protected $_testCollection = null;
  105. protected $_cache;
  106. protected $_query = null;
  107. protected $_config = null;
  108. protected $_adapter = null;
  109. protected function setUp()
  110. {
  111. if (!extension_loaded('pdo_sqlite')) {
  112. $this->markTestSkipped('Pdo_Sqlite extension is not loaded');
  113. }
  114. $this->_adapter = new Zend_Db_Adapter_Pdo_Sqlite(array(
  115. 'dbname' => dirname(__FILE__) . '/Paginator/_files/test.sqlite'
  116. ));
  117. $this->_query = $this->_adapter->select()->from('test');
  118. $this->_testCollection = range(1, 101);
  119. $this->_paginator = Zend_Paginator::factory($this->_testCollection);
  120. $this->_config = new Zend_Config_Xml(dirname(__FILE__) . '/Paginator/_files/config.xml');
  121. // get a fresh new copy of ViewRenderer in each tests
  122. Zend_Controller_Action_HelperBroker::resetHelpers();
  123. $fO = array('lifetime' => 3600, 'automatic_serialization' => true);
  124. $bO = array('cache_dir'=> $this->_getTmpDir());
  125. $this->_cache = Zend_Cache::factory('Core', 'File', $fO, $bO);
  126. Zend_Paginator::setCache($this->_cache);
  127. $this->_restorePaginatorDefaults();
  128. }
  129. protected function tearDown()
  130. {
  131. $this->_dbConn = null;
  132. $this->_testCollection = null;
  133. $this->_paginator = null;
  134. }
  135. protected function _getTmpDir()
  136. {
  137. $tmpDir = rtrim(sys_get_temp_dir(), '/\\') . DIRECTORY_SEPARATOR . 'zend_paginator';
  138. if (file_exists($tmpDir)) {
  139. $this->_rmDirRecursive($tmpDir);
  140. }
  141. mkdir($tmpDir);
  142. $this->cacheDir = $tmpDir;
  143. return $tmpDir;
  144. }
  145. protected function _rmDirRecursive($path)
  146. {
  147. $dir = new DirectoryIterator($path);
  148. foreach ($dir as $file) {
  149. if (!$file->isDir()) {
  150. unlink($file->getPathname());
  151. } elseif (!in_array($file->getFilename(), array('.', '..'))) {
  152. $this->_rmDirRecursive($file->getPathname());
  153. }
  154. }
  155. unset($file, $dir); // required on windows to remove file handle
  156. if (!rmdir($path)) {
  157. throw new Exception('Unable to remove temporary directory ' . $path
  158. . '; perhaps it has a nested structure?');
  159. }
  160. }
  161. protected function _restorePaginatorDefaults()
  162. {
  163. $this->_paginator->setItemCountPerPage(10);
  164. $this->_paginator->setCurrentPageNumber(1);
  165. $this->_paginator->setPageRange(10);
  166. $this->_paginator->setView();
  167. Zend_Paginator::setDefaultScrollingStyle();
  168. Zend_View_Helper_PaginationControl::setDefaultViewPartial(null);
  169. Zend_Paginator::setConfig($this->_config->default);
  170. $loader = Zend_Paginator::getScrollingStyleLoader();
  171. $loader->clearPaths();
  172. $loader->addPrefixPath('Zend_Paginator_ScrollingStyle', 'Zend/Paginator/ScrollingStyle');
  173. $this->_cache->clean();
  174. $this->_paginator->setCacheEnabled(true);
  175. }
  176. public function testFactoryReturnsArrayAdapter()
  177. {
  178. $paginator = Zend_Paginator::factory($this->_testCollection);
  179. $this->assertType('Zend_Paginator_Adapter_Array', $paginator->getAdapter());
  180. }
  181. public function testFactoryReturnsDbSelectAdapter()
  182. {
  183. $paginator = Zend_Paginator::factory($this->_query);
  184. $this->assertType('Zend_Paginator_Adapter_DbSelect', $paginator->getAdapter());
  185. }
  186. // ZF-4607
  187. public function testFactoryReturnsDbTableSelectAdapter()
  188. {
  189. $table = new TestTable($this->_adapter);
  190. $paginator = Zend_Paginator::factory($table->select());
  191. $this->assertType('Zend_Paginator_Adapter_DbSelect', $paginator->getAdapter());
  192. }
  193. public function testFactoryReturnsIteratorAdapter()
  194. {
  195. $paginator = Zend_Paginator::factory(new ArrayIterator($this->_testCollection));
  196. $this->assertType('Zend_Paginator_Adapter_Iterator', $paginator->getAdapter());
  197. }
  198. public function testFactoryReturnsNullAdapter()
  199. {
  200. $paginator = Zend_Paginator::factory(101);
  201. $this->assertType('Zend_Paginator_Adapter_Null', $paginator->getAdapter());
  202. }
  203. public function testFactoryThrowsInvalidClassExceptionAdapter()
  204. {
  205. try {
  206. $paginator = Zend_Paginator::factory(new stdClass());
  207. } catch (Exception $e) {
  208. $this->assertType('Zend_Paginator_Exception', $e);
  209. $this->assertContains('stdClass', $e->getMessage());
  210. }
  211. }
  212. public function testFactoryThrowsInvalidTypeExceptionAdapter()
  213. {
  214. try {
  215. $paginator = Zend_Paginator::factory('invalid argument');
  216. } catch (Exception $e) {
  217. $this->assertType('Zend_Paginator_Exception', $e);
  218. $this->assertContains('string', $e->getMessage());
  219. }
  220. }
  221. public function testAddsSingleScrollingStylePrefixPath()
  222. {
  223. Zend_Paginator::addScrollingStylePrefixPath('prefix1', 'path1');
  224. $loader = Zend_Paginator::getScrollingStyleLoader();
  225. $paths = $loader->getPaths();
  226. $this->assertArrayHasKey('prefix1_', $paths);
  227. $this->assertEquals($paths['prefix1_'], array('path1/'));
  228. $loader->clearPaths('prefix1');
  229. }
  230. public function testAddsSingleScrollingStylePrefixPathWithArray()
  231. {
  232. Zend_Paginator::addScrollingStylePrefixPaths(array('prefix' => 'prefix2',
  233. 'path' => 'path2'));
  234. $loader = Zend_Paginator::getScrollingStyleLoader();
  235. $paths = $loader->getPaths();
  236. $this->assertArrayHasKey('prefix2_', $paths);
  237. $this->assertEquals($paths['prefix2_'], array('path2/'));
  238. $loader->clearPaths('prefix2');
  239. }
  240. public function testAddsMultipleScrollingStylePrefixPaths()
  241. {
  242. $paths = array('prefix3' => 'path3',
  243. 'prefix4' => 'path4',
  244. 'prefix5' => 'path5');
  245. Zend_Paginator::addScrollingStylePrefixPaths($paths);
  246. $loader = Zend_Paginator::getScrollingStyleLoader();
  247. $paths = $loader->getPaths();
  248. for ($i = 3; $i <= 5; $i++) {
  249. $prefix = 'prefix' . $i . '_';
  250. $this->assertArrayHasKey($prefix, $paths);
  251. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  252. }
  253. $loader->clearPaths('prefix3');
  254. $loader->clearPaths('prefix4');
  255. $loader->clearPaths('prefix5');
  256. }
  257. public function testAddsSingleAdapterPrefixPath()
  258. {
  259. Zend_Paginator::addAdapterPrefixPath('prefix1', 'path1');
  260. $loader = Zend_Paginator::getAdapterLoader();
  261. $paths = $loader->getPaths();
  262. $this->assertArrayHasKey('prefix1_', $paths);
  263. $this->assertEquals($paths['prefix1_'], array('path1/'));
  264. $loader->clearPaths('prefix1');
  265. }
  266. public function testAddsSingleAdapterPrefixPathWithArray()
  267. {
  268. Zend_Paginator::addAdapterPrefixPaths(array('prefix' => 'prefix2',
  269. 'path' => 'path2'));
  270. $loader = Zend_Paginator::getAdapterLoader();
  271. $paths = $loader->getPaths();
  272. $this->assertArrayHasKey('prefix2_', $paths);
  273. $this->assertEquals($paths['prefix2_'], array('path2/'));
  274. $loader->clearPaths('prefix2');
  275. }
  276. public function testAddsMultipleAdapterPrefixPaths()
  277. {
  278. $paths = array('prefix3' => 'path3',
  279. 'prefix4' => 'path4',
  280. 'prefix5' => 'path5');
  281. Zend_Paginator::addAdapterPrefixPaths($paths);
  282. $loader = Zend_Paginator::getAdapterLoader();
  283. $paths = $loader->getPaths();
  284. for ($i = 3; $i <= 5; $i++) {
  285. $prefix = 'prefix' . $i . '_';
  286. $this->assertArrayHasKey($prefix, $paths);
  287. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  288. }
  289. $loader->clearPaths('prefix3');
  290. $loader->clearPaths('prefix4');
  291. $loader->clearPaths('prefix5');
  292. }
  293. public function testGetsAndSetsDefaultScrollingStyle()
  294. {
  295. $this->assertEquals(Zend_Paginator::getDefaultScrollingStyle(), 'Sliding');
  296. Zend_Paginator::setDefaultScrollingStyle('Scrolling');
  297. $this->assertEquals(Zend_Paginator::getDefaultScrollingStyle(), 'Scrolling');
  298. Zend_Paginator::setDefaultScrollingStyle('Sliding');
  299. }
  300. public function testHasCorrectCountAfterInit()
  301. {
  302. $paginator = Zend_Paginator::factory(range(1, 101));
  303. $this->assertEquals(11, $paginator->count());
  304. }
  305. public function testHasCorrectCountOfAllItemsAfterInit()
  306. {
  307. $paginator = Zend_Paginator::factory(range(1, 101));
  308. $this->assertEquals(101, $paginator->getTotalItemCount());
  309. }
  310. public function testAddCustomAdapterPathsInConstructor()
  311. {
  312. $paginator = Zend_Paginator::factory(range(1, 101), Zend_Paginator::INTERNAL_ADAPTER, array('My_Paginator_Adapter' => 'My/Paginator/Adapter'));
  313. $loader = Zend_Paginator::getAdapterLoader();
  314. $paths = $loader->getPaths();
  315. $this->assertEquals(2, count($paths));
  316. $this->assertEquals(array('Zend_Paginator_Adapter_' => array('Zend/Paginator/Adapter/'),
  317. 'My_Paginator_Adapter_' => array('My/Paginator/Adapter/')), $paths);
  318. $loader->clearPaths('My_Paginator_Adapter');
  319. }
  320. public function testLoadsFromConfig()
  321. {
  322. Zend_Paginator::setConfig($this->_config->testing);
  323. $this->assertEquals('Scrolling', Zend_Paginator::getDefaultScrollingStyle());
  324. $paths = array(
  325. 'prefix6' => 'path6',
  326. 'prefix7' => 'path7',
  327. 'prefix8' => 'path8'
  328. );
  329. $loader = Zend_Paginator::getScrollingStyleLoader();
  330. $paths = $loader->getPaths();
  331. for ($i = 6; $i <= 8; $i++) {
  332. $prefix = 'prefix' . $i . '_';
  333. $this->assertArrayHasKey($prefix, $paths);
  334. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  335. }
  336. $loader->clearPaths('prefix6');
  337. $loader->clearPaths('prefix7');
  338. $loader->clearPaths('prefix8');
  339. $loader = Zend_Paginator::getAdapterLoader();
  340. $paths = $loader->getPaths();
  341. for ($i = 6; $i <= 8; $i++) {
  342. $prefix = 'prefix' . $i . '_';
  343. $this->assertArrayHasKey($prefix, $paths);
  344. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  345. }
  346. $loader->clearPaths('prefix6');
  347. $loader->clearPaths('prefix7');
  348. $loader->clearPaths('prefix8');
  349. $paginator = Zend_Paginator::factory(range(1, 101));
  350. $this->assertEquals(3, $paginator->getItemCountPerPage());
  351. $this->assertEquals(7, $paginator->getPageRange());
  352. }
  353. public function testGetsPagesForPageOne()
  354. {
  355. $expected = new stdClass();
  356. $expected->pageCount = 11;
  357. $expected->itemCountPerPage = 10;
  358. $expected->first = 1;
  359. $expected->current = 1;
  360. $expected->last = 11;
  361. $expected->next = 2;
  362. $expected->pagesInRange = array_combine(range(1, 10), range(1, 10));
  363. $expected->firstPageInRange = 1;
  364. $expected->lastPageInRange = 10;
  365. $expected->currentItemCount = 10;
  366. $expected->totalItemCount = 101;
  367. $expected->firstItemNumber = 1;
  368. $expected->lastItemNumber = 10;
  369. $actual = $this->_paginator->getPages();
  370. $this->assertEquals($expected, $actual);
  371. }
  372. public function testGetsPagesForPageTwo()
  373. {
  374. $expected = new stdClass();
  375. $expected->pageCount = 11;
  376. $expected->itemCountPerPage = 10;
  377. $expected->first = 1;
  378. $expected->current = 2;
  379. $expected->last = 11;
  380. $expected->previous = 1;
  381. $expected->next = 3;
  382. $expected->pagesInRange = array_combine(range(1, 10), range(1, 10));
  383. $expected->firstPageInRange = 1;
  384. $expected->lastPageInRange = 10;
  385. $expected->currentItemCount = 10;
  386. $expected->totalItemCount = 101;
  387. $expected->firstItemNumber = 11;
  388. $expected->lastItemNumber = 20;
  389. $this->_paginator->setCurrentPageNumber(2);
  390. $actual = $this->_paginator->getPages();
  391. $this->assertEquals($expected, $actual);
  392. }
  393. public function testRendersWithoutPartial()
  394. {
  395. $this->_paginator->setView(new Zend_View());
  396. $string = @$this->_paginator->__toString();
  397. $this->assertEquals('', $string);
  398. }
  399. public function testRendersWithPartial()
  400. {
  401. $view = new Zend_View();
  402. $view->addBasePath(dirname(__FILE__) . '/Paginator/_files');
  403. $view->addHelperPath(dirname(__FILE__) . '/../../../trunk/library/Zend/View/Helper', 'Zend_View_Helper');
  404. Zend_View_Helper_PaginationControl::setDefaultViewPartial('partial.phtml');
  405. $this->_paginator->setView($view);
  406. $string = $this->_paginator->__toString();
  407. $this->assertEquals('partial rendered successfully', $string);
  408. }
  409. public function testGetsPageCount()
  410. {
  411. $this->assertEquals(11, $this->_paginator->count());
  412. }
  413. public function testGetsAndSetsItemCountPerPage()
  414. {
  415. Zend_Paginator::setConfig(new Zend_Config(array()));
  416. $this->_paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array(range(1, 101)));
  417. $this->assertEquals(10, $this->_paginator->getItemCountPerPage());
  418. $this->_paginator->setItemCountPerPage(15);
  419. $this->assertEquals(15, $this->_paginator->getItemCountPerPage());
  420. $this->_paginator->setItemCountPerPage(0);
  421. $this->assertEquals(10, $this->_paginator->getItemCountPerPage());
  422. $this->_paginator->setItemCountPerPage(10);
  423. }
  424. public function testGetsCurrentItemCount()
  425. {
  426. $this->_paginator->setItemCountPerPage(10);
  427. $this->_paginator->setPageRange(10);
  428. $this->assertEquals(10, $this->_paginator->getCurrentItemCount());
  429. $this->_paginator->setCurrentPageNumber(11);
  430. $this->assertEquals(1, $this->_paginator->getCurrentItemCount());
  431. $this->_paginator->setCurrentPageNumber(1);
  432. }
  433. public function testGetsCurrentItems()
  434. {
  435. $items = $this->_paginator->getCurrentItems();
  436. $this->assertType('ArrayIterator', $items);
  437. $count = 0;
  438. foreach ($items as $item) {
  439. $count++;
  440. }
  441. $this->assertEquals(10, $count);
  442. }
  443. public function testGetsIterator()
  444. {
  445. $items = $this->_paginator->getIterator();
  446. $this->assertType('ArrayIterator', $items);
  447. $count = 0;
  448. foreach ($items as $item) {
  449. $count++;
  450. }
  451. $this->assertEquals(10, $count);
  452. }
  453. public function testGetsAndSetsCurrentPageNumber()
  454. {
  455. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  456. $this->_paginator->setCurrentPageNumber(-1);
  457. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  458. $this->_paginator->setCurrentPageNumber(11);
  459. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  460. $this->_paginator->setCurrentPageNumber(111);
  461. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  462. $this->_paginator->setCurrentPageNumber(1);
  463. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  464. }
  465. public function testGetsAbsoluteItemNumber()
  466. {
  467. $this->assertEquals(1, $this->_paginator->getAbsoluteItemNumber(1));
  468. $this->assertEquals(11, $this->_paginator->getAbsoluteItemNumber(1, 2));
  469. $this->assertEquals(24, $this->_paginator->getAbsoluteItemNumber(4, 3));
  470. }
  471. public function testGetsItem()
  472. {
  473. $this->assertEquals(1, $this->_paginator->getItem(1));
  474. $this->assertEquals(11, $this->_paginator->getItem(1, 2));
  475. $this->assertEquals(24, $this->_paginator->getItem(4, 3));
  476. }
  477. public function testThrowsExceptionWhenCollectionIsEmpty()
  478. {
  479. $paginator = Zend_Paginator::factory(array());
  480. try {
  481. $paginator->getItem(1);
  482. } catch (Exception $e) {
  483. $this->assertType('Zend_Paginator_Exception', $e);
  484. $this->assertContains('Page 1 does not exist', $e->getMessage());
  485. }
  486. }
  487. public function testThrowsExceptionWhenRetrievingNonexistentItemFromLastPage()
  488. {
  489. try {
  490. $this->_paginator->getItem(10, 11);
  491. } catch (Exception $e) {
  492. $this->assertType('Zend_Paginator_Exception', $e);
  493. $this->assertContains('Page 11 does not contain item number 10', $e->getMessage());
  494. }
  495. }
  496. public function testNormalizesPageNumber()
  497. {
  498. $this->assertEquals(1, $this->_paginator->normalizePageNumber(0));
  499. $this->assertEquals(1, $this->_paginator->normalizePageNumber(1));
  500. $this->assertEquals(2, $this->_paginator->normalizePageNumber(2));
  501. $this->assertEquals(5, $this->_paginator->normalizePageNumber(5));
  502. $this->assertEquals(10, $this->_paginator->normalizePageNumber(10));
  503. $this->assertEquals(11, $this->_paginator->normalizePageNumber(11));
  504. $this->assertEquals(11, $this->_paginator->normalizePageNumber(12));
  505. }
  506. public function testNormalizesItemNumber()
  507. {
  508. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(0));
  509. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(1));
  510. $this->assertEquals(2, $this->_paginator->normalizeItemNumber(2));
  511. $this->assertEquals(5, $this->_paginator->normalizeItemNumber(5));
  512. $this->assertEquals(9, $this->_paginator->normalizeItemNumber(9));
  513. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(10));
  514. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(11));
  515. }
  516. /**
  517. * @group ZF-8656
  518. */
  519. public function testNormalizesPageNumberWhenGivenAFloat()
  520. {
  521. $this->assertEquals(1, $this->_paginator->normalizePageNumber(0.5));
  522. $this->assertEquals(1, $this->_paginator->normalizePageNumber(1.99));
  523. $this->assertEquals(2, $this->_paginator->normalizePageNumber(2.3));
  524. $this->assertEquals(5, $this->_paginator->normalizePageNumber(5.1));
  525. $this->assertEquals(10, $this->_paginator->normalizePageNumber(10.06));
  526. $this->assertEquals(11, $this->_paginator->normalizePageNumber(11.5));
  527. $this->assertEquals(11, $this->_paginator->normalizePageNumber(12.7889));
  528. }
  529. /**
  530. * @group ZF-8656
  531. */
  532. public function testNormalizesItemNumberWhenGivenAFloat()
  533. {
  534. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(0.5));
  535. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(1.99));
  536. $this->assertEquals(2, $this->_paginator->normalizeItemNumber(2.3));
  537. $this->assertEquals(5, $this->_paginator->normalizeItemNumber(5.1));
  538. $this->assertEquals(9, $this->_paginator->normalizeItemNumber(9.06));
  539. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(10.5));
  540. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(11.7889));
  541. }
  542. public function testGetsPagesInSubsetRange()
  543. {
  544. $actual = $this->_paginator->getPagesInRange(3, 8);
  545. $this->assertEquals(array_combine(range(3, 8), range(3, 8)), $actual);
  546. }
  547. public function testGetsPagesInOutOfBoundsRange()
  548. {
  549. $actual = $this->_paginator->getPagesInRange(-1, 12);
  550. $this->assertEquals(array_combine(range(1, 11), range(1, 11)), $actual);
  551. }
  552. public function testGetsItemsByPage()
  553. {
  554. $expected = new ArrayIterator(range(1, 10));
  555. $page1 = $this->_paginator->getItemsByPage(1);
  556. $this->assertEquals($page1, $expected);
  557. $this->assertEquals($page1, $this->_paginator->getItemsByPage(1));
  558. }
  559. public function testGetsItemCount()
  560. {
  561. $this->assertEquals(101, $this->_paginator->getItemCount(range(1, 101)));
  562. $limitIterator = new LimitIterator(new ArrayIterator(range(1, 101)));
  563. $this->assertEquals(101, $this->_paginator->getItemCount($limitIterator));
  564. }
  565. public function testGetsViewFromViewRenderer()
  566. {
  567. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  568. $viewRenderer->setView(new Zend_View());
  569. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  570. }
  571. public function testGeneratesViewIfNonexistent()
  572. {
  573. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  574. }
  575. public function testGetsAndSetsView()
  576. {
  577. $this->_paginator->setView(new Zend_View());
  578. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  579. }
  580. public function testRenders()
  581. {
  582. try {
  583. $this->_paginator->render(new Zend_View());
  584. } catch (Exception $e) {
  585. $this->assertType('Zend_View_Exception', $e);
  586. $this->assertEquals('No view partial provided and no default set', $e->getMessage());
  587. }
  588. }
  589. public function testGetsAndSetsPageRange()
  590. {
  591. $this->assertEquals(10, $this->_paginator->getPageRange());
  592. $this->_paginator->setPageRange(15);
  593. $this->assertEquals(15, $this->_paginator->getPageRange());
  594. }
  595. /**
  596. * @group ZF-3720
  597. */
  598. public function testGivesCorrectItemCount()
  599. {
  600. $paginator = Zend_Paginator::factory(range(1, 101));
  601. $paginator->setCurrentPageNumber(5)
  602. ->setItemCountPerPage(5);
  603. $expected = new ArrayIterator(range(21, 25));
  604. $this->assertEquals($expected, $paginator->getCurrentItems());
  605. }
  606. /**
  607. * @group ZF-3737
  608. */
  609. public function testKeepsCurrentPageNumberAfterItemCountPerPageSet()
  610. {
  611. $paginator = Zend_Paginator::factory(array('item1', 'item2'));
  612. $paginator->setCurrentPageNumber(2)
  613. ->setItemCountPerPage(1);
  614. $items = $paginator->getCurrentItems();
  615. $this->assertEquals('item2', $items[0]);
  616. }
  617. /**
  618. * @group ZF-4193
  619. */
  620. public function testCastsIntegerValuesToInteger()
  621. {
  622. // Current page number
  623. $this->_paginator->setCurrentPageNumber(3.3);
  624. $this->assertTrue($this->_paginator->getCurrentPageNumber() == 3);
  625. // Item count per page
  626. $this->_paginator->setItemCountPerPage(3.3);
  627. $this->assertTrue($this->_paginator->getItemCountPerPage() == 3);
  628. // Page range
  629. $this->_paginator->setPageRange(3.3);
  630. $this->assertTrue($this->_paginator->getPageRange() == 3);
  631. }
  632. /**
  633. * @group ZF-4207
  634. */
  635. public function testAcceptsTraversableInstanceFromAdapter()
  636. {
  637. $paginator = new Zend_Paginator(new Zf4207());
  638. $this->assertType('ArrayObject', $paginator->getCurrentItems());
  639. }
  640. public function testCachedItem()
  641. {
  642. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  643. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  644. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  645. $pageItems = $this->_paginator->getPageItemCache();
  646. $expected = array(
  647. 1 => new ArrayIterator(range(1, 10)),
  648. 2 => new ArrayIterator(range(11, 20)),
  649. 3 => new ArrayIterator(range(21, 30))
  650. );
  651. $this->assertEquals($expected, $pageItems);
  652. }
  653. public function testClearPageItemCache()
  654. {
  655. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  656. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  657. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  658. // clear only page 2 items
  659. $this->_paginator->clearPageItemCache(2);
  660. $pageItems = $this->_paginator->getPageItemCache();
  661. $expected = array(
  662. 1 => new ArrayIterator(range(1, 10)),
  663. 3 => new ArrayIterator(range(21, 30))
  664. );
  665. $this->assertEquals($expected, $pageItems);
  666. // clear all
  667. $this->_paginator->clearPageItemCache();
  668. $pageItems = $this->_paginator->getPageItemCache();
  669. $this->assertEquals(array(), $pageItems);
  670. }
  671. public function testWithCacheDisabled()
  672. {
  673. $this->_paginator->setCacheEnabled(false);
  674. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  675. $cachedPageItems = $this->_paginator->getPageItemCache();
  676. $expected = new ArrayIterator(range(1, 10));
  677. $this->assertEquals(array(), $cachedPageItems);
  678. $pageItems = $this->_paginator->getCurrentItems();
  679. $this->assertEquals($expected, $pageItems);
  680. }
  681. public function testCacheDoesNotDisturbResultsWhenChangingParam()
  682. {
  683. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  684. $pageItems = $this->_paginator->setItemCountPerPage(5)->getCurrentItems();
  685. $expected = new ArrayIterator(range(1, 5));
  686. $this->assertEquals($expected, $pageItems);
  687. $pageItems = $this->_paginator->getItemsByPage(2);
  688. $expected = new ArrayIterator(range(6, 10));
  689. $this->assertEquals($expected, $pageItems);
  690. // change the inside Paginator scale
  691. $pageItems = $this->_paginator->setItemCountPerPage(8)->setCurrentPageNumber(3)->getCurrentItems();
  692. $pageItems = $this->_paginator->getPageItemCache();
  693. $expected = array(3 => new ArrayIterator(range(17, 24)));
  694. $this->assertEquals($expected, $pageItems);
  695. // get back to already cached data
  696. $this->_paginator->setItemCountPerPage(5);
  697. $pageItems = $this->_paginator->getPageItemCache();
  698. $expected =array(1 => new ArrayIterator(range(1, 5)),
  699. 2 => new ArrayIterator(range(6, 10)));
  700. $this->assertEquals($expected, $pageItems);
  701. }
  702. public function testToJson()
  703. {
  704. $this->_paginator->setCurrentPageNumber(1);
  705. $json = $this->_paginator->toJson();
  706. $expected = '"0":1,"1":2,"2":3,"3":4,"4":5,"5":6,"6":7,"7":8,"8":9,"9":10';
  707. $this->assertContains($expected, $json);
  708. }
  709. // ZF-5519
  710. public function testFilter()
  711. {
  712. $filter = new Zend_Filter_Callback(array($this, 'filterCallback'));
  713. $paginator = Zend_Paginator::factory(range(1, 10));
  714. $paginator->setFilter($filter);
  715. $page = $paginator->getCurrentItems();
  716. $this->assertEquals(new ArrayIterator(range(10, 100, 10)), $page);
  717. }
  718. public function filterCallback($value)
  719. {
  720. $data = array();
  721. foreach ($value as $number) {
  722. $data[] = ($number * 10);
  723. }
  724. return $data;
  725. }
  726. /**
  727. * @group ZF-5785
  728. */
  729. public function testGetSetDefaultItemCountPerPage()
  730. {
  731. Zend_Paginator::setConfig(new Zend_Config(array()));
  732. $paginator = Zend_Paginator::factory(range(1, 10));
  733. $this->assertEquals(10, $paginator->getItemCountPerPage());
  734. Zend_Paginator::setDefaultItemCountPerPage(20);
  735. $this->assertEquals(20, Zend_Paginator::getDefaultItemCountPerPage());
  736. $paginator = Zend_Paginator::factory(range(1, 10));
  737. $this->assertEquals(20, $paginator->getItemCountPerPage());
  738. $this->_restorePaginatorDefaults();
  739. }
  740. /**
  741. * @group ZF-7207
  742. */
  743. public function testItemCountPerPageByDefault()
  744. {
  745. $paginator = Zend_Paginator::factory(range(1,20));
  746. $this->assertEquals(2, $paginator->count());
  747. }
  748. /**
  749. * @group ZF-5427
  750. */
  751. public function testNegativeItemNumbers()
  752. {
  753. $this->assertEquals(10, $this->_paginator->getItem(-1, 1));
  754. $this->assertEquals(9, $this->_paginator->getItem(-2, 1));
  755. $this->assertEquals(101, $this->_paginator->getItem(-1, -1));
  756. }
  757. /**
  758. * @group ZF-7602
  759. */
  760. public function testAcceptAndHandlePaginatorAdapterAggregateDataInFactory()
  761. {
  762. $p = Zend_Paginator::factory(new Zend_Paginator_TestArrayAggregate());
  763. $this->assertEquals(1, count($p));
  764. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  765. $this->assertEquals(4, count($p->getAdapter()));
  766. }
  767. /**
  768. * @group ZF-7602
  769. */
  770. public function testAcceptAndHandlePaginatorAdapterAggreageInConstructor()
  771. {
  772. $p = new Zend_Paginator(new Zend_Paginator_TestArrayAggregate());
  773. $this->assertEquals(1, count($p));
  774. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  775. $this->assertEquals(4, count($p->getAdapter()));
  776. }
  777. /**
  778. * @group ZF-7602
  779. */
  780. public function testInvalidDataInConstructor_ThrowsException()
  781. {
  782. $this->setExpectedException("Zend_Paginator_Exception");
  783. $p = new Zend_Paginator(array());
  784. }
  785. }
  786. class Zend_Paginator_TestArrayAggregate implements Zend_Paginator_AdapterAggregate
  787. {
  788. public function getPaginatorAdapter()
  789. {
  790. return new Zend_Paginator_Adapter_Array(array(1, 2, 3, 4));
  791. }
  792. }
  793. // Call Zend_PaginatorTest::main() if this source file is executed directly.
  794. if (PHPUnit_MAIN_METHOD === 'Zend_PaginatorTest::main') {
  795. Zend_PaginatorTest::main();
  796. }