PaginatorTest.php 29 KB

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