QueryResultPaginatorTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
namespace ‪TYPO3\CMS\Extbase\Tests\Functional\Pagination;
 
use ‪ExtbaseTeam\BlogExample\Domain\Repository\PostRepository;
use ‪TYPO3\CMS\Core\Utility\GeneralUtility;
use ‪TYPO3\CMS\Extbase\Object\ObjectManager;
use ‪TYPO3\CMS\Extbase\Pagination\QueryResultPaginator;
use TYPO3\TestingFramework\Core\Functional\FunctionalTestCase;
 
class ‪QueryResultPaginatorTest extends FunctionalTestCase
{
    protected ‪$coreExtensionsToLoad = ['extbase', 'fluid'];
 
    protected ‪$testExtensionsToLoad = ['typo3/sysext/extbase/Tests/Functional/Fixtures/Extensions/blog_example'];
 
    protected ‪$postRepository;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
 
        $this->importDataSet(ORIGINAL_ROOT . 'typo3/sysext/extbase/Tests/Functional/Persistence/Fixtures/posts.xml');
 
        $objectManager = GeneralUtility::makeInstance(ObjectManager::class);
        $this->postRepository = $objectManager->get(PostRepository::class);
    }
 
    public function ‪integration()
    {
        $queryResult = $this->postRepository->findAll();
        self::assertCount(14, $queryResult);
    }
 
    public function ‪checkPaginatorWithDefaultConfiguration()
    {
        $paginator = new ‪QueryResultPaginator($this->postRepository->findAll());
 
        self::assertSame(2, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(9, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(10, $paginator->getPaginatedItems());
    }
 
    public function ‪paginatorRespectsItemsPerPageConfiguration()
    {
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            1,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(2, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(3, $paginator->getPaginatedItems());
    }
 
    public function ‪paginatorRespectsItemsPerPageConfigurationAndCurrentPage()
    {
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            3,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(6, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(8, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(3, $paginator->getPaginatedItems());
    }
 
    public function ‪paginatorProperlyCalculatesLastPage()
    {
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            5,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(12, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(13, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(2, $paginator->getPaginatedItems());
    }
 
    public function ‪withCurrentPageNumberThrowsInvalidArgumentExceptionIfCurrentPageIsLowerThanOne()
    {
        static::expectExceptionCode(1573047338);
 
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            1,
            3
        );
        $paginator->withCurrentPageNumber(0);
    }
 
    public function ‪paginatorSetsCurrentPageToLastPageIfCurrentPageExceedsMaximum(): void
    {
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            3,
            10
        );
 
        self::assertEquals(2, $paginator->getCurrentPageNumber());
        self::assertEquals(2, $paginator->getNumberOfPages());
        self::assertCount(4, $paginator->getPaginatedItems());
    }
 
    public function ‪paginatorProperlyCalculatesOnlyOnePage()
    {
        $paginator = new ‪QueryResultPaginator(
            $this->postRepository->findAll(),
            1,
            50
        );
 
        self::assertSame(1, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(13, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(14, $paginator->getPaginatedItems());
    }
}