silverstripe-framework/tests/php/ORM/PaginatedListTest.php

488 lines
15 KiB
PHP
Raw Normal View History

<?php
2016-10-14 03:30:05 +02:00
namespace SilverStripe\ORM\Tests;
use SilverStripe\ORM\ArrayList;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\PaginatedList;
use SilverStripe\Dev\SapphireTest;
2017-03-24 03:50:39 +01:00
use SilverStripe\ORM\Queries\SQLSelect;
2016-10-14 03:30:05 +02:00
use SilverStripe\ORM\Tests\DataObjectTest\Player;
use SilverStripe\View\ArrayData;
use SilverStripe\Control\HTTPRequest;
/**
* Tests for the {@link SilverStripe\ORM\PaginatedList} class.
*/
class PaginatedListTest extends SapphireTest
{
protected static $fixture_file = 'DataObjectTest.yml';
API Refactor bootstrap, request handling See https://github.com/silverstripe/silverstripe-framework/pull/7037 and https://github.com/silverstripe/silverstripe-framework/issues/6681 Squashed commit of the following: commit 8f65e5653211240650eaa4fa65bb83b45aae6d58 Author: Ingo Schommer <me@chillu.com> Date: Thu Jun 22 22:25:50 2017 +1200 Fixed upgrade guide spelling commit 76f95944fa89b0b540704b8d744329f690f9698c Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 16:38:34 2017 +1200 BUG Fix non-test class manifest including sapphiretest / functionaltest commit 9379834cb4b2e5177a2600049feec05bf111c16b Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 15:50:47 2017 +1200 BUG Fix nesting bug in Kernel commit 188ce35d82599360c40f0f2de29579c56fb90761 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 15:14:51 2017 +1200 BUG fix db bootstrapping issues commit 7ed4660e7a63915e8e974deeaba9807bc4d38b0d Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 14:49:07 2017 +1200 BUG Fix issue in DetailedErrorFormatter commit 738f50c497166f81ccbe3f40fbcff895ce71f82f Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 11:49:19 2017 +1200 Upgrading notes on mysite/_config.php commit 6279d28e5e455916f902a2f963c014d8899f7fc7 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 11:43:28 2017 +1200 Update developer documentation commit 5c90d53a84ef0139c729396949a7857fae60436f Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 22 10:48:44 2017 +1200 Update installer to not use global databaseConfig commit f9b2ba4755371f08bd95f6908ac612fcbb7ca205 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 21:04:39 2017 +1200 Fix behat issues commit 5b59a912b60282b4dad4ef10ed3b97c5d0a761ac Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 17:07:11 2017 +1200 Move HTTPApplication to SilverStripe\Control namespace commit e2c4a18f637bdd3d276619554de60ee8b4d95ced Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 16:29:03 2017 +1200 More documentation Fix up remaining tests Refactor temp DB into TempDatabase class so it’s available outside of unit tests. commit 5d235e64f341d6251bfe9f4833f15cc8593c5034 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 21 12:13:15 2017 +1200 API HTTPRequestBuilder::createFromEnvironment() now cleans up live globals BUG Fix issue with SSViewer Fix Security / View tests commit d88d4ed4e48291cb65407f222f190064b1f1deeb Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 16:39:43 2017 +1200 API Refactor AppKernel into CoreKernel commit f7946aec3391139ae1b4029c353c327a36552b36 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 16:00:40 2017 +1200 Docs and minor cleanup commit 12bd31f9366327650b5c0c0f96cd0327d44faf0a Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 20 15:34:34 2017 +1200 API Remove OutputMiddleware API Move environment / global / ini management into Environment class API Move getTempFolder into TempFolder class API Implement HTTPRequestBuilder / CLIRequestBuilder BUG Restore SS_ALLOWED_HOSTS check in original location API CoreKernel now requires $basePath to be passed in API Refactor installer.php to use application to bootstrap API move memstring conversion globals to Convert BUG Fix error in CoreKernel nesting not un-nesting itself properly. commit bba979114624247cf463cf2a8c9e4be9a7c3a772 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 18:07:53 2017 +1200 API Create HTTPMiddleware and standardise middleware for request handling commit 2a10c2397bdc53001013f607b5d38087ce6c0730 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 17:42:42 2017 +1200 Fixed ORM tests commit d75a8d1d93398af4bd0432df9e4bc6295c15a3fe Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 17:15:07 2017 +1200 FIx i18n tests commit 06364af3c379c931889c4cc34dd920fee3db204a Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 16:59:34 2017 +1200 Fix controller namespace Move states to sub namespace commit 2a278e2953d2dbb19f78d91c919048e1fc935436 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 19 12:49:45 2017 +1200 Fix forms namespace commit b65c21241bee019730027071d815dbf7571197a4 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 15 18:56:48 2017 +1200 Update API usages commit d1d4375c95a264a6b63cbaefc2c1d12f808bfd82 Author: Damian Mooyman <damian@silverstripe.com> Date: Thu Jun 15 18:41:44 2017 +1200 API Refactor $flush into HTPPApplication API Enforce health check in Controller::pushCurrent() API Better global backup / restore Updated Director::test() to use new API commit b220534f06732db4fa940d8724c2a85c0ba2495a Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 22:05:57 2017 +1200 Move app nesting to a test state helper commit 603704165c08d0c1c81fd5e6bb9506326eeee17b Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 21:46:04 2017 +1200 Restore kernel stack to fix multi-level nesting commit 2f6336a15bf79dc8c2edd44cec1931da2dd51c28 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 17:23:21 2017 +1200 API Implement kernel nesting commit fc7188da7d6ad6785354bab61f08700454c81d91 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:43:13 2017 +1200 Fix core tests commit a0ae7235148fffd71f2f02d1fe7fe45bf3aa39eb Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:23:52 2017 +1200 Fix manifest tests commit ca033952513633e182040d3d13e1caa9000ca184 Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 15:00:00 2017 +1200 API Move extension management into test state commit c66d4339777663a8a04661fea32a0cf35b95d20f Author: Damian Mooyman <damian@silverstripe.com> Date: Tue Jun 13 14:10:59 2017 +1200 API Refactor SapphireTest state management into SapphireTestState API Remove Injector::unregisterAllObjects() API Remove FakeController commit f26ae75c6ecaafa0dec1093264e0187191e6764d Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 12 18:04:34 2017 +1200 Implement basic CLI application object commit 001d5596621404892de0a5413392379eff990641 Author: Damian Mooyman <damian@silverstripe.com> Date: Mon Jun 12 17:39:38 2017 +1200 Remove references to SapphireTest::is_running_test() Upgrade various code commit de079c041dacd96bc4f4b66421fa2b2cc4c320f8 Author: Damian Mooyman <damian@silverstripe.com> Date: Wed Jun 7 18:07:33 2017 +1200 API Implement APP object API Refactor of Session
2017-06-22 12:50:45 +02:00
public static function getExtraDataObjects()
{
return array_merge(
DataObjectTest::$extra_data_objects,
ManyManyListTest::$extra_data_objects
);
}
public function testPageStart()
{
$list = new PaginatedList(new ArrayList());
$this->assertEquals(0, $list->getPageStart(), 'The start defaults to 0.');
$list->setPageStart(10);
$this->assertEquals(10, $list->getPageStart(), 'You can set the page start.');
$list = new PaginatedList(new ArrayList(), ['start' => 50]);
$this->assertEquals(50, $list->getPageStart(), 'The page start can be read from the request.');
}
public function testGetTotalItems()
{
$list = new PaginatedList(new ArrayList());
$this->assertEquals(0, $list->getTotalItems());
$list->setTotalItems(10);
$this->assertEquals(10, $list->getTotalItems());
$list = new PaginatedList(
new ArrayList(
[
new ArrayData([]),
new ArrayData([])
]
)
);
$this->assertEquals(2, $list->getTotalItems());
}
public function testSetPaginationFromQuery()
{
2017-03-24 03:50:39 +01:00
$query = $this->getMockBuilder(SQLSelect::class)->getMock();
$query->expects($this->once())
->method('getLimit')
->will($this->returnValue(['limit' => 15, 'start' => 30]));
$query->expects($this->once())
->method('unlimitedRowCount')
->will($this->returnValue(100));
$list = new PaginatedList(new ArrayList());
$list->setPaginationFromQuery($query);
$this->assertEquals(15, $list->getPageLength());
$this->assertEquals(30, $list->getPageStart());
$this->assertEquals(100, $list->getTotalItems());
}
public function testSetCurrentPage()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(10);
$list->setCurrentPage(10);
$this->assertEquals(10, $list->CurrentPage());
$this->assertEquals(90, $list->getPageStart());
// Test disabled paging
$list->setPageLength(0);
$this->assertEquals(1, $list->CurrentPage());
}
public function testGetIterator()
{
$list = new PaginatedList(
new ArrayList([
new DataObject(['Num' => 1]),
new DataObject(['Num' => 2]),
new DataObject(['Num' => 3]),
new DataObject(['Num' => 4]),
new DataObject(['Num' => 5]),
])
);
$list->setPageLength(2);
2017-09-27 09:25:37 +02:00
$this->assertListEquals(
[['Num' => 1], ['Num' => 2]],
2017-09-27 09:25:37 +02:00
ArrayList::create($list->getIterator()->getInnerIterator()->getArrayCopy())
);
$list->setCurrentPage(2);
2017-09-27 09:25:37 +02:00
$this->assertListEquals(
[['Num' => 3], ['Num' => 4]],
2017-09-27 09:25:37 +02:00
ArrayList::create($list->getIterator()->getInnerIterator()->getArrayCopy())
);
$list->setCurrentPage(3);
2017-09-27 09:25:37 +02:00
$this->assertListEquals(
[['Num' => 5]],
2017-09-27 09:25:37 +02:00
ArrayList::create($list->getIterator()->getInnerIterator()->getArrayCopy())
);
$list->setCurrentPage(999);
2017-09-27 09:25:37 +02:00
$this->assertListEquals(
[],
2017-09-27 09:25:37 +02:00
ArrayList::create($list->getIterator()->getInnerIterator()->getArrayCopy())
);
// Test disabled paging
$list->setPageLength(0);
$list->setCurrentPage(1);
2017-09-27 09:25:37 +02:00
$this->assertListEquals(
[
['Num' => 1],
['Num' => 2],
['Num' => 3],
['Num' => 4],
['Num' => 5],
],
2017-09-27 09:25:37 +02:00
ArrayList::create($list->getIterator()->getInnerIterator()->getArrayCopy())
);
// Test with dataobjectset
$players = Player::get();
$list = new PaginatedList($players);
$list->setPageLength(1);
$list->getIterator();
$this->assertEquals(
4,
$list->getTotalItems(),
'Getting an iterator should not trim the list to the page length.'
);
}
public function testPages()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(10);
$list->setTotalItems(50);
$this->assertCount(5, $list->Pages());
$this->assertCount(3, $list->Pages(3));
$this->assertCount(5, $list->Pages(15));
$list->setCurrentPage(3);
$expectAll = [
['PageNum' => 1],
['PageNum' => 2],
['PageNum' => 3, 'CurrentBool' => true],
['PageNum' => 4],
['PageNum' => 5],
];
2017-09-27 09:25:37 +02:00
$this->assertListEquals($expectAll, $list->Pages());
$expectLimited = [
['PageNum' => 2],
['PageNum' => 3, 'CurrentBool' => true],
['PageNum' => 4],
];
2017-09-27 09:25:37 +02:00
$this->assertListEquals($expectLimited, $list->Pages(3));
// Disable paging
$list->setPageLength(0);
$expectAll = [
['PageNum' => 1, 'CurrentBool' => true],
];
2017-09-27 09:25:37 +02:00
$this->assertListEquals($expectAll, $list->Pages());
}
public function testPaginationSummary()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(10);
$list->setTotalItems(250);
$list->setCurrentPage(6);
$expect = [
['PageNum' => 1],
['PageNum' => null],
['PageNum' => 4],
['PageNum' => 5],
['PageNum' => 6, 'CurrentBool' => true],
['PageNum' => 7],
['PageNum' => 8],
['PageNum' => null],
['PageNum' => 25],
];
2017-09-27 09:25:37 +02:00
$this->assertListEquals($expect, $list->PaginationSummary(4));
// Disable paging
$list->setPageLength(0);
$expect = [
['PageNum' => 1, 'CurrentBool' => true]
];
2017-09-27 09:25:37 +02:00
$this->assertListEquals($expect, $list->PaginationSummary(4));
}
public function testLimitItems()
{
$list = new ArrayList(range(1, 50));
$list = new PaginatedList($list);
$list->setCurrentPage(3);
$this->assertCount(10, $list->getIterator()->getInnerIterator());
$list->setLimitItems(false);
$this->assertCount(50, $list->getIterator()->getInnerIterator());
}
public function testCurrentPage()
{
$list = new PaginatedList(new ArrayList());
$list->setTotalItems(50);
$this->assertEquals(1, $list->CurrentPage());
$list->setPageStart(10);
$this->assertEquals(2, $list->CurrentPage());
$list->setPageStart(40);
$this->assertEquals(5, $list->CurrentPage());
// Disable paging
$list->setPageLength(0);
$this->assertEquals(1, $list->CurrentPage());
}
public function testTotalPages()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(1);
$this->assertEquals(0, $list->TotalPages());
$list->setTotalItems(1);
$this->assertEquals(1, $list->TotalPages());
$list->setTotalItems(5);
$this->assertEquals(5, $list->TotalPages());
// Disable paging
$list->setPageLength(0);
$this->assertEquals(1, $list->TotalPages());
$list->setTotalItems(0);
$this->assertEquals(0, $list->TotalPages());
}
public function testMoreThanOnePage()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(1);
$list->setTotalItems(1);
$this->assertFalse($list->MoreThanOnePage());
$list->setTotalItems(2);
$this->assertTrue($list->MoreThanOnePage());
// Disable paging
$list->setPageLength(0);
$this->assertFalse($list->MoreThanOnePage());
}
public function testFirstPage()
{
$list = new PaginatedList(new ArrayList());
$this->assertTrue($list->FirstPage());
$list->setCurrentPage(2);
$this->assertFalse($list->FirstPage());
}
public function testNotFirstPage()
{
$list = new PaginatedList(new ArrayList());
$this->assertFalse($list->NotFirstPage());
$list->setCurrentPage(2);
$this->assertTrue($list->NotFirstPage());
}
public function testLastPage()
{
$list = new PaginatedList(new ArrayList());
$list->setTotalItems(50);
$this->assertFalse($list->LastPage());
$list->setCurrentPage(5);
$this->assertTrue($list->LastPage());
}
public function testNotLastPage()
{
$list = new PaginatedList(new ArrayList());
$list->setTotalItems(50);
$this->assertTrue($list->NotLastPage());
$list->setCurrentPage(5);
$this->assertFalse($list->NotLastPage());
}
public function testFirstItem()
{
$list = new PaginatedList(new ArrayList());
$this->assertEquals(1, $list->FirstItem());
$list->setPageStart(10);
$this->assertEquals(11, $list->FirstItem());
}
public function testLastItem()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(10);
$list->setTotalItems(25);
$list->setCurrentPage(1);
$this->assertEquals(10, $list->LastItem());
$list->setCurrentPage(2);
$this->assertEquals(20, $list->LastItem());
$list->setCurrentPage(3);
$this->assertEquals(25, $list->LastItem());
// Disable paging
$list->setPageLength(0);
$this->assertEquals(25, $list->LastItem());
}
public function testFirstLink()
{
$list = new PaginatedList(new ArrayList());
$this->assertStringContainsString('start=0', $list->FirstLink());
}
public function testFirstLinkContainsCurrentGetParameters()
{
$request = new HTTPRequest(
'GET',
'http://example.com/my-cool-page',
['awesomeness' => 'nextLevel', 'start' => 20]
);
$list = new PaginatedList(new ArrayList(), $request);
$list->setTotalItems(50);
$list->setPageLength(10);
// check the query string has correct parameters
$queryString = parse_url($list->FirstLink(), PHP_URL_QUERY);
parse_str($queryString, $queryParams);
$this->assertArrayHasKey('awesomeness', $queryParams);
$this->assertequals('nextLevel', $queryParams['awesomeness']);
$this->assertArrayHasKey('start', $queryParams);
$this->assertequals(0, $queryParams['start']);
}
public function testLastLink()
{
$list = new PaginatedList(new ArrayList());
$list->setPageLength(10);
$list->setTotalItems(100);
$this->assertStringContainsString('start=90', $list->LastLink());
// Disable paging
$list->setPageLength(0);
$this->assertStringContainsString('start=0', $list->LastLink());
}
public function testLastLinkContainsCurrentGetParameters()
{
$request = new HTTPRequest(
'GET',
'http://example.com/my-cool-page',
['awesomeness' => 'nextLevel']
);
$list = new PaginatedList(new ArrayList(), $request);
$list->setTotalItems(50);
$list->setPageLength(10);
// check the query string has correct parameters
$queryString = parse_url($list->LastLink(), PHP_URL_QUERY);
parse_str($queryString, $queryParams);
$this->assertArrayHasKey('awesomeness', $queryParams);
$this->assertequals('nextLevel', $queryParams['awesomeness']);
$this->assertArrayHasKey('start', $queryParams);
$this->assertequals(40, $queryParams['start']);
}
public function testNextLink()
{
$list = new PaginatedList(new ArrayList());
$list->setTotalItems(50);
$this->assertStringContainsString('start=10', $list->NextLink());
$list->setCurrentPage(2);
$this->assertStringContainsString('start=20', $list->NextLink());
$list->setCurrentPage(3);
$this->assertStringContainsString('start=30', $list->NextLink());
$list->setCurrentPage(4);
$this->assertStringContainsString('start=40', $list->NextLink());
$list->setCurrentPage(5);
$this->assertNull($list->NextLink());
// Disable paging
$list->setCurrentPage(1);
$list->setPageLength(0);
$this->assertNull($list->NextLink());
}
public function testNextLinkContainsCurrentGetParameters()
{
$request = new HTTPRequest(
'GET',
'http://example.com/my-cool-page',
['awesomeness' => 'nextLevel']
);
$list = new PaginatedList(new ArrayList(), $request);
$list->setTotalItems(50);
$list->setPageLength(10);
// check the query string has correct parameters
$queryString = parse_url($list->NextLink(), PHP_URL_QUERY);
parse_str($queryString, $queryParams);
$this->assertArrayHasKey('awesomeness', $queryParams);
$this->assertequals('nextLevel', $queryParams['awesomeness']);
$this->assertArrayHasKey('start', $queryParams);
$this->assertequals(10, $queryParams['start']);
}
public function testPrevLink()
{
$list = new PaginatedList(new ArrayList());
$list->setTotalItems(50);
$this->assertNull($list->PrevLink());
$list->setCurrentPage(2);
$this->assertStringContainsString('start=0', $list->PrevLink());
$list->setCurrentPage(3);
$this->assertStringContainsString('start=10', $list->PrevLink());
$list->setCurrentPage(5);
$this->assertStringContainsString('start=30', $list->PrevLink());
// Disable paging
$list->setPageLength(0);
$this->assertNull($list->PrevLink());
}
public function testPrevLinkContainsCurrentGetParameters()
{
$request = new HTTPRequest(
'GET',
'http://example.com/my-cool-page',
['awesomeness' => 'nextLevel', 'start' => '30']
);
$list = new PaginatedList(new ArrayList(), $request);
$list->setTotalItems(50);
$list->setPageLength(10);
// check the query string has correct parameters
$queryString = parse_url($list->PrevLink(), PHP_URL_QUERY);
parse_str($queryString, $queryParams);
$this->assertArrayHasKey('awesomeness', $queryParams);
$this->assertequals('nextLevel', $queryParams['awesomeness']);
$this->assertArrayHasKey('start', $queryParams);
$this->assertequals(20, $queryParams['start']);
}
}