| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014 |
- <?php
- declare(strict_types=1);
- /**
- * CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
- * Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- *
- * Licensed under The MIT License
- * For full copyright and license information, please see the LICENSE.txt
- * Redistributions of files must retain the above copyright notice
- *
- * @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
- * @link https://cakephp.org CakePHP(tm) Project
- * @since 1.2.0
- * @license https://opensource.org/licenses/mit-license.php MIT License
- */
- namespace Cake\Test\TestCase\View\Helper;
- use Cake\Core\Configure;
- use Cake\Datasource\Paging\PaginatedResultSet;
- use Cake\Http\ServerRequest;
- use Cake\I18n\I18n;
- use Cake\ORM\ResultSet;
- use Cake\Routing\Router;
- use Cake\TestSuite\TestCase;
- use Cake\View\Helper\PaginatorHelper;
- use Cake\View\View;
- /**
- * PaginatorHelperTest class
- */
- class PaginatorHelperTest extends TestCase
- {
- /**
- * @var \Cake\View\View
- */
- protected $View;
- /**
- * @var \Cake\View\Helper\PaginatorHelper
- */
- protected $Paginator;
- /**
- * @var \Cake\Datasource\Paging\PaginatedResultSet
- */
- protected $paginatedResult;
- /**
- * setUp method
- */
- public function setUp(): void
- {
- parent::setUp();
- Configure::write('Config.language', 'eng');
- $request = new ServerRequest([
- 'url' => '/',
- 'params' => [
- 'plugin' => null,
- 'controller' => 'Articles',
- 'action' => 'index',
- ],
- ]);
- $this->paginatedResult = new PaginatedResultSet(new ResultSet([]), [
- 'alias' => 'Articles',
- 'currentPage' => 1,
- 'count' => 9,
- 'totalCount' => 62,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 7,
- ]);
- $this->View = new View($request, null, null, ['viewVars' => ['articles' => $this->paginatedResult]]);
- $this->Paginator = new PaginatorHelper($this->View);
- Router::reload();
- $builder = Router::createRouteBuilder('/');
- $builder->connect('/', ['controller' => 'Articles', 'action' => 'index']);
- $builder->connect('/{controller}/{action}/*');
- $builder->connect('/{plugin}/{controller}/{action}/*');
- Router::setRequest($request);
- }
- /**
- * tearDown method
- */
- public function tearDown(): void
- {
- parent::tearDown();
- unset($this->View, $this->Paginator);
- I18n::setLocale(I18n::getDefaultLocale());
- }
- protected function setPaginatedResult(array $params, bool $merge = true)
- {
- if ($merge) {
- $params += [
- 'alias' => 'Articles',
- 'currentPage' => 1,
- 'count' => 9,
- 'totalCount' => 62,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 7,
- ];
- }
- $this->paginatedResult = new PaginatedResultSet(new ResultSet([]), $params);
- $this->Paginator->setPaginated($this->paginatedResult);
- }
- /**
- * Test the templates method.
- */
- public function testTemplates(): void
- {
- $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->assertSame('val', $result['test']);
- $this->assertSame('val', $this->Paginator->getTemplates('test'));
- }
- /**
- * testHasPrevious method
- */
- public function testHasPrevious(): void
- {
- $this->assertFalse($this->Paginator->hasPrev());
- $this->setPaginatedResult([
- 'hasPrevPage' => true,
- ]);
- $this->assertTrue($this->Paginator->hasPrev());
- }
- /**
- * testHasNext method
- */
- public function testHasNext(): void
- {
- $this->assertTrue($this->Paginator->hasNext());
- $this->setPaginatedResult([
- 'hasNextPage' => false,
- ]);
- $this->assertFalse($this->Paginator->hasNext());
- }
- /**
- * testSortLinks method
- */
- public function testSortLinks(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 9,
- 'totalCount' => 62,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 7,
- 'sort' => 'date',
- 'direction' => 'asc',
- ], false);
- $this->Paginator->options(['url' => ['param']]);
- $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->setPaginatedResult([
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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);
- $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(): void
- {
- $result = $this->Paginator->sort('title', 'TestTitle >');
- $expected = [
- 'a' => ['href' => '/?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' => '/?sort=title&direction=asc'],
- 'TestTitle >',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test that sort() works with virtual field order options.
- */
- public function testSortLinkWithVirtualField(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'full_name',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'full_name',
- '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
- */
- public function testSortLinksUsingDirectionOption(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($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
- */
- public function testSortLinksUsingDotNotation(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- '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->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Account.title',
- '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
- */
- public function testSortLinksMultiplePagination(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'count' => 9,
- 'totalCount' => 62,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 7,
- 'sort' => 'date',
- 'direction' => 'asc',
- 'page' => 1,
- 'scope' => 'article',
- ], false);
- $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);
- $this->Paginator->setPaginated(new PaginatedResultSet(
- new ResultSet([]),
- [
- 'count' => 1,
- 'totalCount' => 100,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 5,
- 'sort' => 'tag',
- 'direction' => 'asc',
- 'page' => 1,
- 'scope' => 'tags',
- ]
- ));
- $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);
- }
- /**
- * testSortAdminLinks method
- */
- public function testSortAdminLinks(): void
- {
- Router::reload();
- Router::createRouteBuilder('/')->connect('/admin/{controller}/{action}/*', ['prefix' => 'Admin']);
- $request = new ServerRequest([
- 'url' => '/admin/users',
- 'params' => [
- 'plugin' => null, 'controller' => 'Users', 'action' => 'index', 'prefix' => 'Admin',
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 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
- */
- public function testDefaultSortAndNoSort(): void
- {
- $request = new ServerRequest([
- 'url' => '/articles/index',
- 'params' => [
- 'plugin' => null, 'controller' => 'Articles', 'action' => 'index',
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->View->setRequest($this->View->getRequest()->withAttribute('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' => '/?page=2'],
- 'Next',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * testUrlGeneration method
- */
- public function testUrlGeneration(): void
- {
- $result = $this->Paginator->sort('controller');
- $expected = [
- 'a' => ['href' => '/?sort=controller&direction=asc'],
- 'Controller',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->generateUrl();
- $this->assertSame('/', $result);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 2,
- ]);
- $result = $this->Paginator->generateUrl();
- $this->assertSame('/?page=2', $result);
- $options = ['sort' => 'Article', 'direction' => 'desc'];
- $result = $this->Paginator->generateUrl($options);
- $this->assertSame('/?sort=Article&direction=desc&page=2', $result);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 3,
- ]);
- $options = ['sort' => 'Article.name', 'direction' => 'desc'];
- $result = $this->Paginator->generateUrl($options);
- $this->assertSame('/?sort=Article.name&direction=desc&page=3', $result);
- $options = ['sort' => 'Article.name', 'direction' => 'desc'];
- $result = $this->Paginator->generateUrl($options, [], ['escape' => false]);
- $this->assertSame('/?sort=Article.name&direction=desc&page=3', $result);
- $options = ['sort' => 'Article.name', 'direction' => 'desc'];
- $result = $this->Paginator->generateUrl($options, [], ['fullBase' => true]);
- $this->assertSame('http://localhost/?sort=Article.name&direction=desc&page=3', $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): void
- {
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 2,
- 'sort' => 'name',
- '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 static function urlGenerationResetsToPage1Provider(): array
- {
- return [
- 'Sorting the field currently sorted asc, asc' => [
- 'name',
- ['sort' => 'name', 'direction' => 'asc'],
- '<a class="asc" href="/?sort=name&direction=asc">Name</a>',
- ],
- 'Sorting the field currently sorted asc, desc' => [
- 'name',
- ['sort' => 'name', 'direction' => 'desc'],
- '<a class="asc" href="/?sort=name&direction=desc">Name</a>',
- ],
- 'Sorting other asc' => [
- 'other',
- ['sort' => 'other', 'direction' => 'asc'],
- '<a href="/?sort=other&direction=asc">Other</a>',
- ],
- 'Sorting other desc' => [
- 'other',
- ['sort' => 'other', 'direction' => 'desc'],
- '<a href="/?sort=other&direction=desc">Other</a>',
- ],
- ];
- }
- /**
- * test URL generation with prefix routes
- */
- public function testGenerateUrlWithPrefixes(): void
- {
- Router::reload();
- $builder = Router::createRouteBuilder('/');
- $builder->connect('/members/{controller}/{action}/*', ['prefix' => 'Members']);
- $builder->connect('/{controller}/{action}/*');
- $request = new ServerRequest([
- 'url' => '/Posts/index',
- 'params' => [
- 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 2,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- ], false);
- $url = ['prefix' => 'Members'];
- $result = $this->Paginator->generateUrl([], $url);
- $expected = '/members/Posts/index?page=2';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->sort('name', null, ['url' => $url]);
- $expected = [
- 'a' => ['href' => '/members/Posts/index?sort=name&direction=asc'],
- 'Name',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->next('next', ['url' => $url]);
- $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' => $url]);
- $expected = [
- 'li' => ['class' => 'prev'],
- 'a' => ['href' => '/members/Posts/index', 'rel' => 'prev'],
- 'prev',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $options = ['sort' => 'name', 'direction' => 'desc'];
- $url = [
- 'prefix' => 'Members',
- 'controller' => 'Posts',
- ];
- $result = $this->Paginator->generateUrl($options, $url);
- $expected = '/members/Posts/index?sort=name&direction=desc&page=2';
- $this->assertSame($expected, $result);
- $options = ['sort' => 'Article.name', 'direction' => 'desc'];
- $url = ['controller' => 'Posts'];
- $result = $this->Paginator->generateUrl($options, $url);
- $expected = '/Posts/index?sort=Article.name&direction=desc&page=2';
- $this->assertSame($expected, $result);
- }
- /**
- * test URL generation can leave prefix routes
- */
- public function testGenerateUrlWithPrefixesLeavePrefix(): void
- {
- Router::reload();
- $builder = Router::createRouteBuilder('/');
- $builder->connect('/members/{controller}/{action}/*', ['prefix' => 'Members']);
- $builder->connect('/{controller}/{action}/*');
- $request = new ServerRequest([
- 'params' => [
- 'prefix' => 'Members',
- 'controller' => 'Posts',
- 'action' => 'index',
- 'plugin' => null,
- ],
- 'webroot' => '/',
- ]);
- $request = $request->withAttribute('paging', ['Article' => ['page' => 2, 'prevPage' => true]]);
- Router::setRequest($request);
- $this->View->setRequest($request);
- $this->setPaginatedResult([
- 'currentPage' => 2,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- ]);
- $result = $this->Paginator->generateUrl();
- $expected = '/members/Posts/index?page=2';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->generateUrl([], ['prefix' => 'Members']);
- $expected = '/members/Posts/index?page=2';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->generateUrl([], ['prefix' => false]);
- $expected = '/Posts/index?page=2';
- $this->assertSame($expected, $result);
- $this->Paginator->options(['url' => ['prefix' => false]]);
- $result = $this->Paginator->generateUrl();
- $this->assertSame($expected, $result, 'Setting prefix in options should work too.');
- }
- /**
- * test generateUrl with multiple pagination
- */
- public function testGenerateUrlMultiplePagination(): void
- {
- $request = new ServerRequest([
- 'url' => '/Posts/index',
- 'params' => [
- 'plugin' => null, 'controller' => 'Posts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'scope' => 'article',
- 'currentPage' => 3,
- 'hasPrevPage' => true,
- ]);
- $result = $this->Paginator->generateUrl([]);
- $expected = '/Posts/index?article%5Bpage%5D=3';
- $this->assertSame($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%5Bsort%5D=name&article%5Bpage%5D=3';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->generateUrl([], ['#' => 'foo']);
- $expected = '/Posts/index?article%5Bpage%5D=3#foo';
- $this->assertSame($expected, $result);
- }
- /**
- * test generateUrl with multiple pagination and query string values
- */
- public function testGenerateUrlMultiplePaginationQueryStringData(): void
- {
- $request = new ServerRequest([
- 'url' => '/Posts/index',
- 'params' => [
- 'plugin' => null, 'controller' => 'Posts', 'action' => 'index',
- ],
- 'query' => [
- 'article' => [
- 'puppy' => 'no',
- ],
- ],
- ]);
- Router::setRequest($request);
- $paginatedResult = new PaginatedResultSet(new ResultSet([]), [
- 'alias' => 'Article',
- 'scope' => 'article',
- 'currentPage' => 3,
- 'hasPrevPage' => true,
- ]);
- $this->View->setRequest($request);
- // Need to run __construct to update _config['url']
- $paginator = new PaginatorHelper($this->View);
- $paginator->setPaginated($paginatedResult);
- $result = $paginator->generateUrl(['sort' => 'name']);
- $expected = '/Posts/index?article%5Bsort%5D=name&article%5Bpage%5D=3&article%5Bpuppy%5D=no';
- $this->assertSame($expected, $result);
- $result = $paginator->generateUrl([]);
- $expected = '/Posts/index?article%5Bpage%5D=3&article%5Bpuppy%5D=no';
- $this->assertSame($expected, $result);
- }
- /**
- * testPassedArgsMergingWithUrlOptions method
- */
- public function testPassedArgsMergingWithUrlOptions(): void
- {
- $request = new ServerRequest([
- 'url' => '/articles/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Articles', 'action' => 'index', 'pass' => [2],
- ],
- 'query' => ['page' => 1, 'foo' => 'bar', 'x' => 'y', 'num' => 0],
- ]);
- $this->setPaginatedResult([
- 'currentPage' => 1, 'count' => 3, 'totalCount' => 13,
- 'hasPrevPage' => false, 'hasNextPage' => true, 'pageCount' => 8,
- 'sort' => null, 'direction' => null,
- ]);
- $this->View->setRequest($request);
- $this->Paginator = new PaginatorHelper($this->View);
- $this->Paginator->setPaginated($this->paginatedResult);
- $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=""', '1', '/a', '/li',
- ['li' => []], ['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
- */
- public function testDefaultSortRemovedFromUrl(): void
- {
- $request = new ServerRequest([
- 'url' => '/Articles/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Articles', 'action' => 'index',
- ],
- ]);
- Router::setRequest($request);
- $this->View->setRequest($this->View->getRequest()->withAttribute('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' => '/?page=2'],
- 'Next',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Tests that generated default order URL doesn't include sort and direction parameters.
- */
- public function testDefaultSortRemovedFromUrlWithAliases(): void
- {
- $request = new ServerRequest([
- 'params' => ['controller' => 'Articles', 'action' => 'index', 'plugin' => null],
- 'url' => '/Articles?sort=title&direction=asc',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 3,
- 'totalCount' => 13,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 8,
- 'alias' => 'Articles',
- 'sort' => 'Articles.title', 'direction' => 'asc',
- 'sortDefault' => 'Articles.title', 'directionDefault' => 'desc',
- ], false);
- $result = $this->Paginator->sort('title');
- $expected = [
- 'a' => ['class' => 'asc', 'href' => '/'],
- 'Title',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Test the prev() method.
- */
- public function testPrev(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 3,
- 'totalCount' => 13,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 5,
- ], false);
- $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->assertSame('', $result, 'disabled + no text = no link');
- $this->setPaginatedResult([
- 'currentPage' => 2,
- 'hasPrevPage' => true,
- ], false);
- $result = $this->Paginator->prev('<< Previous');
- $expected = [
- 'li' => ['class' => 'prev'],
- 'a' => ['href' => '/', 'rel' => 'prev'],
- '<< Previous',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->prev('Prev', [
- 'templates' => [
- 'prevActive' => '<a rel="prev" href="{{url}}">{{text}}</a>',
- ],
- ]);
- $expected = [
- 'a' => ['href' => '/', 'rel' => 'prev'],
- 'Prev',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Test that prev() and the shared implementation underneath picks up from options
- */
- public function testPrevWithOptions(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 2,
- 'count' => 1,
- 'totalCount' => 13,
- 'hasPrevPage' => true,
- 'hasNextPage' => false,
- 'pageCount' => 2,
- 'limit' => 10,
- ], false);
- $this->Paginator->options(['url' => [12, 'page' => 3]]);
- $result = $this->Paginator->prev('Prev', ['url' => ['?' => ['foo' => 'bar']]]);
- $expected = [
- 'li' => ['class' => 'prev'],
- 'a' => ['href' => '/Articles/index/12?foo=bar&limit=10', 'rel' => 'prev'],
- 'Prev',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test the next() method.
- */
- public function testNext(): void
- {
- $result = $this->Paginator->next('Next >>');
- $expected = [
- 'li' => ['class' => 'next'],
- 'a' => ['href' => '/?page=2', 'rel' => 'next'],
- 'Next >>',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->next('Next', [
- 'templates' => [
- 'nextActive' => '<a rel="next" href="{{url}}">{{text}}</a>',
- ],
- ]);
- $expected = [
- 'a' => ['href' => '/?page=2', 'rel' => 'next'],
- 'Next',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->next('Next >>', ['escape' => false]);
- $expected = [
- 'li' => ['class' => 'next'],
- 'a' => ['href' => '/?page=2', 'rel' => 'next'],
- 'preg:/Next >>/',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test next() with disabled links
- */
- public function testNextDisabled(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 5,
- 'count' => 3,
- 'totalCount' => 13,
- 'hasPrevPage' => true,
- 'hasNextPage' => false,
- 'pageCount' => 5,
- ], false);
- $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->assertSame('', $result, 'disabled + no text = no link');
- }
- /**
- * testNumbers method
- */
- public function testNumbers(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 8,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers();
- $expected = [
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['first' => 'first', 'last' => 'last']);
- $expected = [
- ['li' => ['class' => 'first']], ['a' => ['href' => '/']], 'first', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => ['class' => 'last']], ['a' => ['href' => '/?page=15']], 'last', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['first' => '2', 'last' => '8']);
- $expected = [
- ['li' => ['class' => 'first']], ['a' => ['href' => '/']], '2', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => ['class' => 'last']], ['a' => ['href' => '/?page=15']], '8', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['first' => '8', 'last' => '8']);
- $expected = [
- ['li' => ['class' => 'first']], ['a' => ['href' => '/']], '8', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => ['class' => 'last']], ['a' => ['href' => '/?page=15']], '8', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers();
- $expected = [
- ['li' => ['class' => 'active']], '<a href=""', '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 14,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers();
- $expected = [
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=13']], '13', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '14', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=15']], '15', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 2,
- 'count' => 3,
- 'totalCount' => 27,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 9,
- ], false);
- $result = $this->Paginator->numbers(['first' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['last' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 15,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers(['first' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=13']], '13', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=14']], '14', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '15', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 10,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12']], '12', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=13']], '13', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=14']], '14', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=15']], '15', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 6,
- 'count' => 15,
- 'totalCount' => 623,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 42,
- ], false);
- $result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=8']], '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10']], '10', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=42']], '42', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 37,
- 'count' => 15,
- 'totalCount' => 623,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 42,
- ], false);
- $result = $this->Paginator->numbers(['first' => 1, 'last' => 1]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=33']], '33', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=34']], '34', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=35']], '35', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=36']], '36', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '37', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=38']], '38', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=39']], '39', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=40']], '40', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=41']], '41', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=42']], '42', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Test for URLs with paging params as route placeholders instead of query string params.
- */
- public function testRoutePlaceholder(): void
- {
- Router::reload();
- Router::createRouteBuilder('/')->connect('/{controller}/{action}/{page}');
- $request = $this->View
- ->getRequest()
- ->withAttribute('params', [
- 'plugin' => null,
- 'controller' => 'Clients',
- 'action' => 'index',
- ]);
- $this->View->setRequest($request);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'currentPage' => 8,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $this->Paginator->options(['routePlaceholders' => ['page']]);
- $result = $this->Paginator->numbers();
- $expected = [
- ['li' => []], ['a' => ['href' => '/Clients/index/4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/7']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/9']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/10']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/11']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index/12']], '12', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- Router::reload();
- Router::createRouteBuilder('/')->connect('/{controller}/{action}/{sort}/{direction}');
- Router::setRequest($request);
- $this->Paginator->options(['routePlaceholders' => ['sort', 'direction']]);
- $result = $this->Paginator->sort('title');
- $expected = [
- 'a' => ['href' => '/Clients/index/title/asc'],
- 'Title',
- '/a',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * testNumbersPages method
- */
- public function testNumbersMulti(): void
- {
- $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 => '<F ... 4 5 6 7 *8 9 10 11 12 ',
- 9 => '<F ... 5 6 7 8 *9 10 11 12 13 ',
- 10 => '<F ... 6 7 8 9 *10 11 12 13 14 ',
- 15 => '<F ... 11 12 13 14 *15 16 17 18 19 ',
- 16 => '<F ... 12 13 14 15 *16 17 18 19 20 ',
- 17 => '<F ... 12 13 14 15 16 *17 18 19 20 ',
- 18 => '<F ... 12 13 14 15 16 17 *18 19 20 ',
- 19 => '<F ... 12 13 14 15 16 17 18 *19 20 ',
- 20 => '<F ... 12 13 14 15 16 17 18 19 *20 ',
- ];
- $result = $this->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 => '<F ... 4 5 6 7 *8 9 10 11 12 ... L> ',
- 9 => '<F ... 5 6 7 8 *9 10 11 12 13 ... L> ',
- 10 => '<F ... 6 7 8 9 *10 11 12 13 14 ... L> ',
- 11 => '<F ... 7 8 9 10 *11 12 13 14 15 ... L> ',
- 12 => '<F ... 8 9 10 11 *12 13 14 15 16 ... L> ',
- 13 => '<F ... 9 10 11 12 *13 14 15 16 17 ... L> ',
- 14 => '<F ... 10 11 12 13 *14 15 16 17 18 19 20 ',
- 15 => '<F ... 11 12 13 14 *15 16 17 18 19 20 ',
- 16 => '<F ... 12 13 14 15 *16 17 18 19 20 ',
- 17 => '<F ... 12 13 14 15 16 *17 18 19 20 ',
- 18 => '<F ... 12 13 14 15 16 17 *18 19 20 ',
- 19 => '<F ... 12 13 14 15 16 17 18 *19 20 ',
- 20 => '<F ... 12 13 14 15 16 17 18 19 *20 ',
- ];
- $result = $this->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 = []): array
- {
- $options['templates'] = [
- 'first' => '<{{text}} ',
- 'last' => '{{text}}> ',
- 'number' => '{{text}} ',
- 'current' => '*{{text}} ',
- 'ellipsis' => '... ',
- ];
- $params = [
- 'currentPage' => 1,
- 'pageCount' => $pageCount,
- ];
- $result = [];
- foreach ($pagesToCheck as $page) {
- $params['currentPage'] = $page;
- $this->setPaginatedResult($params, false);
- $result[$page] = $this->Paginator->numbers($options);
- }
- return $result;
- }
- /**
- * Test that numbers() lets you overwrite templates.
- *
- * The templates file has no li elements.
- */
- public function testNumbersTemplates(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 8,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers(['templates' => 'htmlhelper_tags']);
- $expected = [
- ['a' => ['href' => '/?page=4']], '4', '/a',
- ['a' => ['href' => '/?page=5']], '5', '/a',
- ['a' => ['href' => '/?page=6']], '6', '/a',
- ['a' => ['href' => '/?page=7']], '7', '/a',
- 'span' => ['class' => 'active'], '8', '/span',
- ['a' => ['href' => '/?page=9']], '9', '/a',
- ['a' => ['href' => '/?page=10']], '10', '/a',
- ['a' => ['href' => '/?page=11']], '11', '/a',
- ['a' => ['href' => '/?page=12']], '12', '/a',
- ];
- $this->assertHtml($expected, $result);
- $this->assertStringContainsString(
- '<li',
- $this->Paginator->templater()->get('current'),
- 'Templates were not restored.'
- );
- }
- /**
- * Test modulus option for numbers()
- */
- public function testNumbersModulus(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 10,
- 'totalCount' => 30,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 3,
- ]);
- $this->Paginator->setTemplates([
- 'current' => '<li class="active"><a href="{{url}}">{{text}}</a></li>',
- ]);
- $result = $this->Paginator->numbers(['modulus' => 10]);
- $expected = [
- ['li' => ['class' => 'active']], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['modulus' => 3]);
- $expected = [
- ['li' => ['class' => 'active']], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 4895,
- 'count' => 10,
- 'totalCount' => 48962,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 4897,
- ], false);
- $result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4894']], '4,894', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=4895']], '4,895', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 3,
- 'pageCount' => 4897,
- ], false);
- $result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['first' => 5, 'modulus' => 5, 'last' => 5]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4893']], '4,893', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4894']], '4,894', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4895']], '4,895', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 4893,
- 'pageCount' => 4897,
- ]);
- $result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4891']], '4,891', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4892']], '4,892', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=4893']], '4,893', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4894']], '4,894', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4895']], '4,895', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 58,
- 'pageCount' => 4897,
- ]);
- $result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=56']], '56', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=57']], '57', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=58']], '58', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=59']], '59', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=60']], '60', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4893']], '4,893', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4894']], '4,894', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4895']], '4,895', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 5,
- 'pageCount' => 4897,
- ]);
- $result = $this->Paginator->numbers(['first' => 5, 'modulus' => 4, 'last' => 5]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7']], '7', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4893']], '4,893', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4894']], '4,894', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4895']], '4,895', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 3,
- 'pageCount' => 4897,
- ]);
- $result = $this->Paginator->numbers(['first' => 2, 'modulus' => 2, 'last' => 2]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4']], '4', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->numbers(['first' => 2, 'modulus' => 0, 'last' => 2]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Test modulus option for numbers()
- */
- public function testNumbersModulusMulti(): void
- {
- $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 => '<F ... 4 5 *6 7 ',
- 7 => '<F ... 4 5 6 *7 ',
- ];
- $result = $this->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.
- */
- public function testModulusDisabled(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 4,
- 'count' => 2,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 6,
- ], false);
- $result = $this->Paginator->numbers(['modulus' => false]);
- $expected = [
- ['li' => []], '<a href="/"', '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=2']], '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=3']], '3', '/a', '/li',
- ['li' => ['class' => 'active']], ['a' => ['href' => '']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6']], '6', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * Test that numbers() with url options.
- */
- public function testNumbersWithUrlOptions(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 8,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 15,
- ], false);
- $result = $this->Paginator->numbers(['url' => ['#' => 'foo']]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/?page=4#foo']], '4', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=5#foo']], '5', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=6#foo']], '6', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=7#foo']], '7', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '8', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=9#foo']], '9', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=10#foo']], '10', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=11#foo']], '11', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?page=12#foo']], '12', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- $this->setPaginatedResult([
- 'currentPage' => 3,
- 'count' => 10,
- 'totalCount' => 48962,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 4897,
- ], false);
- $result = $this->Paginator->numbers([
- 'first' => 2,
- 'modulus' => 2,
- 'last' => 2,
- 'url' => ['?' => ['foo' => 'bar']]]);
- $expected = [
- ['li' => []], ['a' => ['href' => '/?foo=bar']], '1', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?foo=bar&page=2']], '2', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '3', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?foo=bar&page=4']], '4', '/a', '/li',
- ['li' => ['class' => 'ellipsis']], '…', '/li',
- ['li' => []], ['a' => ['href' => '/?foo=bar&page=4896']], '4,896', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/?foo=bar&page=4897']], '4,897', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test numbers() with routing parameters.
- */
- public function testNumbersRouting(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 2,
- 'count' => 2,
- 'totalCount' => 30,
- 'hasPrevPage' => true,
- 'hasNextPage' => true,
- 'pageCount' => 3,
- ], false);
- $request = new ServerRequest([
- 'params' => ['controller' => 'Clients', 'action' => 'index', 'plugin' => null],
- 'url' => '/Clients/index/?page=2',
- ]);
- Router::setRequest($request);
- $result = $this->Paginator->numbers();
- $expected = [
- ['li' => []], ['a' => ['href' => '/Clients/index']], '1', '/a', '/li',
- ['li' => ['class' => 'active']], '<a href=""', '2', '/a', '/li',
- ['li' => []], ['a' => ['href' => '/Clients/index?page=3']], '3', '/a', '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test first() and last() with tag options
- */
- public function testFirstAndLastTag(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 2,
- ]);
- $result = $this->Paginator->first('<<');
- $expected = [
- 'li' => ['class' => 'first'],
- 'a' => ['href' => '/'],
- '<<',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->first('5');
- $expected = [
- 'li' => ['class' => 'first'],
- 'a' => ['href' => '/'],
- '5',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last(2);
- $expected = [
- '<li',
- ['a' => ['href' => '/?page=6']], '6', '/a',
- '/li',
- '<li',
- ['a' => ['href' => '/?page=7']], '7', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last('9');
- $expected = [
- 'li' => ['class' => 'last'],
- 'a' => ['href' => '/?page=7'],
- '9',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->first('first', ['url' => ['action' => 'paged']]);
- $expected = [
- 'li' => ['class' => 'first'],
- 'a' => ['href' => '/Articles/paged'],
- 'first',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test that on the last page you don't get a link ot the last page.
- */
- public function testLastNoOutput(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 15,
- 'pageCount' => 15,
- ]);
- $result = $this->Paginator->last();
- $expected = '';
- $this->assertSame($expected, $result);
- }
- /**
- * test first() on the first page.
- */
- public function testFirstEmpty(): void
- {
- $this->View->setRequest($this->View->getRequest()->withParam('paging.Article.page', 1));
- $result = $this->Paginator->first();
- $expected = '';
- $this->assertSame($expected, $result);
- }
- /**
- * test first() and options()
- */
- public function testFirstFullBaseUrl(): void
- {
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'currentPage' => 3,
- 'pageCount' => 4,
- 'hasPrevPage' => true,
- 'sort' => 'Article.title',
- 'direction' => 'DESC',
- ]);
- $this->Paginator->options(['url' => ['_full' => true, '#' => 'foo']]);
- $result = $this->Paginator->first();
- $expected = [
- 'li' => ['class' => 'first'],
- ['a' => [
- 'href' => Configure::read('App.fullBaseUrl') . '/?sort=Article.title&direction=DESC#foo',
- ]],
- '<< first',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test first() on the fence-post
- */
- public function testFirstBoundaries(): void
- {
- $params = $this->Paginator->params();
- $params['currentPage'] = 3;
- $this->setPaginatedResult($params, false);
- $result = $this->Paginator->first();
- $expected = [
- 'li' => ['class' => 'first'],
- 'a' => ['href' => '/'],
- '<< first',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->first(2);
- $expected = [
- '<li',
- ['a' => ['href' => '/']], '1', '/a',
- '/li',
- '<li',
- ['a' => ['href' => '/?page=2']], '2', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $params = $this->Paginator->params();
- $params['currentPage'] = 2;
- $this->setPaginatedResult($params, false);
- $result = $this->Paginator->first(3);
- $this->assertSame('', $result, 'When inside the first links range, no links should be made');
- }
- /**
- * test params() method
- */
- public function testParams(): void
- {
- $result = $this->Paginator->params();
- $this->assertArrayHasKey('currentPage', $result);
- $this->assertArrayHasKey('pageCount', $result);
- }
- /**
- * test param() method
- */
- public function testParam(): void
- {
- $result = $this->Paginator->param('totalCount');
- $this->assertSame(62, $result);
- $result = $this->Paginator->param('imaginary');
- $this->assertNull($result);
- }
- /**
- * test last() method
- */
- public function testLast(): void
- {
- $result = $this->Paginator->last();
- $expected = [
- 'li' => ['class' => 'last'],
- 'a' => ['href' => '/?page=7'],
- 'last >>',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last(1);
- $expected = [
- '<li',
- 'a' => ['href' => '/?page=7'],
- '7',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $params = $this->Paginator->params();
- $params['currentPage'] = 6;
- $this->setPaginatedResult($params, false);
- $result = $this->Paginator->last(2);
- $expected = [
- '<li',
- ['a' => ['href' => '/?page=6']], '6', '/a',
- '/li',
- '<li',
- ['a' => ['href' => '/?page=7']], '7', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last(3);
- $this->assertSame('', $result, 'When inside the last links range, no links should be made');
- $result = $this->Paginator->last('lastest', ['url' => ['action' => 'paged']]);
- $expected = [
- 'li' => ['class' => 'last'],
- 'a' => ['href' => '/Articles/paged?page=7'],
- 'lastest',
- '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * test the options for last()
- */
- public function testLastOptions(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 4,
- 'count' => 3,
- 'totalCount' => 30,
- 'hasPrevPage' => false,
- 'hasNextPage' => 2,
- 'pageCount' => 15,
- 'sort' => 'Client.name',
- 'direction' => 'DESC',
- ]);
- $result = $this->Paginator->last();
- $expected = [
- 'li' => ['class' => 'last'],
- 'a' => [
- 'href' => '/?page=15&sort=Client.name&direction=DESC',
- ],
- 'last >>', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last(1);
- $expected = [
- '<li',
- ['a' => ['href' => '/?page=15&sort=Client.name&direction=DESC']], '15', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- $result = $this->Paginator->last(2);
- $expected = [
- '<li',
- ['a' => ['href' => '/?page=14&sort=Client.name&direction=DESC']], '14', '/a',
- '/li',
- '<li',
- ['a' => ['href' => '/?page=15&sort=Client.name&direction=DESC']], '15', '/a',
- '/li',
- ];
- $this->assertHtml($expected, $result);
- }
- /**
- * testCounter method
- */
- public function testCounter(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 3,
- 'totalCount' => 13,
- 'perPage' => 3,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 5,
- 'limit' => 3,
- 'sort' => 'Client.name',
- 'order' => 'DESC',
- 'start' => 1,
- 'end' => 3,
- 'alias' => 'Client',
- ], false);
- $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->assertSame($expected, $result);
- $result = $this->Paginator->counter('pages');
- $expected = '1 of 5';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->counter('range');
- $expected = '1 - 3 of 13';
- $this->assertSame($expected, $result);
- $result = $this->Paginator->counter('Showing {{page}} of {{pages}} {{model}}');
- $this->assertSame('Showing 1 of 5 clients', $result);
- }
- /**
- * Tests that numbers are formatted according to the locale when using counter()
- */
- public function testCounterBigNumbers(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 1523,
- 'count' => 3000,
- 'totalCount' => 4800001,
- 'perPage' => 3000,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 1600,
- 'limit' => 5000,
- 'sort' => 'Client.name',
- 'order' => 'DESC',
- 'start' => 4566001,
- 'end' => 4569001,
- 'alias' => 'Client',
- ], false);
- $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->assertSame($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->assertSame($expected, $result);
- }
- /**
- * testHasPage method
- */
- public function testHasPage(): void
- {
- $result = $this->Paginator->hasPage(15);
- $this->assertFalse($result);
- $result = $this->Paginator->hasPage(2);
- $this->assertTrue($result);
- }
- /**
- * testNextLinkUsingDotNotation method
- */
- public function testNextLinkUsingDotNotation(): void
- {
- $request = new ServerRequest([
- 'url' => '/Accounts/index',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index',
- ],
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'alias' => 'Article',
- 'sort' => 'Article.title',
- 'direction' => 'asc',
- 'currentPage' => 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
- */
- public function testCurrent(): void
- {
- $result = $this->Paginator->current();
- $params = $this->Paginator->params();
- $this->assertSame($params['currentPage'], $result);
- }
- /**
- * test the total() method
- */
- public function testTotal(): void
- {
- $result = $this->Paginator->total();
- $params = $this->Paginator->params();
- $this->assertSame($params['pageCount'], $result);
- }
- /**
- * test the numbers() method when there is only one page
- */
- public function testWithOnePage(): void
- {
- $this->setPaginatedResult([
- 'currentPage' => 1,
- 'count' => 2,
- 'totalCount' => 2,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 1,
- ], false);
- $this->assertSame('', $this->Paginator->numbers());
- $this->assertSame('', $this->Paginator->first());
- $this->assertSame('', $this->Paginator->last());
- }
- /**
- * Test data for meta()
- *
- * @return array
- */
- public static function dataMetaProvider(): array
- {
- 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], '<link href="http://localhost/?foo=bar" rel="first">' .
- '<link href="http://localhost/?foo=bar" rel="last">'],
- // Verifies that first page is created for single page results.
- [1, false, false, 1, ['first' => true], '<link href="http://localhost/?foo=bar" rel="first">'],
- // Verifies that last page is created for single page results.
- [1, false, false, 1, ['last' => true], '<link href="http://localhost/?foo=bar" rel="last">'],
- // Verifies that page 1 only has a next link.
- [1, false, true, 2, [], '<link href="http://localhost/?foo=bar&page=2" rel="next">'],
- // Verifies that page 1 only has next, first and last link.
- [1, false, true, 2, ['first' => true, 'last' => true], '<link href="http://localhost/?foo=bar&page=2" rel="next">' .
- '<link href="http://localhost/?foo=bar" rel="first">' .
- '<link href="http://localhost/?foo=bar&page=2" rel="last">'],
- // Verifies that page 1 only has next and first link.
- [1, false, true, 2, ['first' => true], '<link href="http://localhost/?foo=bar&page=2" rel="next">' .
- '<link href="http://localhost/?foo=bar" rel="first">'],
- // Verifies that page 1 only has next and last link.
- [1, false, true, 2, ['last' => true], '<link href="http://localhost/?foo=bar&page=2" rel="next">' .
- '<link href="http://localhost/?foo=bar&page=2" rel="last">'],
- // Verifies that the last page only has a prev link.
- [2, true, false, 2, [], '<link href="http://localhost/?foo=bar" rel="prev">'],
- // Verifies that the last page only has a prev, first and last link.
- [2, true, false, 2, ['first' => true, 'last' => true], '<link href="http://localhost/?foo=bar" rel="prev">' .
- '<link href="http://localhost/?foo=bar" rel="first">' .
- '<link href="http://localhost/?foo=bar&page=2" rel="last">'],
- // Verifies that a page in the middle has both links.
- [5, true, true, 10, [], '<link href="http://localhost/?foo=bar&page=4" rel="prev">' .
- '<link href="http://localhost/?foo=bar&page=6" rel="next">'],
- // Verifies that a page in the middle has both links.
- [5, true, true, 10, ['first' => true, 'last' => true], '<link href="http://localhost/?foo=bar&page=4" rel="prev">' .
- '<link href="http://localhost/?foo=bar&page=6" rel="next">' .
- '<link href="http://localhost/?foo=bar" rel="first">' .
- '<link href="http://localhost/?foo=bar&page=10" rel="last">'],
- ];
- }
- /**
- * @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): void
- {
- $this->setPaginatedResult([
- 'currentPage' => $page,
- 'hasPrevPage' => $prevPage,
- 'hasNextPage' => $nextPage,
- 'pageCount' => $pageCount,
- ], false);
- $this->Paginator->options(['url' => ['?' => ['foo' => 'bar']]]);
- $result = $this->Paginator->meta($options);
- $this->assertSame($expected, $result);
- $this->assertSame('', $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
- */
- public function testLimitControl(): void
- {
- $this->setPaginatedResult(['perPage' => 10]);
- $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() with a request url and query.
- *
- * @return void
- */
- public function testLimitControlUrlWithQuery()
- {
- $request = new ServerRequest([
- 'url' => '/batches?owner=billy&expected=1',
- 'params' => [
- 'plugin' => null, 'controller' => 'Batches', 'action' => 'index', 'pass' => [],
- ],
- 'query' => ['owner' => 'billy', 'expected' => 1],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->View->setRequest($request);
- $this->setPaginatedResult(['perPage' => 10]);
- $out = $this->Paginator->limitControl([1 => 1]);
- $expected = [
- ['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/batches?owner=billy&expected=1']],
- ['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);
- }
- /**
- * test the limitControl() method with defaults and query
- */
- public function testLimitControlQuery(): void
- {
- $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 the limitControl() method with scope
- */
- public function testLimitControlWithScope(): void
- {
- $request = new ServerRequest([
- 'url' => '/accounts/',
- 'params' => [
- 'plugin' => null, 'controller' => 'Accounts', 'action' => 'index', 'pass' => [],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->setPaginatedResult([
- 'perPage' => 25,
- 'count' => 9,
- 'totalCount' => 62,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => 7,
- 'sort' => 'date',
- 'direction' => 'asc',
- 'page' => 1,
- 'scope' => 'article',
- ], false);
- $out = $this->Paginator->limitControl([25 => 25, 50 => 50]);
- $expected = [
- ['form' => ['method' => 'get', 'accept-charset' => 'utf-8', 'action' => '/']],
- ['div' => ['class' => 'input select']],
- ['label' => ['for' => 'article-limit']],
- 'View',
- '/label',
- ['select' => ['name' => 'article[limit]', 'id' => 'article-limit', 'onChange' => 'this.form.submit()']],
- ['option' => ['value' => '25', 'selected' => 'selected']],
- '25',
- '/option',
- ['option' => ['value' => '50']],
- '50',
- '/option',
- '/select',
- '/div',
- '/form',
- ];
- $this->assertHtml($expected, $out);
- }
- /**
- * Test using paging params set by SimplePaginator which doesn't do count query.
- */
- public function testMethodsWhenThereIsNoPageCount(): void
- {
- $request = new ServerRequest([
- 'url' => '/',
- ]);
- $view = new View($request);
- $paginator = new PaginatorHelper($view);
- $paginator->setPaginated(new PaginatedResultSet(new ResultSet([]), [
- 'currentPage' => 1,
- 'count' => 9,
- 'totalCount' => null,
- 'hasPrevPage' => false,
- 'hasNextPage' => true,
- 'pageCount' => null,
- 'start' => 1,
- 'end' => 9,
- 'sort' => null,
- 'direction' => null,
- 'limit' => null,
- ]));
- $result = $paginator->first();
- $this->assertSame('', $result);
- $result = $paginator->last();
- $this->assertSame('', $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->assertSame('', $result);
- $result = $paginator->hasNext();
- $this->assertTrue($result);
- $result = $paginator->counter();
- // counter() sets `pageCount` to 1 if empty.
- $this->assertSame('1 of 1', $result);
- $result = $paginator->total();
- $this->assertNull($result);
- }
- /**
- * Test that generates a URL that keeps the passed parameters
- */
- public function testPaginationWithPassedParams(): void
- {
- $request = new ServerRequest([
- 'url' => '/articles/index/whatever/3',
- 'params' => [
- 'plugin' => null,
- 'controller' => 'Articles',
- 'action' => 'index',
- 'pass' => ['whatever', '3'],
- ],
- 'base' => '',
- 'webroot' => '/',
- ]);
- Router::setRequest($request);
- $this->View->setRequest($request->withAttribute('paging', [
- 'Article' => [
- 'scope' => 'article',
- ],
- ]));
- $this->Paginator = new PaginatorHelper($this->View);
- $this->Paginator->setPaginated($this->paginatedResult, ['paging' => ['scope' => 'article']]);
- $result = $this->Paginator->generateUrl(['page' => 2]);
- $expected = '/Articles/index/whatever/3?article%5Bpage%5D=2';
- $this->assertSame($expected, $result);
- }
- }
|