ArrayPaginatorTest.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\Core\Tests\Unit\Pagination;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Pagination\ArrayPaginator;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪ArrayPaginatorTest extends UnitTestCase
{
    protected array ‪$fixture = [];
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->fixture = range(1, 14, 1);
    }
 
    #[Test]
    public function ‪integration(): void
    {
        self::assertCount(14, $this->fixture);
    }
 
    #[Test]
    public function ‪checkPaginatorWithDefaultConfiguration(): void
    {
        $paginator = new ‪ArrayPaginator($this->fixture);
 
        self::assertSame(2, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(9, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(10, $paginator->getPaginatedItems());
    }
 
    #[Test]
    public function ‪paginatorRespectsItemsPerPageConfiguration(): void
    {
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            1,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(2, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(3, $paginator->getPaginatedItems());
    }
 
    #[Test]
    public function ‪paginatorRespectsItemsPerPageConfigurationAndCurrentPage(): void
    {
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            3,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(6, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(8, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(3, $paginator->getPaginatedItems());
    }
 
    #[Test]
    public function ‪paginatorProperlyCalculatesLastPage(): void
    {
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            5,
            3
        );
 
        self::assertSame(5, $paginator->getNumberOfPages());
        self::assertSame(12, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(13, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(2, $paginator->getPaginatedItems());
    }
 
    #[Test]
    public function ‪withCurrentPageNumberThrowsInvalidArgumentExceptionIfCurrentPageIsLowerThanOne(): void
    {
        $this->expectExceptionCode(1573047338);
 
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            1,
            3
        );
        $paginator->withCurrentPageNumber(0);
    }
 
    #[Test]
    public function ‪paginatorSetsCurrentPageToLastPageIfCurrentPageExceedsMaximum(): void
    {
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            3,
            10
        );
 
        self::assertEquals(2, $paginator->getCurrentPageNumber());
        self::assertEquals(2, $paginator->getNumberOfPages());
        self::assertCount(4, $paginator->getPaginatedItems());
    }
 
    #[Test]
    public function ‪paginatorProperlyCalculatesOnlyOnePage(): void
    {
        $paginator = new ‪ArrayPaginator(
            $this->fixture,
            1,
            50
        );
 
        self::assertSame(1, $paginator->getNumberOfPages());
        self::assertSame(0, $paginator->getKeyOfFirstPaginatedItem());
        self::assertSame(13, $paginator->getKeyOfLastPaginatedItem());
        self::assertCount(14, $paginator->getPaginatedItems());
    }
}