Spiral\Pagination\Paginator

Complexity

Total Complexity

31

Size/Duplication

Total Lines	305
Duplicated Lines	7.21 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes	2
Bugs	0	Features	1

22 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	7	1
A	setRequest()	0	5	1
A	setUri()	0	6	1
A	getUri()	0	4	1
A	setQuery()	0	4	2
A	getQuery()	0	4	1
A	setParameter()	0	10	2
A	getParameter()	0	4	1
A	setCount()	11	11	2
A	count()	0	4	1
A	setLimit()	11	11	2
A	getLimit()	0	4	1
A	setPage()	0	7	1
A	getPage()	0	12	3
A	getOffset()	0	4	1
A	countPages()	0	4	1
A	countDisplayed()	0	8	2
A	isRequired()	0	4	1
A	nextPage()	0	8	2
A	previousPage()	0	8	2
A	paginate()	0	9	1
A	uri()	0	6	1

<?php
/**
 * Spiral Framework.
 *
 * @license   MIT
 * @author    Anton Titov (Wolfy-J)
 */
namespace Spiral\Pagination;

use Psr\Http\Message\ServerRequestInterface;
use Psr\Http\Message\UriInterface;

/**
 * Default paginator implementation, uses active server request Uri to generate page urls.
 */
class Paginator implements PredictableInterface, \Countable
{
    /**
     * Default limit value.
     */
    const DEFAULT_LIMIT = 25;

    /**
     * Default page parameter.
     */
    const DEFAULT_PARAMETER = 'page';

    /**
     * The query array will be connected to every page URL generated by paginator.
     *
     * @var array
     */
    private $queryData = [];

    /**
     * @var string
     */
    private $pageParameter = 'page';

    /**
     * @var int
     */
    private $pageNumber = 1;

    /**
     * @var int
     */
    private $countPages = 1;

    /**
     * @var int
     */
    private $limit = self::DEFAULT_LIMIT;

    /**
     * @var int
     */
    private $count = 0;

    /**
     * @invisible
     * @var ServerRequestInterface
     */
    private $request = null;

    /**
     * @var UriInterface
     */
    private $uri = null;

    /**
     * {@inheritdoc}
     */
    public function __construct(
        ServerRequestInterface $request,
        $pageParameter = self::DEFAULT_PARAMETER
    ) {
        $this->setRequest($request);
        $this->setParameter($pageParameter);
    }

    /**
     * @param ServerRequestInterface $request
     */
    public function setRequest(ServerRequestInterface $request)
    {
        $this->request = $request;
        $this->uri = $request->getUri();
    }

    /**
     * {@inheritdoc}
     */
    public function setUri(UriInterface $uri)
    {
        $this->uri = $uri;

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function getUri()
    {
        return $this->uri;
    }

    /**
     * Specify the query (as array) which will be attached to every generated page URL.
     *
     * @param array $query
     * @param bool  $replace Replace existed query data entirely.
     */
    public function setQuery(array $query, $replace = false)
    {
        $this->queryData = $replace ? $query : $query + $this->queryData;
    }

    /**
     * @return array
     */
    public function getQuery()
    {
        return $this->queryData;
    }

    /**
     * Update page parameter name from request query. Page number should be fetched from queryParams
     * of provided request instance.
     *
     * @param string $pageParameter
     * @return self
     */
    public function setParameter($pageParameter)
    {
        $this->pageParameter = $pageParameter;
        $queryParams = $this->request->getQueryParams();
        if (isset($queryParams[$this->pageParameter])) {
            $this->setPage($queryParams[$this->pageParameter]);
        }

        return $this;
    }

    /**
     * Get page query parameter name.
     *
     * @return string
     */
    public function getParameter()
    {
        return $this->pageParameter;
    }

    /**
     * {@inheritdoc}
     */
    public function setCount($count)

This method seems to be duplicated in your project.

    {
        $this->count = abs(intval($count));

It seems like abs(intval($count)) can also be of type double. However, the property $count is declared as type integer. Maybe add an additional type check?

        if ($this->count > 0) {
            $this->countPages = ceil($this->count / $this->limit);

The property $countPages was declared of type integer, but ceil($this->count / $this->limit) is of type double. Maybe add a type cast?

        } else {
            $this->countPages = 1;
        }

        return $this;
    }

    /**
     * {@inheritdoc}
     */
    public function count()
    {
        return $this->count;
    }

    /**
     * Set pagination limit.
     *
     * @param int $limit
     * @return $this
     */
    public function setLimit($limit)

This method seems to be duplicated in your project.

    {
        $this->limit = abs(intval($limit));

It seems like abs(intval($limit)) can also be of type double. However, the property $limit is declared as type integer. Maybe add an additional type check?

        if ($this->count > 0) {
            $this->countPages = ceil($this->count / $this->limit);

The property $countPages was declared of type integer, but ceil($this->count / $this->limit) is of type double. Maybe add a type cast?

        } else {
            $this->countPages = 1;
        }

        return $this;
    }

    /**
     * Get pagination limit (items per page).
     *
     * @return int
     */
    public function getLimit()
    {
        return $this->limit;
    }

    /**
     * {@inheritdoc}
     */
    public function setPage($number)
    {
        $this->pageNumber = abs(intval($number));

It seems like abs(intval($number)) can also be of type double. However, the property $pageNumber is declared as type integer. Maybe add an additional type check?

        //Real page number
        return $this->getPage();
    }

    /**
     * {@inheritdoc}
     */
    public function getPage()
    {
        if ($this->pageNumber < 1) {
            return 1;
        }

        if ($this->pageNumber > $this->countPages) {
            return $this->countPages;
        }

        return $this->pageNumber;
    }

    /**
     * Get pagination offset.
     *
     * @return int
     */
    public function getOffset()
    {
        return ($this->getPage() - 1) * $this->limit;
    }

    /**
     * The count of pages required to represent all records using a specified limit value.
     *
     * @return int
     */
    public function countPages()
    {
        return $this->countPages;
    }

    /**
     * {@inheritdoc}
     */
    public function countDisplayed()
    {
        if ($this->getPage() == $this->countPages) {
            return $this->count - $this->getOffset();
        }

        return $this->limit;
    }

    /**
     * {@inheritdoc}
     */
    public function isRequired()
    {
        return ($this->countPages > 1);
    }

    /**
     * {@inheritdoc}
     */
    public function nextPage()
    {
        if ($this->getPage() != $this->countPages) {
            return $this->getPage() + 1;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function previousPage()
    {
        if ($this->getPage() > 1) {
            return $this->getPage() - 1;
        }

        return false;
    }

    /**
     * {@inheritdoc}
     */
    public function paginate(PaginableInterface $paginable)
    {
        $this->setCount($paginable->count());

        $paginable->offset($this->getOffset());
        $paginable->limit($this->getLimit());

        return $paginable;
    }

    /**
     * {@inheritdoc}
     */
    public function uri($pageNumber)
    {
        return $this->uri->withQuery(http_build_query(
            $this->getQuery() + [$this->pageParameter => $pageNumber]
        ));
    }
}