ApacheSolrForTypo3\Solr\Pagination\ResultsPagination

Complexity

Total Complexity

24

Size/Duplication

Total Lines	223
Duplicated Lines	0 %

Test Coverage

Coverage

61.9%

Importance

Changes	3
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	getMaxPageNumbers()	0	3	1
A	getHasMorePages()	0	3	1
A	setMaxPageNumbers()	0	4	1
A	getHasLessPages()	0	3	1
A	__construct()	0	4	1
A	getFirstPageNumber()	0	3	1
A	getNextPageNumber()	0	7	2
A	getPreviousPageNumber()	0	11	3
A	getEndRecordNumber()	0	7	2
A	getPageRangeFirst()	0	3	1
A	getPageRangeLast()	0	3	1
A	getStartRecordNumber()	0	7	2
A	getAllPageNumbers()	0	3	1
A	calculatePageRange()	0	27	5
A	getLastPageNumber()	0	3	1

<?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 ApacheSolrForTypo3\Solr\Pagination;

use TYPO3\CMS\Core\Pagination\PaginationInterface;
use TYPO3\CMS\Core\Pagination\PaginatorInterface;

/**
 * Class ResultsPagination
 *
 * @author Rudy Gnodde <rudy.gnodde@beech.it>
 */
class ResultsPagination implements PaginationInterface
{
    /**
     * @var PaginatorInterface
     */
    protected PaginatorInterface $paginator;

    /**
     * @var int
     */
    protected int $maxPageNumbers = 0;

    /**
     * @var bool
     */
    protected bool $hasMorePages = false;

    /**
     * @var bool
     */
    protected bool $hasLessPages = false;

    /**
     * @var int
     */
    protected int $pageRangeFirst = 1;

    /**
     * @var int
     */
    protected int $pageRangeLast = 1;

    /**
     * @param PaginatorInterface $paginator
     */
    public function __construct(PaginatorInterface $paginator)
    {
        $this->paginator = $paginator;
        $this->calculatePageRange();
    }

    /**
     * Get maximum page numbers
     *
     * @return int
     */
    public function getMaxPageNumbers(): int
    {
        return $this->maxPageNumbers;
    }

    /**
     * Set maximum page numbers
     *
     * @param int $maxPageNumbers
     */
    public function setMaxPageNumbers(int $maxPageNumbers): void
    {
        $this->maxPageNumbers = $maxPageNumbers;
        $this->calculatePageRange();
    }

    /**
     * Get has more pages
     *
     * @return bool
     */
    public function getHasMorePages(): bool
    {
        return $this->hasMorePages;
    }

    /**
     * Get has less pages
     *
     * @return bool
     */
    public function getHasLessPages(): bool
    {
        return $this->hasLessPages;
    }

    /**
     * Get page range first
     *
     * @return int
     */
    public function getPageRangeFirst(): int
    {
        return $this->pageRangeFirst;
    }

    /**
     * Get page range last
     *
     * @return int
     */
    public function getPageRangeLast(): int
    {
        return $this->pageRangeLast;
    }

    /**
     * Get previous page number
     *
     * @return int|null
     */
    public function getPreviousPageNumber(): ?int
    {
        $previousPage = $this->paginator->getCurrentPageNumber() - 1;

        if ($previousPage > $this->paginator->getNumberOfPages()) {
            return null;
        }

        return $previousPage >= $this->getFirstPageNumber()
            ? $previousPage
            : null
            ;
    }

    /**
     * Get next page number
     *
     * @return int|null
     */
    public function getNextPageNumber(): ?int
    {
        $nextPage = $this->paginator->getCurrentPageNumber() + 1;

        return $nextPage <= $this->paginator->getNumberOfPages()
            ? $nextPage
            : null;
    }

    /**
     * Get first page number
     *
     * @return int
     */
    public function getFirstPageNumber(): int
    {
        return 1;
    }

    /**
     * Get last page number
     *
     * @return int
     */
    public function getLastPageNumber(): int
    {
        return $this->paginator->getNumberOfPages();
    }

    /**
     * Get start record number
     *
     * @return int
     */
    public function getStartRecordNumber(): int
    {
        if ($this->paginator->getCurrentPageNumber() > $this->paginator->getNumberOfPages()) {
            return 0;
        }

        return $this->paginator->getKeyOfFirstPaginatedItem() + 1;
    }

    /**
     * Get end record number
     *
     * @return int
     */
    public function getEndRecordNumber(): int
    {
        if ($this->paginator->getCurrentPageNumber() > $this->paginator->getNumberOfPages()) {
            return 0;
        }

        return $this->paginator->getKeyOfLastPaginatedItem() + 1;
    }

    /**
     * Get all page numbers
     *
     * @return int[]
     */
    public function getAllPageNumbers(): array
    {
        return range($this->pageRangeFirst, $this->pageRangeLast);
    }

    /**
     * Calculate page range
     */
    protected function calculatePageRange(): void
    {
        $this->pageRangeFirst = 1;
        $this->pageRangeLast = $this->getLastPageNumber();
        $this->hasLessPages = false;
        $this->hasMorePages = false;

        $maxNumberOfLinks = $this->getMaxPageNumbers();
        if ($maxNumberOfLinks > 0) {
            $numberOfPages = $this->paginator->getNumberOfPages();

            if ($numberOfPages > $maxNumberOfLinks) {
                $currentPage = $this->paginator->getCurrentPageNumber();
                $pagesBeforeAndAfter = ($maxNumberOfLinks - 1) / 2;
                $this->pageRangeFirst = (int)($currentPage - floor($pagesBeforeAndAfter));
                $this->pageRangeLast = (int)($currentPage + ceil($pagesBeforeAndAfter));

                if ($this->pageRangeFirst < 1) {
                    $this->pageRangeLast -= $this->pageRangeFirst - 1;
                }
                if ($this->pageRangeLast > $numberOfPages) {
                    $this->pageRangeFirst -= $this->pageRangeLast - $numberOfPages;
                }
                $this->pageRangeFirst = max($this->pageRangeFirst, 1);
                $this->pageRangeLast = min($this->pageRangeLast, $numberOfPages);
                $this->hasLessPages = $this->pageRangeFirst > 1;
                $this->hasMorePages = $this->pageRangeLast < $numberOfPages;
            }
        }
    }
}