PaginatorTest.php 30 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950
  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 = sys_get_temp_dir() . '/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. if (!rmdir($path)) {
  156. throw new Exception('Unable to remove temporary directory ' . $path
  157. . '; perhaps it has a nested structure?');
  158. }
  159. }
  160. protected function _restorePaginatorDefaults()
  161. {
  162. $this->_paginator->setItemCountPerPage(10);
  163. $this->_paginator->setCurrentPageNumber(1);
  164. $this->_paginator->setPageRange(10);
  165. $this->_paginator->setView();
  166. Zend_Paginator::setDefaultScrollingStyle();
  167. Zend_View_Helper_PaginationControl::setDefaultViewPartial(null);
  168. Zend_Paginator::setConfig($this->_config->default);
  169. $loader = Zend_Paginator::getScrollingStyleLoader();
  170. $loader->clearPaths();
  171. $loader->addPrefixPath('Zend_Paginator_ScrollingStyle', 'Zend/Paginator/ScrollingStyle');
  172. $this->_cache->clean();
  173. $this->_paginator->setCacheEnabled(true);
  174. }
  175. public function testFactoryReturnsArrayAdapter()
  176. {
  177. $paginator = Zend_Paginator::factory($this->_testCollection);
  178. $this->assertType('Zend_Paginator_Adapter_Array', $paginator->getAdapter());
  179. }
  180. public function testFactoryReturnsDbSelectAdapter()
  181. {
  182. $paginator = Zend_Paginator::factory($this->_query);
  183. $this->assertType('Zend_Paginator_Adapter_DbSelect', $paginator->getAdapter());
  184. }
  185. // ZF-4607
  186. public function testFactoryReturnsDbTableSelectAdapter()
  187. {
  188. $table = new TestTable($this->_adapter);
  189. $paginator = Zend_Paginator::factory($table->select());
  190. $this->assertType('Zend_Paginator_Adapter_DbSelect', $paginator->getAdapter());
  191. }
  192. public function testFactoryReturnsIteratorAdapter()
  193. {
  194. $paginator = Zend_Paginator::factory(new ArrayIterator($this->_testCollection));
  195. $this->assertType('Zend_Paginator_Adapter_Iterator', $paginator->getAdapter());
  196. }
  197. public function testFactoryReturnsNullAdapter()
  198. {
  199. $paginator = Zend_Paginator::factory(101);
  200. $this->assertType('Zend_Paginator_Adapter_Null', $paginator->getAdapter());
  201. }
  202. public function testFactoryThrowsInvalidClassExceptionAdapter()
  203. {
  204. try {
  205. $paginator = Zend_Paginator::factory(new stdClass());
  206. } catch (Exception $e) {
  207. $this->assertType('Zend_Paginator_Exception', $e);
  208. $this->assertContains('stdClass', $e->getMessage());
  209. }
  210. }
  211. public function testFactoryThrowsInvalidTypeExceptionAdapter()
  212. {
  213. try {
  214. $paginator = Zend_Paginator::factory('invalid argument');
  215. } catch (Exception $e) {
  216. $this->assertType('Zend_Paginator_Exception', $e);
  217. $this->assertContains('string', $e->getMessage());
  218. }
  219. }
  220. public function testAddsSingleScrollingStylePrefixPath()
  221. {
  222. Zend_Paginator::addScrollingStylePrefixPath('prefix1', 'path1');
  223. $loader = Zend_Paginator::getScrollingStyleLoader();
  224. $paths = $loader->getPaths();
  225. $this->assertArrayHasKey('prefix1_', $paths);
  226. $this->assertEquals($paths['prefix1_'], array('path1/'));
  227. $loader->clearPaths('prefix1');
  228. }
  229. public function testAddsSingleScrollingStylePrefixPathWithArray()
  230. {
  231. Zend_Paginator::addScrollingStylePrefixPaths(array('prefix' => 'prefix2',
  232. 'path' => 'path2'));
  233. $loader = Zend_Paginator::getScrollingStyleLoader();
  234. $paths = $loader->getPaths();
  235. $this->assertArrayHasKey('prefix2_', $paths);
  236. $this->assertEquals($paths['prefix2_'], array('path2/'));
  237. $loader->clearPaths('prefix2');
  238. }
  239. public function testAddsMultipleScrollingStylePrefixPaths()
  240. {
  241. $paths = array('prefix3' => 'path3',
  242. 'prefix4' => 'path4',
  243. 'prefix5' => 'path5');
  244. Zend_Paginator::addScrollingStylePrefixPaths($paths);
  245. $loader = Zend_Paginator::getScrollingStyleLoader();
  246. $paths = $loader->getPaths();
  247. for ($i = 3; $i <= 5; $i++) {
  248. $prefix = 'prefix' . $i . '_';
  249. $this->assertArrayHasKey($prefix, $paths);
  250. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  251. }
  252. $loader->clearPaths('prefix3');
  253. $loader->clearPaths('prefix4');
  254. $loader->clearPaths('prefix5');
  255. }
  256. public function testAddsSingleAdapterPrefixPath()
  257. {
  258. Zend_Paginator::addAdapterPrefixPath('prefix1', 'path1');
  259. $loader = Zend_Paginator::getAdapterLoader();
  260. $paths = $loader->getPaths();
  261. $this->assertArrayHasKey('prefix1_', $paths);
  262. $this->assertEquals($paths['prefix1_'], array('path1/'));
  263. $loader->clearPaths('prefix1');
  264. }
  265. public function testAddsSingleAdapterPrefixPathWithArray()
  266. {
  267. Zend_Paginator::addAdapterPrefixPaths(array('prefix' => 'prefix2',
  268. 'path' => 'path2'));
  269. $loader = Zend_Paginator::getAdapterLoader();
  270. $paths = $loader->getPaths();
  271. $this->assertArrayHasKey('prefix2_', $paths);
  272. $this->assertEquals($paths['prefix2_'], array('path2/'));
  273. $loader->clearPaths('prefix2');
  274. }
  275. public function testAddsMultipleAdapterPrefixPaths()
  276. {
  277. $paths = array('prefix3' => 'path3',
  278. 'prefix4' => 'path4',
  279. 'prefix5' => 'path5');
  280. Zend_Paginator::addAdapterPrefixPaths($paths);
  281. $loader = Zend_Paginator::getAdapterLoader();
  282. $paths = $loader->getPaths();
  283. for ($i = 3; $i <= 5; $i++) {
  284. $prefix = 'prefix' . $i . '_';
  285. $this->assertArrayHasKey($prefix, $paths);
  286. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  287. }
  288. $loader->clearPaths('prefix3');
  289. $loader->clearPaths('prefix4');
  290. $loader->clearPaths('prefix5');
  291. }
  292. public function testGetsAndSetsDefaultScrollingStyle()
  293. {
  294. $this->assertEquals(Zend_Paginator::getDefaultScrollingStyle(), 'Sliding');
  295. Zend_Paginator::setDefaultScrollingStyle('Scrolling');
  296. $this->assertEquals(Zend_Paginator::getDefaultScrollingStyle(), 'Scrolling');
  297. Zend_Paginator::setDefaultScrollingStyle('Sliding');
  298. }
  299. public function testHasCorrectCountAfterInit()
  300. {
  301. $paginator = Zend_Paginator::factory(range(1, 101));
  302. $this->assertEquals(11, $paginator->count());
  303. }
  304. public function testHasCorrectCountOfAllItemsAfterInit()
  305. {
  306. $paginator = Zend_Paginator::factory(range(1, 101));
  307. $this->assertEquals(101, $paginator->getTotalItemCount());
  308. }
  309. public function testAddCustomAdapterPathsInConstructor()
  310. {
  311. $paginator = Zend_Paginator::factory(range(1, 101), Zend_Paginator::INTERNAL_ADAPTER, array('My_Paginator_Adapter' => 'My/Paginator/Adapter'));
  312. $loader = Zend_Paginator::getAdapterLoader();
  313. $paths = $loader->getPaths();
  314. $this->assertEquals(2, count($paths));
  315. $this->assertEquals(array('Zend_Paginator_Adapter_' => array('Zend/Paginator/Adapter/'),
  316. 'My_Paginator_Adapter_' => array('My/Paginator/Adapter/')), $paths);
  317. $loader->clearPaths('My_Paginator_Adapter');
  318. }
  319. public function testLoadsFromConfig()
  320. {
  321. Zend_Paginator::setConfig($this->_config->testing);
  322. $this->assertEquals('Scrolling', Zend_Paginator::getDefaultScrollingStyle());
  323. $paths = array(
  324. 'prefix6' => 'path6',
  325. 'prefix7' => 'path7',
  326. 'prefix8' => 'path8'
  327. );
  328. $loader = Zend_Paginator::getScrollingStyleLoader();
  329. $paths = $loader->getPaths();
  330. for ($i = 6; $i <= 8; $i++) {
  331. $prefix = 'prefix' . $i . '_';
  332. $this->assertArrayHasKey($prefix, $paths);
  333. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  334. }
  335. $loader->clearPaths('prefix6');
  336. $loader->clearPaths('prefix7');
  337. $loader->clearPaths('prefix8');
  338. $loader = Zend_Paginator::getAdapterLoader();
  339. $paths = $loader->getPaths();
  340. for ($i = 6; $i <= 8; $i++) {
  341. $prefix = 'prefix' . $i . '_';
  342. $this->assertArrayHasKey($prefix, $paths);
  343. $this->assertEquals($paths[$prefix], array('path' . $i . '/'));
  344. }
  345. $loader->clearPaths('prefix6');
  346. $loader->clearPaths('prefix7');
  347. $loader->clearPaths('prefix8');
  348. $paginator = Zend_Paginator::factory(range(1, 101));
  349. $this->assertEquals(3, $paginator->getItemCountPerPage());
  350. $this->assertEquals(7, $paginator->getPageRange());
  351. }
  352. public function testGetsPagesForPageOne()
  353. {
  354. $expected = new stdClass();
  355. $expected->pageCount = 11;
  356. $expected->itemCountPerPage = 10;
  357. $expected->first = 1;
  358. $expected->current = 1;
  359. $expected->last = 11;
  360. $expected->next = 2;
  361. $expected->pagesInRange = array_combine(range(1, 10), range(1, 10));
  362. $expected->firstPageInRange = 1;
  363. $expected->lastPageInRange = 10;
  364. $expected->currentItemCount = 10;
  365. $expected->totalItemCount = 101;
  366. $expected->firstItemNumber = 1;
  367. $expected->lastItemNumber = 10;
  368. $actual = $this->_paginator->getPages();
  369. $this->assertEquals($expected, $actual);
  370. }
  371. public function testGetsPagesForPageTwo()
  372. {
  373. $expected = new stdClass();
  374. $expected->pageCount = 11;
  375. $expected->itemCountPerPage = 10;
  376. $expected->first = 1;
  377. $expected->current = 2;
  378. $expected->last = 11;
  379. $expected->previous = 1;
  380. $expected->next = 3;
  381. $expected->pagesInRange = array_combine(range(1, 10), range(1, 10));
  382. $expected->firstPageInRange = 1;
  383. $expected->lastPageInRange = 10;
  384. $expected->currentItemCount = 10;
  385. $expected->totalItemCount = 101;
  386. $expected->firstItemNumber = 11;
  387. $expected->lastItemNumber = 20;
  388. $this->_paginator->setCurrentPageNumber(2);
  389. $actual = $this->_paginator->getPages();
  390. $this->assertEquals($expected, $actual);
  391. }
  392. public function testRendersWithoutPartial()
  393. {
  394. $this->_paginator->setView(new Zend_View());
  395. $string = @$this->_paginator->__toString();
  396. $this->assertEquals('', $string);
  397. }
  398. public function testRendersWithPartial()
  399. {
  400. $view = new Zend_View();
  401. $view->addBasePath(dirname(__FILE__) . '/Paginator/_files');
  402. $view->addHelperPath(dirname(__FILE__) . '/../../../trunk/library/Zend/View/Helper', 'Zend_View_Helper');
  403. Zend_View_Helper_PaginationControl::setDefaultViewPartial('partial.phtml');
  404. $this->_paginator->setView($view);
  405. $string = $this->_paginator->__toString();
  406. $this->assertEquals('partial rendered successfully', $string);
  407. }
  408. public function testGetsPageCount()
  409. {
  410. $this->assertEquals(11, $this->_paginator->count());
  411. }
  412. public function testGetsAndSetsItemCountPerPage()
  413. {
  414. Zend_Paginator::setConfig(new Zend_Config(array()));
  415. $this->_paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array(range(1, 101)));
  416. $this->assertEquals(10, $this->_paginator->getItemCountPerPage());
  417. $this->_paginator->setItemCountPerPage(15);
  418. $this->assertEquals(15, $this->_paginator->getItemCountPerPage());
  419. $this->_paginator->setItemCountPerPage(0);
  420. $this->assertEquals(10, $this->_paginator->getItemCountPerPage());
  421. $this->_paginator->setItemCountPerPage(10);
  422. }
  423. public function testGetsCurrentItemCount()
  424. {
  425. $this->_paginator->setItemCountPerPage(10);
  426. $this->_paginator->setPageRange(10);
  427. $this->assertEquals(10, $this->_paginator->getCurrentItemCount());
  428. $this->_paginator->setCurrentPageNumber(11);
  429. $this->assertEquals(1, $this->_paginator->getCurrentItemCount());
  430. $this->_paginator->setCurrentPageNumber(1);
  431. }
  432. public function testGetsCurrentItems()
  433. {
  434. $items = $this->_paginator->getCurrentItems();
  435. $this->assertType('ArrayIterator', $items);
  436. $count = 0;
  437. foreach ($items as $item) {
  438. $count++;
  439. }
  440. $this->assertEquals(10, $count);
  441. }
  442. public function testGetsIterator()
  443. {
  444. $items = $this->_paginator->getIterator();
  445. $this->assertType('ArrayIterator', $items);
  446. $count = 0;
  447. foreach ($items as $item) {
  448. $count++;
  449. }
  450. $this->assertEquals(10, $count);
  451. }
  452. public function testGetsAndSetsCurrentPageNumber()
  453. {
  454. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  455. $this->_paginator->setCurrentPageNumber(-1);
  456. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  457. $this->_paginator->setCurrentPageNumber(11);
  458. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  459. $this->_paginator->setCurrentPageNumber(111);
  460. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  461. $this->_paginator->setCurrentPageNumber(1);
  462. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  463. }
  464. public function testGetsAbsoluteItemNumber()
  465. {
  466. $this->assertEquals(1, $this->_paginator->getAbsoluteItemNumber(1));
  467. $this->assertEquals(11, $this->_paginator->getAbsoluteItemNumber(1, 2));
  468. $this->assertEquals(24, $this->_paginator->getAbsoluteItemNumber(4, 3));
  469. }
  470. public function testGetsItem()
  471. {
  472. $this->assertEquals(1, $this->_paginator->getItem(1));
  473. $this->assertEquals(11, $this->_paginator->getItem(1, 2));
  474. $this->assertEquals(24, $this->_paginator->getItem(4, 3));
  475. }
  476. public function testThrowsExceptionWhenCollectionIsEmpty()
  477. {
  478. $paginator = Zend_Paginator::factory(array());
  479. try {
  480. $paginator->getItem(1);
  481. } catch (Exception $e) {
  482. $this->assertType('Zend_Paginator_Exception', $e);
  483. $this->assertContains('Page 1 does not exist', $e->getMessage());
  484. }
  485. }
  486. public function testThrowsExceptionWhenRetrievingNonexistentItemFromLastPage()
  487. {
  488. try {
  489. $this->_paginator->getItem(10, 11);
  490. } catch (Exception $e) {
  491. $this->assertType('Zend_Paginator_Exception', $e);
  492. $this->assertContains('Page 11 does not contain item number 10', $e->getMessage());
  493. }
  494. }
  495. public function testNormalizesPageNumber()
  496. {
  497. $this->assertEquals(1, $this->_paginator->normalizePageNumber(0));
  498. $this->assertEquals(1, $this->_paginator->normalizePageNumber(1));
  499. $this->assertEquals(2, $this->_paginator->normalizePageNumber(2));
  500. $this->assertEquals(5, $this->_paginator->normalizePageNumber(5));
  501. $this->assertEquals(10, $this->_paginator->normalizePageNumber(10));
  502. $this->assertEquals(11, $this->_paginator->normalizePageNumber(11));
  503. $this->assertEquals(11, $this->_paginator->normalizePageNumber(12));
  504. }
  505. public function testNormalizesItemNumber()
  506. {
  507. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(0));
  508. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(1));
  509. $this->assertEquals(2, $this->_paginator->normalizeItemNumber(2));
  510. $this->assertEquals(5, $this->_paginator->normalizeItemNumber(5));
  511. $this->assertEquals(9, $this->_paginator->normalizeItemNumber(9));
  512. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(10));
  513. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(11));
  514. }
  515. public function testGetsPagesInSubsetRange()
  516. {
  517. $actual = $this->_paginator->getPagesInRange(3, 8);
  518. $this->assertEquals(array_combine(range(3, 8), range(3, 8)), $actual);
  519. }
  520. public function testGetsPagesInOutOfBoundsRange()
  521. {
  522. $actual = $this->_paginator->getPagesInRange(-1, 12);
  523. $this->assertEquals(array_combine(range(1, 11), range(1, 11)), $actual);
  524. }
  525. public function testGetsItemsByPage()
  526. {
  527. $expected = new ArrayIterator(range(1, 10));
  528. $page1 = $this->_paginator->getItemsByPage(1);
  529. $this->assertEquals($page1, $expected);
  530. $this->assertEquals($page1, $this->_paginator->getItemsByPage(1));
  531. }
  532. public function testGetsItemCount()
  533. {
  534. $this->assertEquals(101, $this->_paginator->getItemCount(range(1, 101)));
  535. $limitIterator = new LimitIterator(new ArrayIterator(range(1, 101)));
  536. $this->assertEquals(101, $this->_paginator->getItemCount($limitIterator));
  537. }
  538. public function testGetsViewFromViewRenderer()
  539. {
  540. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  541. $viewRenderer->setView(new Zend_View());
  542. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  543. }
  544. public function testGeneratesViewIfNonexistent()
  545. {
  546. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  547. }
  548. public function testGetsAndSetsView()
  549. {
  550. $this->_paginator->setView(new Zend_View());
  551. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  552. }
  553. public function testRenders()
  554. {
  555. try {
  556. $this->_paginator->render(new Zend_View());
  557. } catch (Exception $e) {
  558. $this->assertType('Zend_View_Exception', $e);
  559. $this->assertEquals('No view partial provided and no default set', $e->getMessage());
  560. }
  561. }
  562. public function testGetsAndSetsPageRange()
  563. {
  564. $this->assertEquals(10, $this->_paginator->getPageRange());
  565. $this->_paginator->setPageRange(15);
  566. $this->assertEquals(15, $this->_paginator->getPageRange());
  567. }
  568. /**
  569. * @group ZF-3720
  570. */
  571. public function testGivesCorrectItemCount()
  572. {
  573. $paginator = Zend_Paginator::factory(range(1, 101));
  574. $paginator->setCurrentPageNumber(5)
  575. ->setItemCountPerPage(5);
  576. $expected = new ArrayIterator(range(21, 25));
  577. $this->assertEquals($expected, $paginator->getCurrentItems());
  578. }
  579. /**
  580. * @group ZF-3737
  581. */
  582. public function testKeepsCurrentPageNumberAfterItemCountPerPageSet()
  583. {
  584. $paginator = Zend_Paginator::factory(array('item1', 'item2'));
  585. $paginator->setCurrentPageNumber(2)
  586. ->setItemCountPerPage(1);
  587. $items = $paginator->getCurrentItems();
  588. $this->assertEquals('item2', $items[0]);
  589. }
  590. /**
  591. * @group ZF-4193
  592. */
  593. public function testCastsIntegerValuesToInteger()
  594. {
  595. // Current page number
  596. $this->_paginator->setCurrentPageNumber(3.3);
  597. $this->assertTrue($this->_paginator->getCurrentPageNumber() == 3);
  598. // Item count per page
  599. $this->_paginator->setItemCountPerPage(3.3);
  600. $this->assertTrue($this->_paginator->getItemCountPerPage() == 3);
  601. // Page range
  602. $this->_paginator->setPageRange(3.3);
  603. $this->assertTrue($this->_paginator->getPageRange() == 3);
  604. }
  605. /**
  606. * @group ZF-4207
  607. */
  608. public function testAcceptsTraversableInstanceFromAdapter()
  609. {
  610. $paginator = new Zend_Paginator(new Zf4207());
  611. $this->assertType('ArrayObject', $paginator->getCurrentItems());
  612. }
  613. public function testCachedItem()
  614. {
  615. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  616. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  617. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  618. $pageItems = $this->_paginator->getPageItemCache();
  619. $expected = array(
  620. 1 => new ArrayIterator(range(1, 10)),
  621. 2 => new ArrayIterator(range(11, 20)),
  622. 3 => new ArrayIterator(range(21, 30))
  623. );
  624. $this->assertEquals($expected, $pageItems);
  625. }
  626. public function testClearPageItemCache()
  627. {
  628. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  629. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  630. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  631. // clear only page 2 items
  632. $this->_paginator->clearPageItemCache(2);
  633. $pageItems = $this->_paginator->getPageItemCache();
  634. $expected = array(
  635. 1 => new ArrayIterator(range(1, 10)),
  636. 3 => new ArrayIterator(range(21, 30))
  637. );
  638. $this->assertEquals($expected, $pageItems);
  639. // clear all
  640. $this->_paginator->clearPageItemCache();
  641. $pageItems = $this->_paginator->getPageItemCache();
  642. $this->assertEquals(array(), $pageItems);
  643. }
  644. public function testWithCacheDisabled()
  645. {
  646. $this->_paginator->setCacheEnabled(false);
  647. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  648. $cachedPageItems = $this->_paginator->getPageItemCache();
  649. $expected = new ArrayIterator(range(1, 10));
  650. $this->assertEquals(array(), $cachedPageItems);
  651. $pageItems = $this->_paginator->getCurrentItems();
  652. $this->assertEquals($expected, $pageItems);
  653. }
  654. public function testCacheDoesNotDisturbResultsWhenChangingParam()
  655. {
  656. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  657. $pageItems = $this->_paginator->setItemCountPerPage(5)->getCurrentItems();
  658. $expected = new ArrayIterator(range(1, 5));
  659. $this->assertEquals($expected, $pageItems);
  660. $pageItems = $this->_paginator->getItemsByPage(2);
  661. $expected = new ArrayIterator(range(6, 10));
  662. $this->assertEquals($expected, $pageItems);
  663. // change the inside Paginator scale
  664. $pageItems = $this->_paginator->setItemCountPerPage(8)->setCurrentPageNumber(3)->getCurrentItems();
  665. $pageItems = $this->_paginator->getPageItemCache();
  666. $expected = array(3 => new ArrayIterator(range(17, 24)));
  667. $this->assertEquals($expected, $pageItems);
  668. // get back to already cached data
  669. $this->_paginator->setItemCountPerPage(5);
  670. $pageItems = $this->_paginator->getPageItemCache();
  671. $expected =array(1 => new ArrayIterator(range(1, 5)),
  672. 2 => new ArrayIterator(range(6, 10)));
  673. $this->assertEquals($expected, $pageItems);
  674. }
  675. public function testToJson()
  676. {
  677. $this->_paginator->setCurrentPageNumber(1);
  678. $json = $this->_paginator->toJson();
  679. $expected = '"0":1,"1":2,"2":3,"3":4,"4":5,"5":6,"6":7,"7":8,"8":9,"9":10';
  680. $this->assertContains($expected, $json);
  681. }
  682. // ZF-5519
  683. public function testFilter()
  684. {
  685. $filter = new Zend_Filter_Callback(array($this, 'filterCallback'));
  686. $paginator = Zend_Paginator::factory(range(1, 10));
  687. $paginator->setFilter($filter);
  688. $page = $paginator->getCurrentItems();
  689. $this->assertEquals(new ArrayIterator(range(10, 100, 10)), $page);
  690. }
  691. public function filterCallback($value)
  692. {
  693. $data = array();
  694. foreach ($value as $number) {
  695. $data[] = ($number * 10);
  696. }
  697. return $data;
  698. }
  699. /**
  700. * @group ZF-5785
  701. */
  702. public function testGetSetDefaultItemCountPerPage()
  703. {
  704. Zend_Paginator::setConfig(new Zend_Config(array()));
  705. $paginator = Zend_Paginator::factory(range(1, 10));
  706. $this->assertEquals(10, $paginator->getItemCountPerPage());
  707. Zend_Paginator::setDefaultItemCountPerPage(20);
  708. $this->assertEquals(20, Zend_Paginator::getDefaultItemCountPerPage());
  709. $paginator = Zend_Paginator::factory(range(1, 10));
  710. $this->assertEquals(20, $paginator->getItemCountPerPage());
  711. $this->_restorePaginatorDefaults();
  712. }
  713. /**
  714. * @group ZF-7207
  715. */
  716. public function testItemCountPerPageByDefault()
  717. {
  718. $paginator = Zend_Paginator::factory(range(1,20));
  719. $this->assertEquals(2, $paginator->count());
  720. }
  721. /**
  722. * @group ZF-5427
  723. */
  724. public function testNegativeItemNumbers()
  725. {
  726. $this->assertEquals(10, $this->_paginator->getItem(-1, 1));
  727. $this->assertEquals(9, $this->_paginator->getItem(-2, 1));
  728. $this->assertEquals(101, $this->_paginator->getItem(-1, -1));
  729. }
  730. /**
  731. * @group ZF-7602
  732. */
  733. public function testAcceptAndHandlePaginatorAdapterAggregateDataInFactory()
  734. {
  735. $p = Zend_Paginator::factory(new Zend_Paginator_TestArrayAggregate());
  736. $this->assertEquals(1, count($p));
  737. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  738. $this->assertEquals(4, count($p->getAdapter()));
  739. }
  740. /**
  741. * @group ZF-7602
  742. */
  743. public function testAcceptAndHandlePaginatorAdapterAggreageInConstructor()
  744. {
  745. $p = new Zend_Paginator(new Zend_Paginator_TestArrayAggregate());
  746. $this->assertEquals(1, count($p));
  747. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  748. $this->assertEquals(4, count($p->getAdapter()));
  749. }
  750. /**
  751. * @group ZF-7602
  752. */
  753. public function testInvalidDataInConstructor_ThrowsException()
  754. {
  755. $this->setExpectedException("Zend_Paginator_Exception");
  756. $p = new Zend_Paginator(array());
  757. }
  758. }
  759. class Zend_Paginator_TestArrayAggregate implements Zend_Paginator_AdapterAggregate
  760. {
  761. public function getPaginatorAdapter()
  762. {
  763. return new Zend_Paginator_Adapter_Array(array(1, 2, 3, 4));
  764. }
  765. }
  766. // Call Zend_PaginatorTest::main() if this source file is executed directly.
  767. if (PHPUnit_MAIN_METHOD === 'Zend_PaginatorTest::main') {
  768. Zend_PaginatorTest::main();
  769. }