PaginatorTest.php 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047
  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-2012 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. * @see Zend_Paginator
  28. */
  29. require_once 'Zend/Paginator.php';
  30. /**
  31. * @see Zend_Paginator_AdapterAggregate
  32. */
  33. require_once 'Zend/Paginator/AdapterAggregate.php';
  34. /**
  35. * @see PHPUnit_Framework_TestCase
  36. */
  37. /**
  38. * @see Zend_Config_Xml
  39. */
  40. require_once 'Zend/Config/Xml.php';
  41. /**
  42. * @see Zend_Db_Adapter_Pdo_Sqlite
  43. */
  44. require_once 'Zend/Db/Adapter/Pdo/Sqlite.php';
  45. /**
  46. * @see Zend_View
  47. */
  48. require_once 'Zend/View.php';
  49. /**
  50. * @see Zend_Controller_Action_HelperBroker
  51. */
  52. require_once 'Zend/Controller/Action/HelperBroker.php';
  53. /**
  54. * @see Zend_View_Helper_PaginationControl
  55. */
  56. require_once 'Zend/View/Helper/PaginationControl.php';
  57. /**
  58. * @see Zf4207
  59. */
  60. require_once 'Zend/Paginator/_files/Zf4207.php';
  61. /**
  62. * @see TestTable
  63. */
  64. require_once 'Zend/Paginator/_files/TestTable.php';
  65. /**
  66. * @see Zend_Cache
  67. */
  68. require_once 'Zend/Cache.php';
  69. /**
  70. * @see Zend_Filter_Callback
  71. */
  72. require_once 'Zend/Filter/Callback.php';
  73. /**
  74. * @category Zend
  75. * @package Zend_Paginator
  76. * @subpackage UnitTests
  77. * @copyright Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
  78. * @license http://framework.zend.com/license/new-bsd New BSD License
  79. * @group Zend_Paginator
  80. */
  81. class Zend_PaginatorTest extends PHPUnit_Framework_TestCase
  82. {
  83. /**
  84. * Runs the test methods of this class.
  85. *
  86. * @return void
  87. */
  88. public static function main()
  89. {
  90. $suite = new PHPUnit_Framework_TestSuite(__CLASS__);
  91. $result = PHPUnit_TextUI_TestRunner::run($suite);
  92. }
  93. /**
  94. * Paginator instance
  95. *
  96. * @var Zend_Paginator
  97. */
  98. protected $_paginator = null;
  99. protected $_testCollection = null;
  100. protected $_cache;
  101. protected $_query = null;
  102. protected $_config = null;
  103. protected $_adapter = null;
  104. protected function setUp()
  105. {
  106. if (!extension_loaded('pdo_sqlite')) {
  107. $this->markTestSkipped('Pdo_Sqlite extension is not loaded');
  108. }
  109. $this->_adapter = new Zend_Db_Adapter_Pdo_Sqlite(array(
  110. 'dbname' => dirname(__FILE__) . '/Paginator/_files/test.sqlite'
  111. ));
  112. $this->_query = $this->_adapter->select()->from('test');
  113. $this->_testCollection = range(1, 101);
  114. $this->_paginator = Zend_Paginator::factory($this->_testCollection);
  115. $this->_config = new Zend_Config_Xml(dirname(__FILE__) . '/Paginator/_files/config.xml');
  116. // get a fresh new copy of ViewRenderer in each tests
  117. Zend_Controller_Action_HelperBroker::resetHelpers();
  118. $fO = array('lifetime' => 3600, 'automatic_serialization' => true);
  119. $bO = array('cache_dir'=> $this->_getTmpDir());
  120. $this->_cache = Zend_Cache::factory('Core', 'File', $fO, $bO);
  121. Zend_Paginator::setCache($this->_cache);
  122. $this->_restorePaginatorDefaults();
  123. }
  124. protected function tearDown()
  125. {
  126. $this->_dbConn = null;
  127. $this->_testCollection = null;
  128. $this->_paginator = null;
  129. }
  130. protected function _getTmpDir()
  131. {
  132. $tmpDir = rtrim(sys_get_temp_dir(), '/\\') . DIRECTORY_SEPARATOR . 'zend_paginator';
  133. if (file_exists($tmpDir)) {
  134. $this->_rmDirRecursive($tmpDir);
  135. }
  136. mkdir($tmpDir);
  137. $this->cacheDir = $tmpDir;
  138. return $tmpDir;
  139. }
  140. protected function _rmDirRecursive($path)
  141. {
  142. $dir = new DirectoryIterator($path);
  143. foreach ($dir as $file) {
  144. if (!$file->isDir()) {
  145. unlink($file->getPathname());
  146. } elseif (!in_array($file->getFilename(), array('.', '..'))) {
  147. $this->_rmDirRecursive($file->getPathname());
  148. }
  149. }
  150. unset($file, $dir); // required on windows to remove file handle
  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(10);
  416. }
  417. /**
  418. * @group ZF-5376
  419. */
  420. public function testGetsAndSetsItemCounterPerPageOfNegativeOne()
  421. {
  422. Zend_Paginator::setConfig(new Zend_Config(array()));
  423. $this->_paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array(range(1, 101)));
  424. $this->_paginator->setItemCountPerPage(-1);
  425. $this->assertEquals(101, $this->_paginator->getItemCountPerPage());
  426. $this->_paginator->setItemCountPerPage(10);
  427. }
  428. /**
  429. * @group ZF-5376
  430. */
  431. public function testGetsAndSetsItemCounterPerPageOfZero()
  432. {
  433. Zend_Paginator::setConfig(new Zend_Config(array()));
  434. $this->_paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array(range(1, 101)));
  435. $this->_paginator->setItemCountPerPage(0);
  436. $this->assertEquals(101, $this->_paginator->getItemCountPerPage());
  437. $this->_paginator->setItemCountPerPage(10);
  438. }
  439. /**
  440. * @group ZF-5376
  441. */
  442. public function testGetsAndSetsItemCounterPerPageOfNull()
  443. {
  444. Zend_Paginator::setConfig(new Zend_Config(array()));
  445. $this->_paginator = new Zend_Paginator(new Zend_Paginator_Adapter_Array(range(1, 101)));
  446. $this->_paginator->setItemCountPerPage();
  447. $this->assertEquals(101, $this->_paginator->getItemCountPerPage());
  448. $this->_paginator->setItemCountPerPage(10);
  449. }
  450. public function testGetsCurrentItemCount()
  451. {
  452. $this->_paginator->setItemCountPerPage(10);
  453. $this->_paginator->setPageRange(10);
  454. $this->assertEquals(10, $this->_paginator->getCurrentItemCount());
  455. $this->_paginator->setCurrentPageNumber(11);
  456. $this->assertEquals(1, $this->_paginator->getCurrentItemCount());
  457. $this->_paginator->setCurrentPageNumber(1);
  458. }
  459. public function testGetsCurrentItems()
  460. {
  461. $items = $this->_paginator->getCurrentItems();
  462. $this->assertType('ArrayIterator', $items);
  463. $count = 0;
  464. foreach ($items as $item) {
  465. $count++;
  466. }
  467. $this->assertEquals(10, $count);
  468. }
  469. public function testGetsIterator()
  470. {
  471. $items = $this->_paginator->getIterator();
  472. $this->assertType('ArrayIterator', $items);
  473. $count = 0;
  474. foreach ($items as $item) {
  475. $count++;
  476. }
  477. $this->assertEquals(10, $count);
  478. }
  479. public function testGetsAndSetsCurrentPageNumber()
  480. {
  481. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  482. $this->_paginator->setCurrentPageNumber(-1);
  483. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  484. $this->_paginator->setCurrentPageNumber(11);
  485. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  486. $this->_paginator->setCurrentPageNumber(111);
  487. $this->assertEquals(11, $this->_paginator->getCurrentPageNumber());
  488. $this->_paginator->setCurrentPageNumber(1);
  489. $this->assertEquals(1, $this->_paginator->getCurrentPageNumber());
  490. }
  491. public function testGetsAbsoluteItemNumber()
  492. {
  493. $this->assertEquals(1, $this->_paginator->getAbsoluteItemNumber(1));
  494. $this->assertEquals(11, $this->_paginator->getAbsoluteItemNumber(1, 2));
  495. $this->assertEquals(24, $this->_paginator->getAbsoluteItemNumber(4, 3));
  496. }
  497. public function testGetsItem()
  498. {
  499. $this->assertEquals(1, $this->_paginator->getItem(1));
  500. $this->assertEquals(11, $this->_paginator->getItem(1, 2));
  501. $this->assertEquals(24, $this->_paginator->getItem(4, 3));
  502. }
  503. public function testThrowsExceptionWhenCollectionIsEmpty()
  504. {
  505. $paginator = Zend_Paginator::factory(array());
  506. try {
  507. $paginator->getItem(1);
  508. } catch (Exception $e) {
  509. $this->assertType('Zend_Paginator_Exception', $e);
  510. $this->assertContains('Page 1 does not exist', $e->getMessage());
  511. }
  512. }
  513. public function testThrowsExceptionWhenRetrievingNonexistentItemFromLastPage()
  514. {
  515. try {
  516. $this->_paginator->getItem(10, 11);
  517. } catch (Exception $e) {
  518. $this->assertType('Zend_Paginator_Exception', $e);
  519. $this->assertContains('Page 11 does not contain item number 10', $e->getMessage());
  520. }
  521. }
  522. public function testNormalizesPageNumber()
  523. {
  524. $this->assertEquals(1, $this->_paginator->normalizePageNumber(0));
  525. $this->assertEquals(1, $this->_paginator->normalizePageNumber(1));
  526. $this->assertEquals(2, $this->_paginator->normalizePageNumber(2));
  527. $this->assertEquals(5, $this->_paginator->normalizePageNumber(5));
  528. $this->assertEquals(10, $this->_paginator->normalizePageNumber(10));
  529. $this->assertEquals(11, $this->_paginator->normalizePageNumber(11));
  530. $this->assertEquals(11, $this->_paginator->normalizePageNumber(12));
  531. }
  532. public function testNormalizesItemNumber()
  533. {
  534. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(0));
  535. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(1));
  536. $this->assertEquals(2, $this->_paginator->normalizeItemNumber(2));
  537. $this->assertEquals(5, $this->_paginator->normalizeItemNumber(5));
  538. $this->assertEquals(9, $this->_paginator->normalizeItemNumber(9));
  539. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(10));
  540. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(11));
  541. }
  542. /**
  543. * @group ZF-8656
  544. */
  545. public function testNormalizesPageNumberWhenGivenAFloat()
  546. {
  547. $this->assertEquals(1, $this->_paginator->normalizePageNumber(0.5));
  548. $this->assertEquals(1, $this->_paginator->normalizePageNumber(1.99));
  549. $this->assertEquals(2, $this->_paginator->normalizePageNumber(2.3));
  550. $this->assertEquals(5, $this->_paginator->normalizePageNumber(5.1));
  551. $this->assertEquals(10, $this->_paginator->normalizePageNumber(10.06));
  552. $this->assertEquals(11, $this->_paginator->normalizePageNumber(11.5));
  553. $this->assertEquals(11, $this->_paginator->normalizePageNumber(12.7889));
  554. }
  555. /**
  556. * @group ZF-8656
  557. */
  558. public function testNormalizesItemNumberWhenGivenAFloat()
  559. {
  560. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(0.5));
  561. $this->assertEquals(1, $this->_paginator->normalizeItemNumber(1.99));
  562. $this->assertEquals(2, $this->_paginator->normalizeItemNumber(2.3));
  563. $this->assertEquals(5, $this->_paginator->normalizeItemNumber(5.1));
  564. $this->assertEquals(9, $this->_paginator->normalizeItemNumber(9.06));
  565. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(10.5));
  566. $this->assertEquals(10, $this->_paginator->normalizeItemNumber(11.7889));
  567. }
  568. public function testGetsPagesInSubsetRange()
  569. {
  570. $actual = $this->_paginator->getPagesInRange(3, 8);
  571. $this->assertEquals(array_combine(range(3, 8), range(3, 8)), $actual);
  572. }
  573. public function testGetsPagesInOutOfBoundsRange()
  574. {
  575. $actual = $this->_paginator->getPagesInRange(-1, 12);
  576. $this->assertEquals(array_combine(range(1, 11), range(1, 11)), $actual);
  577. }
  578. public function testGetsItemsByPage()
  579. {
  580. $expected = new ArrayIterator(range(1, 10));
  581. $page1 = $this->_paginator->getItemsByPage(1);
  582. $this->assertEquals($page1, $expected);
  583. $this->assertEquals($page1, $this->_paginator->getItemsByPage(1));
  584. }
  585. public function testGetsItemCount()
  586. {
  587. $this->assertEquals(101, $this->_paginator->getItemCount(range(1, 101)));
  588. $limitIterator = new LimitIterator(new ArrayIterator(range(1, 101)));
  589. $this->assertEquals(101, $this->_paginator->getItemCount($limitIterator));
  590. }
  591. public function testGetsViewFromViewRenderer()
  592. {
  593. $viewRenderer = Zend_Controller_Action_HelperBroker::getStaticHelper('viewRenderer');
  594. $viewRenderer->setView(new Zend_View());
  595. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  596. }
  597. public function testGeneratesViewIfNonexistent()
  598. {
  599. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  600. }
  601. public function testGetsAndSetsView()
  602. {
  603. $this->_paginator->setView(new Zend_View());
  604. $this->assertType('Zend_View_Interface', $this->_paginator->getView());
  605. }
  606. public function testRenders()
  607. {
  608. try {
  609. $this->_paginator->render(new Zend_View());
  610. } catch (Exception $e) {
  611. $this->assertType('Zend_View_Exception', $e);
  612. $this->assertEquals('No view partial provided and no default set', $e->getMessage());
  613. }
  614. }
  615. public function testGetsAndSetsPageRange()
  616. {
  617. $this->assertEquals(10, $this->_paginator->getPageRange());
  618. $this->_paginator->setPageRange(15);
  619. $this->assertEquals(15, $this->_paginator->getPageRange());
  620. }
  621. /**
  622. * @group ZF-3720
  623. */
  624. public function testGivesCorrectItemCount()
  625. {
  626. $paginator = Zend_Paginator::factory(range(1, 101));
  627. $paginator->setCurrentPageNumber(5)
  628. ->setItemCountPerPage(5);
  629. $expected = new ArrayIterator(range(21, 25));
  630. $this->assertEquals($expected, $paginator->getCurrentItems());
  631. }
  632. /**
  633. * @group ZF-3737
  634. */
  635. public function testKeepsCurrentPageNumberAfterItemCountPerPageSet()
  636. {
  637. $paginator = Zend_Paginator::factory(array('item1', 'item2'));
  638. $paginator->setCurrentPageNumber(2)
  639. ->setItemCountPerPage(1);
  640. $items = $paginator->getCurrentItems();
  641. $this->assertEquals('item2', $items[0]);
  642. }
  643. /**
  644. * @group ZF-4193
  645. */
  646. public function testCastsIntegerValuesToInteger()
  647. {
  648. // Current page number
  649. $this->_paginator->setCurrentPageNumber(3.3);
  650. $this->assertTrue($this->_paginator->getCurrentPageNumber() == 3);
  651. // Item count per page
  652. $this->_paginator->setItemCountPerPage(3.3);
  653. $this->assertTrue($this->_paginator->getItemCountPerPage() == 3);
  654. // Page range
  655. $this->_paginator->setPageRange(3.3);
  656. $this->assertTrue($this->_paginator->getPageRange() == 3);
  657. }
  658. /**
  659. * @group ZF-4207
  660. */
  661. public function testAcceptsTraversableInstanceFromAdapter()
  662. {
  663. $paginator = new Zend_Paginator(new Zf4207());
  664. $this->assertType('ArrayObject', $paginator->getCurrentItems());
  665. }
  666. public function testCachedItem()
  667. {
  668. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  669. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  670. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  671. $pageItems = $this->_paginator->getPageItemCache();
  672. $expected = array(
  673. 1 => new ArrayIterator(range(1, 10)),
  674. 2 => new ArrayIterator(range(11, 20)),
  675. 3 => new ArrayIterator(range(21, 30))
  676. );
  677. $this->assertEquals($expected, $pageItems);
  678. }
  679. public function testClearPageItemCache()
  680. {
  681. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  682. $this->_paginator->setCurrentPageNumber(2)->getCurrentItems();
  683. $this->_paginator->setCurrentPageNumber(3)->getCurrentItems();
  684. // clear only page 2 items
  685. $this->_paginator->clearPageItemCache(2);
  686. $pageItems = $this->_paginator->getPageItemCache();
  687. $expected = array(
  688. 1 => new ArrayIterator(range(1, 10)),
  689. 3 => new ArrayIterator(range(21, 30))
  690. );
  691. $this->assertEquals($expected, $pageItems);
  692. // clear all
  693. $this->_paginator->clearPageItemCache();
  694. $pageItems = $this->_paginator->getPageItemCache();
  695. $this->assertEquals(array(), $pageItems);
  696. }
  697. public function testWithCacheDisabled()
  698. {
  699. $this->_paginator->setCacheEnabled(false);
  700. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  701. $cachedPageItems = $this->_paginator->getPageItemCache();
  702. $expected = new ArrayIterator(range(1, 10));
  703. $this->assertEquals(array(), $cachedPageItems);
  704. $pageItems = $this->_paginator->getCurrentItems();
  705. $this->assertEquals($expected, $pageItems);
  706. }
  707. public function testCacheDoesNotDisturbResultsWhenChangingParam()
  708. {
  709. $this->_paginator->setCurrentPageNumber(1)->getCurrentItems();
  710. $pageItems = $this->_paginator->setItemCountPerPage(5)->getCurrentItems();
  711. $expected = new ArrayIterator(range(1, 5));
  712. $this->assertEquals($expected, $pageItems);
  713. $pageItems = $this->_paginator->getItemsByPage(2);
  714. $expected = new ArrayIterator(range(6, 10));
  715. $this->assertEquals($expected, $pageItems);
  716. // change the inside Paginator scale
  717. $pageItems = $this->_paginator->setItemCountPerPage(8)->setCurrentPageNumber(3)->getCurrentItems();
  718. $pageItems = $this->_paginator->getPageItemCache();
  719. $expected = array(3 => new ArrayIterator(range(17, 24)));
  720. $this->assertEquals($expected, $pageItems);
  721. // get back to already cached data
  722. $this->_paginator->setItemCountPerPage(5);
  723. $pageItems = $this->_paginator->getPageItemCache();
  724. $expected =array(1 => new ArrayIterator(range(1, 5)),
  725. 2 => new ArrayIterator(range(6, 10)));
  726. $this->assertEquals($expected, $pageItems);
  727. }
  728. public function testToJson()
  729. {
  730. $this->_paginator->setCurrentPageNumber(1);
  731. $json = $this->_paginator->toJson();
  732. $expected = '"0":1,"1":2,"2":3,"3":4,"4":5,"5":6,"6":7,"7":8,"8":9,"9":10';
  733. $this->assertContains($expected, $json);
  734. }
  735. // ZF-5519
  736. public function testFilter()
  737. {
  738. $filter = new Zend_Filter_Callback(array($this, 'filterCallback'));
  739. $paginator = Zend_Paginator::factory(range(1, 10));
  740. $paginator->setFilter($filter);
  741. $page = $paginator->getCurrentItems();
  742. $this->assertEquals(new ArrayIterator(range(10, 100, 10)), $page);
  743. }
  744. public function filterCallback($value)
  745. {
  746. $data = array();
  747. foreach ($value as $number) {
  748. $data[] = ($number * 10);
  749. }
  750. return $data;
  751. }
  752. /**
  753. * @group ZF-5785
  754. */
  755. public function testGetSetDefaultItemCountPerPage()
  756. {
  757. Zend_Paginator::setConfig(new Zend_Config(array()));
  758. $paginator = Zend_Paginator::factory(range(1, 10));
  759. $this->assertEquals(10, $paginator->getItemCountPerPage());
  760. Zend_Paginator::setDefaultItemCountPerPage(20);
  761. $this->assertEquals(20, Zend_Paginator::getDefaultItemCountPerPage());
  762. $paginator = Zend_Paginator::factory(range(1, 10));
  763. $this->assertEquals(20, $paginator->getItemCountPerPage());
  764. $this->_restorePaginatorDefaults();
  765. }
  766. /**
  767. * @group ZF-7207
  768. */
  769. public function testItemCountPerPageByDefault()
  770. {
  771. $paginator = Zend_Paginator::factory(range(1,20));
  772. $this->assertEquals(2, $paginator->count());
  773. }
  774. /**
  775. * @group ZF-5427
  776. */
  777. public function testNegativeItemNumbers()
  778. {
  779. $this->assertEquals(10, $this->_paginator->getItem(-1, 1));
  780. $this->assertEquals(9, $this->_paginator->getItem(-2, 1));
  781. $this->assertEquals(101, $this->_paginator->getItem(-1, -1));
  782. }
  783. /**
  784. * @group ZF-7602
  785. */
  786. public function testAcceptAndHandlePaginatorAdapterAggregateDataInFactory()
  787. {
  788. $p = Zend_Paginator::factory(new Zend_Paginator_TestArrayAggregate());
  789. $this->assertEquals(1, count($p));
  790. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  791. $this->assertEquals(4, count($p->getAdapter()));
  792. }
  793. /**
  794. * @group ZF-7602
  795. */
  796. public function testAcceptAndHandlePaginatorAdapterAggreageInConstructor()
  797. {
  798. $p = new Zend_Paginator(new Zend_Paginator_TestArrayAggregate());
  799. $this->assertEquals(1, count($p));
  800. $this->assertType('Zend_Paginator_Adapter_Array', $p->getAdapter());
  801. $this->assertEquals(4, count($p->getAdapter()));
  802. }
  803. /**
  804. * @group ZF-7602
  805. */
  806. public function testInvalidDataInConstructor_ThrowsException()
  807. {
  808. $this->setExpectedException("Zend_Paginator_Exception");
  809. $p = new Zend_Paginator(array());
  810. }
  811. /**
  812. * @group ZF-9396
  813. */
  814. public function testArrayAccessInClassSerializableLimitIterator()
  815. {
  816. $iterator = new ArrayIterator(array('zf9396', 'foo', null));
  817. $paginator = Zend_Paginator::factory($iterator);
  818. $this->assertEquals('zf9396', $paginator->getItem(1));
  819. $items = $paginator->getAdapter()
  820. ->getItems(0, 10);
  821. $this->assertEquals('foo', $items[1]);
  822. $this->assertEquals(0, $items->key());
  823. $this->assertFalse(isset($items[2]));
  824. $this->assertTrue(isset($items[1]));
  825. $this->assertFalse(isset($items[3]));
  826. $this->assertEquals(0, $items->key());
  827. }
  828. /**
  829. * @group ZF-9174
  830. */
  831. public function testSetDefaultPageRange()
  832. {
  833. Zend_Paginator::setConfig(new Zend_Config(array()));
  834. $paginator = Zend_Paginator::factory(range(1, 10));
  835. $this->assertEquals(10, $paginator->getPageRange());
  836. Zend_Paginator::setDefaultPageRange(20);
  837. $this->assertEquals(20, Zend_Paginator::getDefaultPageRange());
  838. $paginator = Zend_Paginator::factory(range(1, 10));
  839. $this->assertEquals(20, $paginator->getPageRange());
  840. $this->_restorePaginatorDefaults();
  841. }
  842. }
  843. class Zend_Paginator_TestArrayAggregate implements Zend_Paginator_AdapterAggregate
  844. {
  845. public function getPaginatorAdapter()
  846. {
  847. return new Zend_Paginator_Adapter_Array(array(1, 2, 3, 4));
  848. }
  849. }
  850. // Call Zend_PaginatorTest::main() if this source file is executed directly.
  851. if (PHPUnit_MAIN_METHOD === 'Zend_PaginatorTest::main') {
  852. Zend_PaginatorTest::main();
  853. }