'/',
'params' => [
'plugin' => null,
'controller' => '',
'action' => 'index',
'paging' => [
'Article' => [
'page' => 1,
'current' => 9,
'count' => 62,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 7,
'sort' => null,
'direction' => null,
'limit' => null,
],
],
],
]);
$this->View = new View($request);
$this->Paginator = new PaginatorHelper($this->View);
Router::reload();
Router::connect('/:controller/:action/*');
Router::connect('/:plugin/:controller/:action/*');
Router::pushRequest($request);
$this->locale = I18n::getLocale();
}
/**
* tearDown method
*
* @return void
*/
public function tearDown()
{
parent::tearDown();
unset($this->View, $this->Paginator);
I18n::setLocale($this->locale);
}
/**
* Test the templates method.
*
* @return void
*/
public function testTemplates()
{
$result = $this->Paginator->setTemplates([
'test' => 'val',
]);
$this->assertSame(
$this->Paginator,
$result,
'Setting should return the same object'
);
$result = $this->Paginator->getTemplates();
$this->assertArrayHasKey('test', $result);
$this->assertEquals('val', $result['test']);
$this->assertEquals('val', $this->Paginator->getTemplates('test'));
}
/**
* testHasPrevious method
*
* @return void
*/
public function testHasPrevious()
{
$this->assertFalse($this->Paginator->hasPrev());
$this->View->setRequest(
$this->View->getRequest()->withParam('paging.Article.prevPage', true)
);
$this->assertTrue($this->Paginator->hasPrev());
}
/**
* testHasNext method
*
* @return void
*/
public function testHasNext()
{
$this->assertTrue($this->Paginator->hasNext());
$this->View->setRequest(
$this->View->getRequest()->withParam('paging.Article.nextPage', false)
);
$this->assertFalse($this->Paginator->hasNext());
}
/**
* testSortLinks method
*
* @return void
*/
public function testSortLinks()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->Paginator->options(['url' => ['param']]);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'current' => 9,
'count' => 62,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 7,
'sort' => 'date',
'direction' => 'asc',
'page' => 1,
],
]));
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', null, ['model' => 'Nope']);
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', null, ['model' => 'Article']);
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('date');
$expected = [
'a' => ['href' => '/accounts/index/param?sort=date&direction=desc', 'class' => 'asc'],
'Date',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', 'TestTitle');
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc'],
'TestTitle',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', ['asc' => 'ascending', 'desc' => 'descending']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc'],
'ascending',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest(
$this->View->getRequest()->withParam('paging.Article.sort', 'title')
);
$result = $this->Paginator->sort('title', ['asc' => 'ascending', 'desc' => 'descending']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc', 'class' => 'asc'],
'descending',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc', 'class' => 'desc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc', 'class' => 'asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('title', 'Title', ['direction' => 'desc']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc', 'class' => 'desc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('title', 'Title', ['direction' => 'ASC']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=asc', 'class' => 'desc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('title', 'Title', ['direction' => 'asc']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc', 'class' => 'asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('title', 'Title', ['direction' => 'desc']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc', 'class' => 'asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* test sort() with escape option
*/
public function testSortEscape()
{
$result = $this->Paginator->sort('title', 'TestTitle >');
$expected = [
'a' => ['href' => '/index?sort=title&direction=asc'],
'TestTitle >',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', 'TestTitle >', ['escape' => true]);
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', 'TestTitle >', ['escape' => false]);
$expected = [
'a' => ['href' => '/index?sort=title&direction=asc'],
'TestTitle >',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* test that sort() works with virtual field order options.
*
* @return void
*/
public function testSortLinkWithVirtualField()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'full_name')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('Article.full_name');
$expected = [
'a' => ['href' => '/accounts/index?sort=Article.full_name&direction=desc', 'class' => 'asc'],
'Article Full Name',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('full_name');
$expected = [
'a' => ['href' => '/accounts/index?sort=full_name&direction=desc', 'class' => 'asc'],
'Full Name',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'full_name')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('Article.full_name');
$expected = [
'a' => ['href' => '/accounts/index?sort=Article.full_name&direction=asc', 'class' => 'desc'],
'Article Full Name',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('full_name');
$expected = [
'a' => ['href' => '/accounts/index?sort=full_name&direction=asc', 'class' => 'desc'],
'Full Name',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* testSortLinksUsingDirectionOption method
*
* @return void
*/
public function testSortLinksUsingDirectionOption()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->Paginator->options(['url' => ['param']]);
$result = $this->Paginator->sort('title', 'TestTitle', ['direction' => 'desc']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc'],
'TestTitle',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('title', ['asc' => 'ascending', 'desc' => 'descending'], ['direction' => 'desc']);
$expected = [
'a' => ['href' => '/accounts/index/param?sort=title&direction=desc'],
'descending',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* testSortLinksUsingDotNotation method
*
* @return void
*/
public function testSortLinksUsingDotNotation()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('Article.title');
$expected = [
'a' => ['href' => '/accounts/index?sort=Article.title&direction=asc', 'class' => 'desc'],
'Article Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sort('Article.title', 'Title');
$expected = [
'a' => ['href' => '/accounts/index?sort=Article.title&direction=asc', 'class' => 'desc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('Article.title', 'Title');
$expected = [
'a' => ['href' => '/accounts/index?sort=Article.title&direction=desc', 'class' => 'asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Account.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/accounts/index?sort=title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* test multiple pagination sort links
*
* @return void
*/
public function testSortLinksMultiplePagination()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->Paginator->options(['model' => 'Articles']);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Articles' => [
'current' => 9,
'count' => 62,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 7,
'sort' => 'date',
'direction' => 'asc',
'page' => 1,
'scope' => 'article',
],
'Tags' => [
'current' => 1,
'count' => 100,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
'sort' => 'tag',
'direction' => 'asc',
'page' => 1,
'scope' => 'tags',
],
]));
$result = $this->Paginator->sort('title', 'Title', ['model' => 'Articles']);
$expected = [
'a' => ['href' => '/accounts/index?article%5Bsort%5D=title&article%5Bdirection%5D=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->sort('tag', 'Tag', ['model' => 'Tags']);
$expected = [
'a' => ['class' => 'asc', 'href' => '/accounts/index?tags%5Bsort%5D=tag&tags%5Bdirection%5D=desc'],
'Tag',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* Test creating paging links for missing models.
*
* @return void
*/
public function testPagingLinksMissingModel()
{
$result = $this->Paginator->sort('title', 'Title', ['model' => 'Missing']);
$expected = [
'a' => ['href' => '/index?sort=title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next', ['model' => 'Missing']);
$expected = [
'li' => ['class' => 'next disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('Prev', ['model' => 'Missing']);
$expected = [
'li' => ['class' => 'prev disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'Prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* testSortKey method
*
* @return void
*/
public function testSortKey()
{
$result = $this->Paginator->sortKey('Article', ['sort' => 'Article.title']);
$this->assertEquals('Article.title', $result);
$result = $this->Paginator->sortKey('Article', ['sort' => 'Article']);
$this->assertEquals('Article', $result);
}
/**
* Test that sortKey falls back to the default sorting options set
* in the $params which are the default pagination options.
*
* @return void
*/
public function testSortKeyFallbackToParams()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.sort', 'Article.body'));
$result = $this->Paginator->sortKey();
$this->assertEquals('Article.body', $result);
$result = $this->Paginator->sortKey('Article');
$this->assertEquals('Article.body', $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.body')
->withParam('paging.Article.order', 'DESC'));
$result = $this->Paginator->sortKey();
$this->assertEquals('Article.body', $result);
$result = $this->Paginator->sortKey('Article');
$this->assertEquals('Article.body', $result);
}
/**
* testSortDir method
*
* @return void
*/
public function testSortDir()
{
$result = $this->Paginator->sortDir();
$expected = 'asc';
$this->assertEquals($expected, $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sortDir();
$this->assertEquals('desc', $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sortDir();
$this->assertEquals('asc', $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'title')
->withParam('paging.Article.direction', 'desc'));
$result = $this->Paginator->sortDir();
$this->assertEquals('desc', $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'title')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sortDir();
$this->assertEquals('asc', $result);
$this->View->setRequest(
$this->View->getRequest()->withParam('paging.Article.direction', null)
);
$result = $this->Paginator->sortDir('Article', ['direction' => 'asc']);
$this->assertEquals('asc', $result);
$result = $this->Paginator->sortDir('Article', ['direction' => 'desc']);
$this->assertEquals('desc', $result);
$result = $this->Paginator->sortDir('Article', ['direction' => 'asc']);
$this->assertEquals('asc', $result);
}
/**
* Test that sortDir falls back to the default sorting options set
* in the $params which are the default pagination options.
*
* @return void
*/
public function testSortDirFallbackToParams()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.body')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sortDir();
$this->assertEquals('asc', $result);
$result = $this->Paginator->sortDir('Article');
$this->assertEquals('asc', $result);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.body')
->withParam('paging.Article.direction', 'DESC'));
$result = $this->Paginator->sortDir();
$this->assertEquals('desc', $result);
$result = $this->Paginator->sortDir('Article');
$this->assertEquals('desc', $result);
}
/**
* testSortAdminLinks method
*
* @return void
*/
public function testSortAdminLinks()
{
Router::reload();
Router::connect('/admin/:controller/:action/*', ['prefix' => 'admin']);
$request = new ServerRequest([
'url' => '/admin/users',
'params' => [
'plugin' => null, 'controller' => 'users', 'action' => 'index', 'prefix' => 'admin',
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 1));
$result = $this->Paginator->next('Next');
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/admin/users/index?page=2', 'rel' => 'next'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$this->Paginator->options(['url' => ['param']]);
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/admin/users/index/param?sort=title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$this->Paginator->options(['url' => ['param']]);
$result = $this->Paginator->sort('Article.title', 'Title');
$expected = [
'a' => ['href' => '/admin/users/index/param?sort=Article.title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* Test that generated URLs work without sort defined within the request
*
* @return void
*/
public function testDefaultSortAndNoSort()
{
$request = new ServerRequest([
'url' => '/articles/',
'params' => [
'plugin' => null, 'controller' => 'articles', 'action' => 'index',
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => 1, 'current' => 3, 'count' => 13,
'prevPage' => false, 'nextPage' => true, 'pageCount' => 8,
'sortDefault' => 'Article.title', 'directionDefault' => 'ASC',
'sort' => null,
],
]));
$result = $this->Paginator->next('Next');
$expected = [
'li' => ['class' => 'next'],
'a' => ['rel' => 'next', 'href' => '/articles/index?page=2'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* testUrlGeneration method
*
* @return void
*/
public function testUrlGeneration()
{
$result = $this->Paginator->sort('controller');
$expected = [
'a' => ['href' => '/index?sort=controller&direction=asc'],
'Controller',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->generateUrl();
$this->assertEquals('/index', $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 2));
$result = $this->Paginator->generateUrl();
$this->assertEquals('/index?page=2', $result);
$options = ['sort' => 'Article', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options);
$this->assertEquals('/index?page=2&sort=Article&direction=desc', $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 3));
$options = ['sort' => 'Article.name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options);
$this->assertEquals('/index?page=3&sort=Article.name&direction=desc', $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 3));
$options = ['sort' => 'Article.name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options, null, ['escape' => false]);
$this->assertEquals('/index?page=3&sort=Article.name&direction=desc', $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 3));
$options = ['sort' => 'Article.name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options, null, ['fullBase' => true]);
$this->assertEquals('http://localhost/index?page=3&sort=Article.name&direction=desc', $result);
// @deprecated 3.3.5 Use fullBase array option instead.
$this->deprecated(function () {
$this->Paginator->request = $this->Paginator->request->withParam('paging.Article.page', 3);
$options = ['sort' => 'Article.name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options, null, true);
$this->assertEquals('http://localhost/index?page=3&sort=Article.name&direction=desc', $result);
});
}
/**
* Verify that sort links always result in a url that is page 1 (page not
* present in the url)
*
* @param string $field
* @param array $options
* @param string $expected
* @dataProvider urlGenerationResetsToPage1Provider
*/
public function testUrlGenerationResetsToPage1($field, $options, $expected)
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 2)
->withParam('paging.Article.sort', 'name')
->withParam('paging.Article.direction', 'asc'));
$result = $this->Paginator->sort($field, null, ['url' => $options]);
$this->assertSame($expected, $result);
}
/**
* Returns data sets of:
* * the name of the field being sorted on
* * url parameters to pass to paginator sort
* * expected result as a string
*
* @return array
*/
public function urlGenerationResetsToPage1Provider()
{
return [
'Sorting the field currently sorted asc, asc' => [
'name',
['sort' => 'name', 'direction' => 'asc'],
'Name',
],
'Sorting the field currently sorted asc, desc' => [
'name',
['sort' => 'name', 'direction' => 'desc'],
'Name',
],
'Sorting other asc' => [
'other',
['sort' => 'other', 'direction' => 'asc'],
'Other',
],
'Sorting other desc' => [
'other',
['sort' => 'other', 'direction' => 'desc'],
'Other',
],
];
}
/**
* test URL generation with prefix routes
*
* @return void
*/
public function testGenerateUrlWithPrefixes()
{
Router::reload();
Router::connect('/members/:controller/:action/*', ['prefix' => 'members']);
Router::connect('/:controller/:action/*');
$request = new ServerRequest([
'url' => '/posts/index/',
'params' => [
'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 2)
->withParam('paging.Article.prevPage', true));
$options = ['prefix' => 'members'];
$result = $this->Paginator->generateUrl($options);
$expected = '/members/posts/index?page=2';
$this->assertEquals($expected, $result);
$result = $this->Paginator->sort('name', null, ['url' => $options]);
$expected = [
'a' => ['href' => '/members/posts/index?sort=name&direction=asc'],
'Name',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('next', ['url' => $options]);
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/members/posts/index?page=3', 'rel' => 'next'],
'next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('prev', ['url' => $options]);
$expected = [
'li' => ['class' => 'prev'],
'a' => ['href' => '/members/posts/index', 'rel' => 'prev'],
'prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$options = ['prefix' => 'members', 'controller' => 'posts', 'sort' => 'name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options);
$expected = '/members/posts/index?page=2&sort=name&direction=desc';
$this->assertEquals($expected, $result);
$options = ['controller' => 'posts', 'sort' => 'Article.name', 'direction' => 'desc'];
$result = $this->Paginator->generateUrl($options);
$expected = '/posts/index?page=2&sort=Article.name&direction=desc';
$this->assertEquals($expected, $result);
}
/**
* test URL generation can leave prefix routes
*
* @return void
*/
public function testGenerateUrlWithPrefixesLeavePrefix()
{
Router::reload();
Router::connect('/members/:controller/:action/*', ['prefix' => 'members']);
Router::connect('/:controller/:action/*');
$request = new ServerRequest([
'params' => [
'prefix' => 'members',
'controller' => 'posts',
'action' => 'index',
'plugin' => null,
'paging' => [
'Articles' => ['page' => 2, 'prevPage' => true],
],
],
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($request);
$result = $this->Paginator->generateUrl();
$expected = '/members/posts/index?page=2';
$this->assertEquals($expected, $result);
$result = $this->Paginator->generateUrl(['prefix' => 'members']);
$expected = '/members/posts/index?page=2';
$this->assertEquals($expected, $result);
$result = $this->Paginator->generateUrl(['prefix' => false]);
$expected = '/posts/index?page=2';
$this->assertEquals($expected, $result);
$this->Paginator->options(['url' => ['prefix' => false]]);
$result = $this->Paginator->generateUrl();
$this->assertEquals($expected, $result, 'Setting prefix in options should work too.');
}
/**
* test generateUrl with multiple pagination
*
* @return void
*/
public function testGenerateUrlMultiplePagination()
{
$request = new ServerRequest([
'url' => '/posts/index/',
'params' => [
'plugin' => null, 'controller' => 'posts', 'action' => 'index', 'pass' => [],
],
'base' => '',
'webroot' => '/',
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.scope', 'article')
->withParam('paging.Article.page', 3)
->withParam('paging.Article.prevPage', true));
$this->Paginator->options(['model' => 'Article']);
$result = $this->Paginator->generateUrl([]);
$expected = '/posts/index?article%5Bpage%5D=3';
$this->assertEquals($expected, $result);
$result = $this->Paginator->sort('name');
$expected = [
'a' => ['href' => '/posts/index?article%5Bsort%5D=name&article%5Bdirection%5D=asc'],
'Name',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('next');
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/posts/index?article%5Bpage%5D=4', 'rel' => 'next'],
'next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('prev');
$expected = [
'li' => ['class' => 'prev'],
'a' => ['href' => '/posts/index?article%5Bpage%5D=2', 'rel' => 'prev'],
'prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->generateUrl(['sort' => 'name']);
$expected = '/posts/index?article%5Bpage%5D=3&article%5Bsort%5D=name';
$this->assertEquals($expected, $result);
$result = $this->Paginator->generateUrl(['#' => 'foo']);
$expected = '/posts/index?article%5Bpage%5D=3#foo';
$this->assertEquals($expected, $result);
}
/**
* test generateUrl with multiple pagination and query string values
*
* @return void
*/
public function testGenerateUrlMultiplePaginationQueryStringData()
{
$request = new ServerRequest([
'url' => '/posts/index/',
'params' => [
'plugin' => null, 'controller' => 'posts', 'action' => 'index',
],
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.scope', 'article')
->withParam('paging.Article.page', 3)
->withParam('paging.Article.prevPage', true)
->withQueryParams([
'article' => [
'puppy' => 'no',
],
]));
// Need to run __construct to update _config['url']
$paginator = new PaginatorHelper($this->View);
$paginator->options(['model' => 'Article']);
$result = $paginator->generateUrl(['sort' => 'name']);
$expected = '/posts/index?article%5Bpage%5D=3&article%5Bsort%5D=name&article%5Bpuppy%5D=no';
$this->assertEquals($expected, $result);
$result = $paginator->generateUrl([]);
$expected = '/posts/index?article%5Bpage%5D=3&article%5Bpuppy%5D=no';
$this->assertEquals($expected, $result);
}
/**
* testOptions method
*
* @return void
*/
public function testOptions()
{
$this->Paginator->options = [];
$this->View->setRequest($this->View->getRequest()->withAttribute('params', []));
$options = ['paging' => ['Article' => [
'direction' => 'desc',
'sort' => 'title',
]]];
$this->Paginator->options($options);
$expected = ['Article' => [
'direction' => 'desc',
'sort' => 'title',
]];
$this->assertEquals($expected, $this->View->getRequest()->getParam('paging'));
$this->Paginator->options = [];
$options = ['Article' => [
'direction' => 'desc',
'sort' => 'title',
]];
$this->Paginator->options($options);
$this->assertEquals($expected, $this->View->getRequest()->getParam('paging'));
$options = ['paging' => ['Article' => [
'direction' => 'desc',
'sort' => 'Article.title',
]]];
$this->Paginator->options($options);
$expected = ['Article' => [
'direction' => 'desc',
'sort' => 'Article.title',
]];
$this->assertEquals($expected, $this->View->getRequest()->getParam('paging'));
}
/**
* testPassedArgsMergingWithUrlOptions method
*
* @return void
*/
public function testPassedArgsMergingWithUrlOptions()
{
$request = new ServerRequest([
'url' => '/articles/',
'params' => [
'plugin' => null, 'controller' => 'articles', 'action' => 'index', 'pass' => [],
],
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => 1, 'current' => 3, 'count' => 13,
'prevPage' => false, 'nextPage' => true, 'pageCount' => 8,
'sort' => null, 'direction' => null,
],
]));
$this->View->setRequest($this->View->getRequest()
->withParam('pass', [2])
->withQueryParams(['page' => 1, 'foo' => 'bar', 'x' => 'y', 'num' => 0]));
$this->Paginator = new PaginatorHelper($this->View);
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&sort=title&direction=asc'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers();
$expected = [
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=7']], '7', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next');
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/articles/index/2?foo=bar&x=y&num=0&page=2', 'rel' => 'next'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* Test that generated URLs don't include sort and direction parameters
*
* @return void
*/
public function testDefaultSortRemovedFromUrl()
{
$request = new ServerRequest([
'url' => '/articles/',
'params' => [
'plugin' => null, 'controller' => 'articles', 'action' => 'index',
],
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => 1, 'current' => 3, 'count' => 13,
'prevPage' => false, 'nextPage' => true, 'pageCount' => 8,
'sort' => 'Article.title', 'direction' => 'ASC',
'sortDefault' => 'Article.title', 'directionDefault' => 'ASC',
],
]));
$result = $this->Paginator->next('Next');
$expected = [
'li' => ['class' => 'next'],
'a' => ['rel' => 'next', 'href' => '/articles/index?page=2'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* Tests that generated default order URL doesn't include sort and direction parameters.
*
* @return void
*/
public function testDefaultSortRemovedFromUrlWithAliases()
{
$request = new ServerRequest([
'params' => ['controller' => 'articles', 'action' => 'index', 'plugin' => null],
'url' => '/articles?sort=title&direction=asc',
]);
Router::setRequestInfo($request);
$this->Paginator->options(['model' => 'Articles']);
$request = $this->View->getRequest()->withParam('paging', [
'Articles' => [
'page' => 1, 'current' => 3, 'count' => 13,
'prevPage' => false, 'nextPage' => true, 'pageCount' => 8,
'sort' => 'Articles.title', 'direction' => 'asc',
'sortDefault' => 'Articles.title', 'directionDefault' => 'desc',
],
]);
$this->View->setRequest($request);
$result = $this->Paginator->sort('title');
$expected = [
'a' => ['class' => 'asc', 'href' => '/articles/index'],
'Title',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* Test the prev() method.
*
* @return void
*/
public function testPrev()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 3,
'count' => 13,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
],
]));
$result = $this->Paginator->prev('<< Previous');
$expected = [
'li' => ['class' => 'prev disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'<< Previous',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('<< Previous', ['disabledTitle' => 'Prev']);
$expected = [
'li' => ['class' => 'prev disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'Prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('<< Previous', ['disabledTitle' => false]);
$this->assertEquals('', $result, 'disabled + no text = no link');
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Client.page', 2)
->withParam('paging.Client.prevPage', true));
$result = $this->Paginator->prev('<< Previous');
$expected = [
'li' => ['class' => 'prev'],
'a' => ['href' => '/index', 'rel' => 'prev'],
'<< Previous',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('Prev', [
'templates' => [
'prevActive' => '{{text}}',
],
]);
$expected = [
'a' => ['href' => '/index', 'rel' => 'prev'],
'Prev',
'/a',
];
$this->assertHtml($expected, $result);
}
/**
* Test that prev() and the shared implementation underneath picks up from options
*
* @return void
*/
public function testPrevWithOptions()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 2, 'current' => 1, 'count' => 13, 'prevPage' => true,
'nextPage' => false, 'pageCount' => 2,
'limit' => 10,
],
]));
$this->Paginator->options(['url' => [12, 'page' => 3]]);
$result = $this->Paginator->prev('Prev', ['url' => ['foo' => 'bar']]);
$expected = [
'li' => ['class' => 'prev'],
'a' => ['href' => '/index/12?limit=10&foo=bar', 'rel' => 'prev'],
'Prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test the next() method.
*
* @return void
*/
public function testNext()
{
$result = $this->Paginator->next('Next >>');
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/index?page=2', 'rel' => 'next'],
'Next >>',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next', [
'templates' => [
'nextActive' => '{{text}}',
],
]);
$expected = [
'a' => ['href' => '/index?page=2', 'rel' => 'next'],
'Next',
'/a',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next >>', ['escape' => false]);
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/index?page=2', 'rel' => 'next'],
'preg:/Next >>/',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test next() with disabled links
*
* @return void
*/
public function testNextDisabled()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 5,
'current' => 3,
'count' => 13,
'prevPage' => true,
'nextPage' => false,
'pageCount' => 5,
],
]));
$result = $this->Paginator->next('Next >>');
$expected = [
'li' => ['class' => 'next disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'Next >>',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next >>', ['disabledTitle' => 'Next']);
$expected = [
'li' => ['class' => 'next disabled'],
'a' => ['href' => '', 'onclick' => 'return false;'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->next('Next >>', ['disabledTitle' => false]);
$this->assertEquals('', $result, 'disabled + no text = no link');
}
/**
* Test next() with a model argument.
*
* @return void
*/
public function testNextAndPrevNonDefaultModel()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 3,
'count' => 13,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
],
'Server' => [
'page' => 5,
'current' => 1,
'count' => 5,
'prevPage' => true,
'nextPage' => false,
'pageCount' => 5,
],
]));
$result = $this->Paginator->next('Next', [
'model' => 'Client',
]);
$expected = [
'li' => ['class' => 'next'],
'a' => ['href' => '/index?page=2', 'rel' => 'next'],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->prev('Prev', [
'model' => 'Client',
]);
$expected = 'Prev';
$this->assertEquals($expected, $result);
$result = $this->Paginator->next('Next', [
'model' => 'Server',
]);
$expected = 'Next';
$this->assertEquals($expected, $result);
$result = $this->Paginator->prev('Prev', [
'model' => 'Server',
]);
$expected = [
'li' => ['class' => 'prev'],
'a' => ['href' => '/index?page=4', 'rel' => 'prev'],
'Prev',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* testNumbers method
*
* @return void
*/
public function testNumbers()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 8,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers();
$expected = [
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['first' => 'first', 'last' => 'last']);
$expected = [
['li' => ['class' => 'first']], ['a' => ['href' => '/index']], 'first', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => ['class' => 'last']], ['a' => ['href' => '/index?page=15']], 'last', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['first' => '2', 'last' => '8']);
$expected = [
['li' => ['class' => 'first']], ['a' => ['href' => '/index']], '2', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => ['class' => 'last']], ['a' => ['href' => '/index?page=15']], '8', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['first' => '8', 'last' => '8']);
$expected = [
['li' => ['class' => 'first']], ['a' => ['href' => '/index']], '8', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => ['class' => 'last']], ['a' => ['href' => '/index?page=15']], '8', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers();
$expected = [
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 14,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers();
$expected = [
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=13']], '13', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=15']], '15', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 2,
'current' => 3,
'count' => 27,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 9,
],
]));
$result = $this->Paginator->numbers(['first' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['last' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 15,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers(['first' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=13']], '13', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=14']], '14', '/a', '/li',
['li' => ['class' => 'active']], 'assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 10,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=11']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12']], '12', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=13']], '13', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=14']], '14', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=15']], '15', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 6,
'current' => 15,
'count' => 623,
'prevPage' => 1,
'nextPage' => 1,
'pageCount' => 42,
],
]));
$result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=8']], '8', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=9']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10']], '10', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=42']], '42', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 37,
'current' => 15,
'count' => 623,
'prevPage' => 1,
'nextPage' => 1,
'pageCount' => 42,
],
]));
$result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=33']], '33', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=34']], '34', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=35']], '35', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=36']], '36', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=38']], '38', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=39']], '39', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=40']], '40', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=41']], '41', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=42']], '42', '/a', '/li',
];
$this->assertHtml($expected, $result);
}
/**
* testNumbersPages method
*
* @return void
*/
public function testNumbersMulti()
{
$expected = [
1 => '*1 2 3 4 5 6 7 ',
2 => '1 *2 3 4 5 6 7 ',
3 => '1 2 *3 4 5 6 7 ',
4 => '1 2 3 *4 5 6 7 ',
5 => '1 2 3 4 *5 6 7 ',
6 => '1 2 3 4 5 *6 7 ',
7 => '1 2 3 4 5 6 *7 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 7);
$this->assertEquals($expected, $result);
$result = $this->getNumbersForMultiplePages(array_keys($expected), 7, ['first' => 'F', 'last' => 'L']);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ',
2 => '1 *2 3 4 5 6 7 8 9 ',
3 => '1 2 *3 4 5 6 7 8 9 ',
4 => '1 2 3 *4 5 6 7 8 9 ',
5 => '1 2 3 4 *5 6 7 8 9 ',
6 => '2 3 4 5 *6 7 8 9 10 ',
7 => '3 4 5 6 *7 8 9 10 11 ',
10 => '6 7 8 9 *10 11 12 13 14 ',
15 => '11 12 13 14 *15 16 17 18 19 ',
16 => '12 13 14 15 *16 17 18 19 20 ',
17 => '12 13 14 15 16 *17 18 19 20 ',
18 => '12 13 14 15 16 17 *18 19 20 ',
19 => '12 13 14 15 16 17 18 *19 20 ',
20 => '12 13 14 15 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ',
2 => '1 *2 3 4 5 6 7 8 9 ',
3 => '1 2 *3 4 5 6 7 8 9 ',
4 => '1 2 3 *4 5 6 7 8 9 ',
5 => '1 2 3 4 *5 6 7 8 9 ',
6 => '1 2 3 4 5 *6 7 8 9 10 ',
7 => '1 2 3 4 5 6 *7 8 9 10 11 ',
8 => ' ' ' ' ' ' ' ' 'getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 'F']);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ',
2 => '1 *2 3 4 5 6 7 8 9 ',
3 => '1 2 *3 4 5 6 7 8 9 ',
4 => '1 2 3 *4 5 6 7 8 9 ',
5 => '1 2 3 4 *5 6 7 8 9 ',
6 => '1 2 3 4 5 *6 7 8 9 10 ',
7 => '1 2 3 4 5 6 *7 8 9 10 11 ',
8 => '1 2 3 4 5 6 7 *8 9 10 11 12 ',
9 => '1 2 ... 5 6 7 8 *9 10 11 12 13 ',
10 => '1 2 ... 6 7 8 9 *10 11 12 13 14 ',
15 => '1 2 ... 11 12 13 14 *15 16 17 18 19 ',
16 => '1 2 ... 12 13 14 15 *16 17 18 19 20 ',
17 => '1 2 ... 12 13 14 15 16 *17 18 19 20 ',
18 => '1 2 ... 12 13 14 15 16 17 *18 19 20 ',
19 => '1 2 ... 12 13 14 15 16 17 18 *19 20 ',
20 => '1 2 ... 12 13 14 15 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 2]);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ... L> ',
2 => '1 *2 3 4 5 6 7 8 9 ... L> ',
3 => '1 2 *3 4 5 6 7 8 9 ... L> ',
4 => '1 2 3 *4 5 6 7 8 9 ... L> ',
5 => '1 2 3 4 *5 6 7 8 9 ... L> ',
6 => '2 3 4 5 *6 7 8 9 10 ... L> ',
7 => '3 4 5 6 *7 8 9 10 11 ... L> ',
8 => '4 5 6 7 *8 9 10 11 12 ... L> ',
9 => '5 6 7 8 *9 10 11 12 13 ... L> ',
10 => '6 7 8 9 *10 11 12 13 14 ... L> ',
11 => '7 8 9 10 *11 12 13 14 15 ... L> ',
12 => '8 9 10 11 *12 13 14 15 16 ... L> ',
13 => '9 10 11 12 *13 14 15 16 17 ... L> ',
14 => '10 11 12 13 *14 15 16 17 18 19 20 ',
15 => '11 12 13 14 *15 16 17 18 19 20 ',
16 => '12 13 14 15 *16 17 18 19 20 ',
17 => '12 13 14 15 16 *17 18 19 20 ',
18 => '12 13 14 15 16 17 *18 19 20 ',
19 => '12 13 14 15 16 17 18 *19 20 ',
20 => '12 13 14 15 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['last' => 'L']);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ... L> ',
2 => '1 *2 3 4 5 6 7 8 9 ... L> ',
3 => '1 2 *3 4 5 6 7 8 9 ... L> ',
4 => '1 2 3 *4 5 6 7 8 9 ... L> ',
5 => '1 2 3 4 *5 6 7 8 9 ... L> ',
6 => '1 2 3 4 5 *6 7 8 9 10 ... L> ',
7 => '1 2 3 4 5 6 *7 8 9 10 11 ... L> ',
8 => ' ',
9 => ' ',
10 => ' ',
11 => ' ',
12 => ' ',
13 => ' ',
14 => ' ' ' ' ' ' 'getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 'F', 'last' => 'L']);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ... 19 20 ',
2 => '1 *2 3 4 5 6 7 8 9 ... 19 20 ',
3 => '1 2 *3 4 5 6 7 8 9 ... 19 20 ',
4 => '1 2 3 *4 5 6 7 8 9 ... 19 20 ',
5 => '1 2 3 4 *5 6 7 8 9 ... 19 20 ',
6 => '1 2 3 4 5 *6 7 8 9 10 ... 19 20 ',
7 => '1 2 3 4 5 6 *7 8 9 10 11 ... 19 20 ',
8 => '1 2 3 4 5 6 7 *8 9 10 11 12 ... 19 20 ',
9 => '1 2 ... 5 6 7 8 *9 10 11 12 13 ... 19 20 ',
10 => '1 2 ... 6 7 8 9 *10 11 12 13 14 ... 19 20 ',
11 => '1 2 ... 7 8 9 10 *11 12 13 14 15 ... 19 20 ',
12 => '1 2 ... 8 9 10 11 *12 13 14 15 16 ... 19 20 ',
13 => '1 2 ... 9 10 11 12 *13 14 15 16 17 18 19 20 ',
14 => '1 2 ... 10 11 12 13 *14 15 16 17 18 19 20 ',
15 => '1 2 ... 11 12 13 14 *15 16 17 18 19 20 ',
16 => '1 2 ... 12 13 14 15 *16 17 18 19 20 ',
17 => '1 2 ... 12 13 14 15 16 *17 18 19 20 ',
18 => '1 2 ... 12 13 14 15 16 17 *18 19 20 ',
19 => '1 2 ... 12 13 14 15 16 17 18 *19 20 ',
20 => '1 2 ... 12 13 14 15 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 2, 'last' => 2]);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 6 7 8 9 ... 19 20 ',
2 => '1 *2 3 4 5 6 7 8 9 ... 19 20 ',
3 => '1 2 *3 4 5 6 7 8 9 ... 19 20 ',
4 => '1 2 3 *4 5 6 7 8 9 ... 19 20 ',
5 => '1 2 3 4 *5 6 7 8 9 ... 19 20 ',
6 => '2 3 4 5 *6 7 8 9 10 ... 19 20 ',
7 => '3 4 5 6 *7 8 9 10 11 ... 19 20 ',
8 => '4 5 6 7 *8 9 10 11 12 ... 19 20 ',
9 => '5 6 7 8 *9 10 11 12 13 ... 19 20 ',
10 => '6 7 8 9 *10 11 12 13 14 ... 19 20 ',
11 => '7 8 9 10 *11 12 13 14 15 ... 19 20 ',
12 => '8 9 10 11 *12 13 14 15 16 ... 19 20 ',
13 => '9 10 11 12 *13 14 15 16 17 18 19 20 ',
14 => '10 11 12 13 *14 15 16 17 18 19 20 ',
15 => '11 12 13 14 *15 16 17 18 19 20 ',
16 => '12 13 14 15 *16 17 18 19 20 ',
17 => '12 13 14 15 16 *17 18 19 20 ',
18 => '12 13 14 15 16 17 *18 19 20 ',
19 => '12 13 14 15 16 17 18 *19 20 ',
20 => '12 13 14 15 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['last' => 2]);
$this->assertEquals($expected, $result);
}
/**
* Retrieves result of PaginatorHelper::numbers for multiple pages
*
* @param int[] $pagesToCheck Pages to get result for
* @param int $pageCount Number of total pages
* @param array $options Options for PaginatorHelper::numbers
* @return string[]
*/
protected function getNumbersForMultiplePages($pagesToCheck, $pageCount, $options = [])
{
$options['templates'] = [
'first' => '<{{text}} ',
'last' => '{{text}}> ',
'number' => '{{text}} ',
'current' => '*{{text}} ',
'ellipsis' => '... ',
];
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'pageCount' => $pageCount,
],
]));
$result = [];
foreach ($pagesToCheck as $page) {
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', $page));
$result[$page] = $this->Paginator->numbers($options);
}
return $result;
}
/**
* Test that numbers() lets you overwrite templates.
*
* The templates file has no li elements.
*
* @return void
*/
public function testNumbersTemplates()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 8,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers(['templates' => 'htmlhelper_tags']);
$expected = [
['a' => ['href' => '/index?page=4']], '4', '/a',
['a' => ['href' => '/index?page=5']], '5', '/a',
['a' => ['href' => '/index?page=6']], '6', '/a',
['a' => ['href' => '/index?page=7']], '7', '/a',
'span' => ['class' => 'active'], '8', '/span',
['a' => ['href' => '/index?page=9']], '9', '/a',
['a' => ['href' => '/index?page=10']], '10', '/a',
['a' => ['href' => '/index?page=11']], '11', '/a',
['a' => ['href' => '/index?page=12']], '12', '/a',
];
$this->assertHtml($expected, $result);
$this->assertContains(
'Paginator->templater()->get('current'),
'Templates were not restored.'
);
}
/**
* Test modulus option for numbers()
*
* @return void
*/
public function testNumbersModulus()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 10,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 3,
],
]));
$result = $this->Paginator->numbers(['modulus' => 10]);
$expected = [
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['modulus' => 3]);
$expected = [
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 4895,
'current' => 10,
'count' => 48962,
'prevPage' => 1,
'nextPage' => 1,
'pageCount' => 4897,
],
]));
$result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4894']], '4,894', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 3));
$result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->numbers(['first' => 5, 'modulus' => 5, 'last' => 5]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4893']], '4,893', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4894']], '4,894', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4895']], '4,895', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 4893));
$result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4891']], '4,891', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4892']], '4,892', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4894']], '4,894', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4895']], '4,895', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 58));
$result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=56']], '56', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=57']], '57', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=59']], '59', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=60']], '60', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4893']], '4,893', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4894']], '4,894', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4895']], '4,895', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 5));
$result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7']], '7', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4893']], '4,893', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4894']], '4,894', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4895']], '4,895', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 3));
$result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4']], '4', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Client.page', 3));
$result = $this->Paginator->numbers(['first' => 2, 'modulus' => 0, 'last' => 2]);
$expected = [
['li' => []], ['a' => ['href' => '/index']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => ['class' => 'active']], ' ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
}
/**
* Test modulus option for numbers()
*
* @return void
*/
public function testNumbersModulusMulti()
{
$expected = [
1 => '*1 2 3 4 ',
2 => '1 *2 3 4 ',
3 => '1 2 *3 4 ',
4 => '2 3 *4 5 ',
5 => '3 4 *5 6 ',
6 => '4 5 *6 7 ',
7 => '4 5 6 *7 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 7, ['modulus' => 3]);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 ... L> ',
2 => '1 *2 3 4 ... L> ',
3 => '1 2 *3 4 ... L> ',
4 => '1 2 3 *4 5 6 7 ',
5 => '1 2 3 4 *5 6 7 ',
6 => ' 'getNumbersForMultiplePages(array_keys($expected), 7, ['modulus' => 3, 'first' => 'F', 'last' => 'L']);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 ... 19 20 ',
2 => '1 *2 3 ... 19 20 ',
3 => '1 2 *3 4 ... 19 20 ',
4 => '1 2 3 *4 5 ... 19 20 ',
5 => '1 2 3 4 *5 6 ... 19 20 ',
6 => '1 2 ... 5 *6 7 ... 19 20 ',
15 => '1 2 ... 14 *15 16 ... 19 20 ',
16 => '1 2 ... 15 *16 17 18 19 20 ',
17 => '1 2 ... 16 *17 18 19 20 ',
18 => '1 2 ... 17 *18 19 20 ',
19 => '1 2 ... 18 *19 20 ',
20 => '1 2 ... 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 2, 'modulus' => 2, 'last' => 2]);
$this->assertEquals($expected, $result);
$expected = [
1 => '*1 2 3 4 5 ... 16 17 18 19 20 ',
2 => '1 *2 3 4 5 ... 16 17 18 19 20 ',
3 => '1 2 *3 4 5 ... 16 17 18 19 20 ',
4 => '1 2 3 *4 5 6 ... 16 17 18 19 20 ',
5 => '1 2 3 4 *5 6 7 ... 16 17 18 19 20 ',
6 => '1 2 3 4 5 *6 7 8 ... 16 17 18 19 20 ',
7 => '1 2 3 4 5 6 *7 8 9 ... 16 17 18 19 20 ',
8 => '1 2 3 4 5 6 7 *8 9 10 ... 16 17 18 19 20 ',
9 => '1 2 3 4 5 6 7 8 *9 10 11 ... 16 17 18 19 20 ',
10 => '1 2 3 4 5 ... 8 9 *10 11 12 ... 16 17 18 19 20 ',
11 => '1 2 3 4 5 ... 9 10 *11 12 13 ... 16 17 18 19 20 ',
12 => '1 2 3 4 5 ... 10 11 *12 13 14 15 16 17 18 19 20 ',
13 => '1 2 3 4 5 ... 11 12 *13 14 15 16 17 18 19 20 ',
14 => '1 2 3 4 5 ... 12 13 *14 15 16 17 18 19 20 ',
15 => '1 2 3 4 5 ... 13 14 *15 16 17 18 19 20 ',
16 => '1 2 3 4 5 ... 14 15 *16 17 18 19 20 ',
17 => '1 2 3 4 5 ... 15 16 *17 18 19 20 ',
18 => '1 2 3 4 5 ... 16 17 *18 19 20 ',
19 => '1 2 3 4 5 ... 16 17 18 *19 20 ',
20 => '1 2 3 4 5 ... 16 17 18 19 *20 ',
];
$result = $this->getNumbersForMultiplePages(array_keys($expected), 20, ['first' => 5, 'modulus' => 4, 'last' => 5]);
$this->assertEquals($expected, $result);
}
/**
* Tests that disabling modulus displays all page links.
*
* @return void
*/
public function testModulusDisabled()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 4,
'current' => 2,
'count' => 30,
'prevPage' => 1,
'nextPage' => 1,
'pageCount' => 6,
],
]));
$result = $this->Paginator->numbers(['modulus' => false]);
$expected = [
['li' => []], ' []], ['a' => ['href' => '/index?page=2']], '2', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=3']], '3', '/a', '/li',
['li' => ['class' => 'active']], ['a' => ['href' => '']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6']], '6', '/a', '/li',
];
$this->assertHtml($expected, $result);
}
/**
* Test that numbers() with url options.
*
* @return void
*/
public function testNumbersWithUrlOptions()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 8,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
],
]));
$result = $this->Paginator->numbers(['url' => ['#' => 'foo']]);
$expected = [
['li' => []], ['a' => ['href' => '/index?page=4#foo']], '4', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=5#foo']], '5', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=6#foo']], '6', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=7#foo']], '7', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=9#foo']], '9', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=10#foo']], '10', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=11#foo']], '11', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=12#foo']], '12', '/a', '/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 3,
'current' => 10,
'count' => 48962,
'prevPage' => 1,
'nextPage' => 1,
'pageCount' => 4897,
],
]));
$result = $this->Paginator->numbers([
'first' => 2,
'modulus' => 2,
'last' => 2,
'url' => ['foo' => 'bar']]);
$expected = [
['li' => []], ['a' => ['href' => '/index?foo=bar']], '1', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=2&foo=bar']], '2', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/index?page=4&foo=bar']], '4', '/a', '/li',
['li' => ['class' => 'ellipsis']], '…', '/li',
['li' => []], ['a' => ['href' => '/index?page=4896&foo=bar']], '4,896', '/a', '/li',
['li' => []], ['a' => ['href' => '/index?page=4897&foo=bar']], '4,897', '/a', '/li',
];
$this->assertHtml($expected, $result);
}
/**
* test numbers() with routing parameters.
*
* @return void
*/
public function testNumbersRouting()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 2,
'current' => 2,
'count' => 30,
'prevPage' => false,
'nextPage' => 3,
'pageCount' => 3,
],
]));
$request = new ServerRequest([
'params' => ['controller' => 'clients', 'action' => 'index', 'plugin' => null],
'url' => '/clients/index?page=2',
]);
Router::setRequestInfo($request);
$result = $this->Paginator->numbers();
$expected = [
['li' => []], ['a' => ['href' => '/clients/index']], '1', '/a', '/li',
['li' => ['class' => 'active']], ' []], ['a' => ['href' => '/clients/index?page=3']], '3', '/a', '/li',
];
$this->assertHtml($expected, $result);
}
/**
* Test that numbers() works with the non default model.
*
* @return void
*/
public function testNumbersNonDefaultModel()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 3,
'count' => 13,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
],
'Server' => [
'page' => 5,
'current' => 1,
'count' => 5,
'prevPage' => true,
'nextPage' => false,
'pageCount' => 5,
],
]));
$result = $this->Paginator->numbers(['model' => 'Server']);
$this->assertContains('5', $result);
$this->assertNotContains('1', $result);
$result = $this->Paginator->numbers(['model' => 'Client']);
$this->assertContains('1', $result);
$this->assertNotContains('5', $result);
}
/**
* test first() and last() with tag options
*
* @return void
*/
public function testFirstAndLastTag()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 2));
$result = $this->Paginator->first('<<');
$expected = [
'li' => ['class' => 'first'],
'a' => ['href' => '/index'],
'<<',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->first('5');
$expected = [
'li' => ['class' => 'first'],
'a' => ['href' => '/index'],
'5',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last(2);
$expected = [
' ['href' => '/index?page=6']], '6', '/a',
'/li',
' ['href' => '/index?page=7']], '7', '/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last('9');
$expected = [
'li' => ['class' => 'last'],
'a' => ['href' => '/index?page=7'],
'9',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test that on the last page you don't get a link ot the last page.
*
* @return void
*/
public function testLastNoOutput()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 15)
->withParam('paging.Article.pageCount', 15));
$result = $this->Paginator->last();
$expected = '';
$this->assertEquals($expected, $result);
}
/**
* test first() with a the model parameter.
*
* @return void
*/
public function testFirstNonDefaultModel()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 1)
->withParam('paging.Client', [
'page' => 3,
'current' => 3,
'count' => 13,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
]));
$result = $this->Paginator->first('first', ['model' => 'Article']);
$this->assertEquals('', $result);
$result = $this->Paginator->first('first', ['model' => 'Client']);
$expected = [
'li' => ['class' => 'first'],
'a' => ['href' => '/index'],
'first',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test first() on the first page.
*
* @return void
*/
public function testFirstEmpty()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 1));
$result = $this->Paginator->first();
$expected = '';
$this->assertEquals($expected, $result);
}
/**
* test first() and options()
*
* @return void
*/
public function testFirstFullBaseUrl()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 3)
->withParam('paging.Article.direction', 'DESC')
->withParam('paging.Article.sort', 'Article.title'));
$this->Paginator->options(['url' => ['_full' => true]]);
$result = $this->Paginator->first();
$expected = [
'li' => ['class' => 'first'],
['a' => [
'href' => Configure::read('App.fullBaseUrl') . '/index?sort=Article.title&direction=DESC',
]],
'<< first',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test first() and last with url options
*
* @return void
*/
public function testFirstAndLastUrlOptions()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article', [
'page' => 3,
'pageCount' => 5,
'direction' => 'DESC',
'sort' => 'Article.title',
]));
$result = $this->Paginator->first('first', ['url' => ['?' => ['key' => 'value']]]);
$expected = [
'li' => ['class' => 'first'],
['a' => [
'href' => '/index?key=value&sort=Article.title&direction=DESC',
]],
'first',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last('last', ['url' => ['?' => ['key' => 'value']]]);
$expected = [
'li' => ['class' => 'last'],
['a' => [
'href' => '/index?key=value&page=5&sort=Article.title&direction=DESC',
]],
'last',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test first() on the fence-post
*
* @return void
*/
public function testFirstBoundaries()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 3));
$result = $this->Paginator->first();
$expected = [
'li' => ['class' => 'first'],
'a' => ['href' => '/index'],
'<< first',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->first(2);
$expected = [
' ['href' => '/index']], '1', '/a',
'/li',
' ['href' => '/index?page=2']], '2', '/a',
'/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 2));
$result = $this->Paginator->first(3);
$this->assertEquals('', $result, 'When inside the first links range, no links should be made');
}
/**
* test params() method
*
* @return void
*/
public function testParams()
{
$result = $this->Paginator->params();
$this->assertArrayHasKey('page', $result);
$this->assertArrayHasKey('pageCount', $result);
$result = $this->Paginator->params('Nope');
$this->assertEquals([], $result);
}
/**
* test param() method
*
* @return void
*/
public function testParam()
{
$result = $this->Paginator->param('count');
$this->assertSame(62, $result);
$result = $this->Paginator->param('imaginary');
$this->assertNull($result);
}
/**
* test last() method
*
* @return void
*/
public function testLast()
{
$result = $this->Paginator->last();
$expected = [
'li' => ['class' => 'last'],
'a' => ['href' => '/index?page=7'],
'last >>',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last(1);
$expected = [
' ['href' => '/index?page=7'],
'7',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
$this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 6));
$result = $this->Paginator->last(2);
$expected = [
' ['href' => '/index?page=6']], '6', '/a',
'/li',
' ['href' => '/index?page=7']], '7', '/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last(3);
$this->assertEquals('', $result, 'When inside the last links range, no links should be made');
}
/**
* test the options for last()
*
* @return void
*/
public function testLastOptions()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 4,
'current' => 3,
'count' => 30,
'prevPage' => false,
'nextPage' => 2,
'pageCount' => 15,
'sort' => 'Client.name',
'direction' => 'DESC',
],
]));
$result = $this->Paginator->last();
$expected = [
'li' => ['class' => 'last'],
'a' => [
'href' => '/index?page=15&sort=Client.name&direction=DESC',
],
'last >>', '/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last(1);
$expected = [
' ['href' => '/index?page=15&sort=Client.name&direction=DESC']], '15', '/a',
'/li',
];
$this->assertHtml($expected, $result);
$result = $this->Paginator->last(2);
$expected = [
' ['href' => '/index?page=14&sort=Client.name&direction=DESC']], '14', '/a',
'/li',
' ['href' => '/index?page=15&sort=Client.name&direction=DESC']], '15', '/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test last() with a the model parameter.
*
* @return void
*/
public function testLastNonDefaultModel()
{
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.page', 7)
->withParam('paging.Client', [
'page' => 3,
'current' => 3,
'count' => 13,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
]));
$result = $this->Paginator->last('last', ['model' => 'Article']);
$this->assertEquals('', $result);
$result = $this->Paginator->last('last', ['model' => 'Client']);
$expected = [
'li' => ['class' => 'last'],
'a' => ['href' => '/index?page=5'],
'last',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* testCounter method
*
* @return void
*/
public function testCounter()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1,
'current' => 3,
'count' => 13,
'perPage' => 3,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 5,
'limit' => 3,
'sort' => 'Client.name',
'order' => 'DESC',
'start' => 1,
'end' => 3,
],
]));
$input = 'Page {{page}} of {{pages}}, showing {{current}} records out of {{count}} total, ';
$input .= 'starting on record {{start}}, ending on {{end}}';
$expected = 'Page 1 of 5, showing 3 records out of 13 total, starting on record 1, ';
$expected .= 'ending on 3';
$result = $this->Paginator->counter($input);
$this->assertEquals($expected, $result);
$result = $this->Paginator->counter(['format' => 'pages']);
$expected = '1 of 5';
$this->assertEquals($expected, $result);
$result = $this->Paginator->counter(['format' => 'range']);
$expected = '1 - 3 of 13';
$this->assertEquals($expected, $result);
$result = $this->Paginator->counter('Showing {{page}} of {{pages}} {{model}}');
$this->assertEquals('Showing 1 of 5 clients', $result);
}
/**
* Tests that numbers are formatted according to the locale when using counter()
*
* @return void
*/
public function testCounterBigNumbers()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Client' => [
'page' => 1523,
'current' => 3000,
'count' => 4800001,
'perPage' => 3000,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 1600,
'limit' => 5000,
'sort' => 'Client.name',
'order' => 'DESC',
'start' => 4566001,
'end' => 4569001,
],
]));
$input = 'Page {{page}} of {{pages}}, showing {{current}} records out of {{count}} total, ';
$input .= 'starting on record {{start}}, ending on {{end}}';
$expected = 'Page 1,523 of 1,600, showing 3,000 records out of 4,800,001 total, ';
$expected .= 'starting on record 4,566,001, ending on 4,569,001';
$result = $this->Paginator->counter($input);
$this->assertEquals($expected, $result);
I18n::setLocale('de-DE');
$expected = 'Page 1.523 of 1.600, showing 3.000 records out of 4.800.001 total, ';
$expected .= 'starting on record 4.566.001, ending on 4.569.001';
$result = $this->Paginator->counter($input);
$this->assertEquals($expected, $result);
}
/**
* testHasPage method
*
* @return void
*/
public function testHasPage()
{
$result = $this->Paginator->hasPage('Article', 15);
$this->assertFalse($result);
$result = $this->Paginator->hasPage('UndefinedModel', 2);
$this->assertFalse($result);
$result = $this->Paginator->hasPage('Article', 2);
$this->assertTrue($result);
$result = $this->Paginator->hasPage(2);
$this->assertTrue($result);
}
/**
* testNextLinkUsingDotNotation method
*
* @return void
*/
public function testNextLinkUsingDotNotation()
{
$request = new ServerRequest([
'url' => '/accounts/',
'params' => [
'plugin' => null, 'controller' => 'accounts', 'action' => 'index',
],
]);
Router::setRequestInfo($request);
$this->View->setRequest($this->View->getRequest()
->withParam('paging.Article.sort', 'Article.title')
->withParam('paging.Article.direction', 'asc')
->withParam('paging.Article.page', 1));
$test = ['url' => [
'page' => '1',
'sort' => 'Article.title',
'direction' => 'asc',
]];
$this->Paginator->options($test);
$result = $this->Paginator->next('Next');
$expected = [
'li' => ['class' => 'next'],
'a' => [
'href' => '/accounts/index?page=2&sort=Article.title&direction=asc',
'rel' => 'next',
],
'Next',
'/a',
'/li',
];
$this->assertHtml($expected, $result);
}
/**
* test the current() method
*
* @return void
*/
public function testCurrent()
{
$result = $this->Paginator->current();
$this->assertEquals($this->View->getRequest()->getParam('paging.Article.page'), $result);
$result = $this->Paginator->current('Incorrect');
$this->assertEquals(1, $result);
}
/**
* test the total() method
*
* @return void
*/
public function testTotal()
{
$result = $this->Paginator->total();
$this->assertSame($this->View->getRequest()->getParam('paging.Article.pageCount'), $result);
$result = $this->Paginator->total('Incorrect');
$this->assertSame(0, $result);
}
/**
* test the defaultModel() method
*
* @return void
*/
public function testNoDefaultModel()
{
$this->View->setRequest(new ServerRequest());
$this->assertNull($this->Paginator->defaultModel());
$this->Paginator->defaultModel('Article');
$this->assertEquals('Article', $this->Paginator->defaultModel());
$this->Paginator->options(['model' => 'Client']);
$this->assertEquals('Client', $this->Paginator->defaultModel());
}
/**
* test the numbers() method when there is only one page
*
* @return void
*/
public function testWithOnePage()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => 1,
'current' => 2,
'count' => 2,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 1,
],
]));
$this->assertFalse($this->Paginator->numbers());
$this->assertFalse($this->Paginator->first());
$this->assertFalse($this->Paginator->last());
}
/**
* test the numbers() method when there is only one page
*
* @return void
*/
public function testWithZeroPages()
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => 0,
'current' => 0,
'count' => 0,
'perPage' => 10,
'prevPage' => false,
'nextPage' => false,
'pageCount' => 0,
'limit' => 10,
'start' => 0,
'end' => 0,
],
]));
$result = $this->Paginator->counter(['format' => 'pages']);
$expected = '0 of 1';
$this->assertEquals($expected, $result);
}
/**
* Test data for meta()
*
* @return array
*/
public function dataMetaProvider()
{
return [
// Verifies that no next and prev links are created for single page results.
[1, false, false, 1, [], ''],
// Verifies that first and last pages are created for single page results.
[1, false, false, 1, ['first' => true, 'last' => true], '' .
''],
// Verifies that first page is created for single page results.
[1, false, false, 1, ['first' => true], ''],
// Verifies that last page is created for single page results.
[1, false, false, 1, ['last' => true], ''],
// Verifies that page 1 only has a next link.
[1, false, true, 2, [], ''],
// Verifies that page 1 only has next, first and last link.
[1, false, true, 2, ['first' => true, 'last' => true], '' .
'' .
''],
// Verifies that page 1 only has next and first link.
[1, false, true, 2, ['first' => true], '' .
''],
// Verifies that page 1 only has next and last link.
[1, false, true, 2, ['last' => true], '' .
''],
// Verifies that the last page only has a prev link.
[2, true, false, 2, [], ''],
// Verifies that the last page only has a prev, first and last link.
[2, true, false, 2, ['first' => true, 'last' => true], '' .
'' .
''],
// Verifies that a page in the middle has both links.
[5, true, true, 10, [], '' .
''],
// Verifies that a page in the middle has both links.
[5, true, true, 10, ['first' => true, 'last' => true], '' .
'' .
'' .
''],
];
}
/**
* @param int $page
* @param int $prevPage
* @param int $nextPage
* @param int $pageCount
* @param array $options
* @param string $expected
* @dataProvider dataMetaProvider
*/
public function testMeta($page, $prevPage, $nextPage, $pageCount, $options, $expected)
{
$this->View->setRequest($this->View->getRequest()->withParam('paging', [
'Article' => [
'page' => $page,
'prevPage' => $prevPage,
'nextPage' => $nextPage,
'pageCount' => $pageCount,
],
]));
$this->Paginator->options(['url' => ['?' => ['foo' => 'bar']]]);
$result = $this->Paginator->meta($options);
$this->assertSame($expected, $result);
$this->assertEquals('', $this->View->fetch('meta'));
$result = $this->Paginator->meta($options + ['block' => true]);
$this->assertNull($result);
$this->assertSame($expected, $this->View->fetch('meta'));
}
/**
* test the limitControl() method
*
* @return void
*/
public function testLimitControl()
{
$out = $this->Paginator->limitControl([1 => 1]);
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()']],
['option' => ['value' => '1']],
'1',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
$out = $this->Paginator->limitControl([1 => 1, 5 => 5], null, ['class' => 'form-control']);
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()', 'class' => 'form-control']],
['option' => ['value' => '1']],
'1',
'/option',
['option' => ['value' => '5']],
'5',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
$out = $this->Paginator->limitControl([], null, ['class' => 'form-control']);
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()', 'class' => 'form-control']],
['option' => ['value' => '20']],
'20',
'/option',
['option' => ['value' => '50']],
'50',
'/option',
['option' => ['value' => '100']],
'100',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
$out = $this->Paginator->limitControl();
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()']],
['option' => ['value' => '20']],
'20',
'/option',
['option' => ['value' => '50']],
'50',
'/option',
['option' => ['value' => '100']],
'100',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
}
/**
* test the limitControl() method with defaults and query
*
* @return void
*/
public function testLimitControlQuery()
{
$out = $this->Paginator->limitControl([], 50);
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()']],
['option' => ['value' => '20']],
'20',
'/option',
['option' => ['value' => '50', 'selected' => 'selected']],
'50',
'/option',
['option' => ['value' => '100']],
'100',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
$this->View->setRequest($this->View->getRequest()->withQueryParams(['limit' => '100']));
$out = $this->Paginator->limitControl([], 50);
$expected = [
['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
['div' => ['class' => 'input select']],
['label' => ['for' => 'limit']],
'View',
'/label',
['select' => ['name' => 'limit', 'id' => 'limit', 'onChange' => 'this.form.submit()']],
['option' => ['value' => '20']],
'20',
'/option',
['option' => ['value' => '50']],
'50',
'/option',
['option' => ['value' => '100', 'selected' => 'selected']],
'100',
'/option',
'/select',
'/div',
'/form',
];
$this->assertHtml($expected, $out);
}
/**
* Test using paging params set by SimplePaginator which doesn't do count query.
*
* @return void
*/
public function testMethodsWhenThereIsNoPageCount()
{
$request = new ServerRequest([
'url' => '/',
'params' => [
'paging' => [
'Article' => [
'page' => 1,
'current' => 9,
'count' => null,
'prevPage' => false,
'nextPage' => true,
'pageCount' => 0,
'start' => 1,
'end' => 9,
'sort' => null,
'direction' => null,
'limit' => null,
],
],
],
]);
$view = new View($request);
$paginator = new PaginatorHelper($view);
$result = $paginator->first();
$this->assertFalse($result);
$result = $paginator->last();
$this->assertFalse($result);
// Using below methods when SimplePaginator is used makes no practical sense.
// The asserts are just to ensure they return a reasonable value.
$result = $paginator->numbers();
$this->assertFalse($result);
$result = $paginator->hasNext();
$this->assertTrue($result);
$result = $paginator->counter();
// counter() sets `pageCount` to 1 if empty.
$this->assertEquals('1 of 1', $result);
$result = $paginator->total();
$this->assertSame(0, $result);
}
}