Jaxon\Utils\Pagination\Paginator

Complexity

Total Complexity

45

Size/Duplication

Total Lines	465
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

28 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	updateNumPages()	0	4	2
A	setMaxPagesToShow()	0	8	2
A	getMaxPagesToShow()	0	4	1
A	setCurrentPage()	0	4	1
A	getCurrentPage()	0	4	1
A	setItemsPerPage()	0	5	1
A	getItemsPerPage()	0	4	1
A	setTotalItems()	0	5	1
A	getTotalItems()	0	4	1
A	getNumPages()	0	4	1
A	setRequest()	0	9	3
A	getRequest()	0	4	1
A	setup()	0	9	1
A	getPageCall()	0	4	1
A	getNextPage()	0	8	2
A	getPrevPage()	0	8	2
A	getNextCall()	0	8	2
A	getPrevCall()	0	8	2
B	getPages()	0	56	9
A	createPage()	0	8	1
A	createPageEllipsis()	0	8	1
A	setPreviousText()	0	5	1
A	getPreviousText()	0	4	1
A	setNextText()	0	5	1
A	getNextText()	0	4	1
A	render()	0	8	2
A	__toString()	0	4	1

<?php

You must use "/**" style comments for a file comment

/*
The MIT License (MIT)

First line of comment not aligned correctly; expected 4 spaces but found 0

Copyright (c) 2014 Jason Grimes

Comment line indented incorrectly; expected at least 4 spaces but found 0

Permission is hereby granted, free of charge, to any person obtaining a copy

Comment line indented incorrectly; expected at least 4 spaces but found 0

of this software and associated documentation files (the "Software"), to deal

Comment line indented incorrectly; expected at least 4 spaces but found 0

in the Software without restriction, including without limitation the rights

Comment line indented incorrectly; expected at least 4 spaces but found 0

to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

Comment line indented incorrectly; expected at least 4 spaces but found 0

copies of the Software, and to permit persons to whom the Software is

Comment line indented incorrectly; expected at least 4 spaces but found 0

furnished to do so, subject to the following conditions:

Comment line indented incorrectly; expected at least 4 spaces but found 0

The above copyright notice and this permission notice shall be included in all

Comment line indented incorrectly; expected at least 4 spaces but found 0

copies or substantial portions of the Software.

Comment line indented incorrectly; expected at least 4 spaces but found 0

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

Comment line indented incorrectly; expected at least 4 spaces but found 0

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

Comment line indented incorrectly; expected at least 4 spaces but found 0

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

Comment line indented incorrectly; expected at least 4 spaces but found 0

AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

Comment line indented incorrectly; expected at least 4 spaces but found 0

LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

Comment line indented incorrectly; expected at least 4 spaces but found 0

OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

Comment line indented incorrectly; expected at least 4 spaces but found 0

SOFTWARE.

Comment line indented incorrectly; expected at least 4 spaces but found 0

*/

/**
 * Paginator.php - Jaxon Paginator
 *
 * Create pagination links from  an Jaxon request and a data array.
 *
 * @package jaxon-core
 * @author Jason Grimes
 * @author Thierry Feuzeu
 * @copyright 2014 Jason Grimes
 * @copyright 2016 Thierry Feuzeu
 * @license https://opensource.org/licenses/MIT MIT License
 * @link https://github.com/jaxon-php/jaxon-core
 */

namespace Jaxon\Utils\Pagination;

use Jaxon\Request\Factory\Request;
use Jaxon\Request\Factory\Parameter;

class Paginator

Missing doc comment for class Paginator

{
    /**
     * @var integer
     */
    protected $totalItems = 0;

Expected 1 blank line(s) before first member var; 0 found

    /**
     * @var integer
     */
    protected $numPages = 0;

    /**
     * @var integer
     */
    protected $itemsPerPage = 0;

    /**
     * @var integer
     */
    protected $currentPage = 0;

    /**
     * @var integer
     */
    protected $maxPagesToShow = 10;

    /**
     * @var string
     */
    protected $previousText = '«';

    /**
     * @var string
     */
    protected $nextText = '»';

    /**
     * The pagination renderer
     *
     * @var Renderer
     */
    protected $renderer = null;

    /**
     * The Jaxon request to be paginated
     *
     * @var Request
     */
    protected $request = null;

    /**
     * The constructor
     *
     * @param Renderer $renderer

Missing parameter comment

     */
    public function __construct(Renderer $renderer)
    {
        $this->renderer = $renderer;
    }

    /**
     * Update the number of pages
     *
     * @return void
     */
    protected function updateNumPages()
    {
        $this->numPages = ($this->itemsPerPage == 0 ? 0 : (int)ceil($this->totalItems / $this->itemsPerPage));
    }

    /**
     * Set the max number of pages to show
     *
     * @param int $maxPagesToShow The max number of pages to show
     *
     * @return void
     * @throws \InvalidArgumentException if $maxPagesToShow is less than 3.
     */
    public function setMaxPagesToShow($maxPagesToShow)
    {
        if($maxPagesToShow < 4)
        {
            throw new \InvalidArgumentException('maxPagesToShow cannot be less than 4.');
        }
        $this->maxPagesToShow = $maxPagesToShow;
    }

    /**
     * Get the max number of pages to show
     *
     * @return int
     */
    public function getMaxPagesToShow()
    {
        return $this->maxPagesToShow;
    }

    /**
     * Set the current page number
     *
     * @param int $currentPage The current page number
     *
     * @return void
     */
    public function setCurrentPage($currentPage)
    {
        $this->currentPage = $currentPage;
    }

    /**
     * Get the current page number
     *
     * @return int
     */
    public function getCurrentPage()
    {
        return $this->currentPage;
    }

    /**
     * Set the number of items per page
     *
     * @param int $itemsPerPage The number of items per page
     *
     * @return void
     */
    public function setItemsPerPage($itemsPerPage)
    {
        $this->itemsPerPage = $itemsPerPage;
        $this->updateNumPages();
    }

    /**
     * Get the number of items per page
     *
     * @return int
     */
    public function getItemsPerPage()
    {
        return $this->itemsPerPage;
    }

    /**
     * Set the total number of items
     *
     * @param int $totalItems The total number of items
     *
     * @return void
     */
    public function setTotalItems($totalItems)
    {
        $this->totalItems = $totalItems;
        $this->updateNumPages();
    }

    /**
     * Get the total number of items
     *
     * @return int
     */
    public function getTotalItems()
    {
        return $this->totalItems;
    }

    /**
     * Get the total number of pages
     *
     * @return int
     */
    public function getNumPages()
    {
        return $this->numPages;
    }

    /**
     * Set the request to be paginated
     *
     * @param Request $request The request to be paginated
     *
     * @return void
     */
    public function setRequest(Request $request)
    {
        $this->request = $request;
        // Append the page number to the parameter list, if not yet given.
        if(($this->request) && !$this->request->hasPageNumber())
        {
            $this->request->addParameter(Parameter::PAGE_NUMBER, 0);
        }
    }

    /**
     * Get the request to be paginated
     *
     * @return Request
     */
    public function getRequest()
    {
        return $this->request;
    }

    /**
     * Setup the paginator
     *
     * @param int $totalItems The total number of items

Expected 5 spaces after parameter type; 1 found

Expected 3 spaces after parameter name; 1 found

     * @param int $itemsPerPage The number of items per page

Expected 5 spaces after parameter type; 1 found

     * @param int $currentPage The current page number

Expected 5 spaces after parameter type; 1 found

Expected 2 spaces after parameter name; 1 found

     * @param Request $request The request to be paginated

Expected 6 spaces after parameter name; 1 found

     *
     * @return Paginator
     */
    public function setup($totalItems, $itemsPerPage, $currentPage, $request)
    {
        $this->setTotalItems($totalItems);
        $this->setItemsPerPage($itemsPerPage);
        $this->setCurrentPage($currentPage);
        $this->setRequest($request);

        return $this;
    }

    /**
     * Get the js call to a given page
     *
     * @param int $pageNum The page number
     *
     * @return string
     */
    public function getPageCall($pageNum)
    {
        return $this->request->setPageNumber($pageNum)->getScript();
    }

    /**
     * Get the next page number
     *
     * @return integer|null
     */
    public function getNextPage()
    {
        if($this->currentPage < $this->numPages)
        {
            return $this->currentPage + 1;
        }
        return null;
    }

    /**
     * Get the previous page number
     *
     * @return integer|null
     */
    public function getPrevPage()
    {
        if($this->currentPage > 1)
        {
            return $this->currentPage - 1;
        }
        return null;
    }

    /**
     * Get the js call to the next page
     *
     * @return string|null
     */
    public function getNextCall()
    {
        if(!$this->getNextPage())
        {
            return null;
        }
        return $this->getPageCall($this->getNextPage());
    }

    /**
     * Get the js call to the previous page
     *
     * @return string|null
     */
    public function getPrevCall()
    {
        if(!$this->getPrevPage())
        {
            return null;
        }
        return $this->getPageCall($this->getPrevPage());
    }

    /**
     * Get an array of paginated page data.
     *
     * Example:
     * [
     *     array ('num' => 1,     'call' => '/example/page/1',  'isCurrent' => false),
     *     array ('num' => '...', 'call' => NULL,               'isCurrent' => false),
     *     array ('num' => 3,     'call' => '/example/page/3',  'isCurrent' => false),
     *     array ('num' => 4,     'call' => '/example/page/4',  'isCurrent' => true ),
     *     array ('num' => 5,     'call' => '/example/page/5',  'isCurrent' => false),
     *     array ('num' => '...', 'call' => NULL,               'isCurrent' => false),
     *     array ('num' => 10,    'call' => '/example/page/10', 'isCurrent' => false),
     * ]
     *
     * @return array
     */
    public function getPages()
    {
        $pages = [];

        if($this->numPages <= 1)
        {
            return [];
        }

        if($this->numPages <= $this->maxPagesToShow)
        {
            for($i = 1; $i <= $this->numPages; $i++)
            {
                $pages[] = $this->createPage($i);
            }
        }
        else
        {
            // Determine the sliding range, centered around the current page.
            $numAdjacents = (int)floor(($this->maxPagesToShow - 4) / 2);

            $slidingStart = 1;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

            $slidingEndOffset = $numAdjacents + 3 - $this->currentPage;
            if($slidingEndOffset < 0)
            {
                $slidingStart = $this->currentPage - $numAdjacents;

Equals sign not aligned with surrounding assignments; expected 5 spaces but found 1 space

                $slidingEndOffset = 0;
            }

            $slidingEnd = $this->numPages;

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

            $slidingStartOffset = $this->currentPage + $numAdjacents + 2 - $this->numPages;
            if($slidingStartOffset < 0)
            {
                $slidingEnd = $this->currentPage + $numAdjacents;

Equals sign not aligned with surrounding assignments; expected 9 spaces but found 1 space

                $slidingStartOffset = 0;
            }

            // Build the list of pages.
            if($slidingStart > 1)
            {
                $pages[] = $this->createPage(1);
                $pages[] = $this->createPageEllipsis();
            }
            for($i = $slidingStart - $slidingStartOffset; $i <= $slidingEnd + $slidingEndOffset; $i++)
            {
                $pages[] = $this->createPage($i);
            }
            if($slidingEnd < $this->numPages)
            {
                $pages[] = $this->createPageEllipsis();
                $pages[] = $this->createPage($this->numPages);
            }
        }

        return $pages;
    }


    /**
     * Create a page data structure.
     *
     * @param int $pageNum

Missing parameter comment

     *
     * @return array<string,integer|string|boolean>
     */
    protected function createPage($pageNum)
    {
        return [
            'num' => $pageNum,
            'call' => $this->getPageCall($pageNum),
            'isCurrent' => ($this->currentPage == $pageNum),
        ];
    }

    /**
     * Get the page ellipsis
     *
     * @return array<string,string|null|false>
     */
    protected function createPageEllipsis()
    {
        return [
            'num' => '...',
            'call' => null,
            'isCurrent' => false,
        ];
    }

    /**
     * Set the text for the previous page link
     *
     * @param string $text The text for the previous page link
     *
     * @return Paginator
     */
    public function setPreviousText($text)
    {
        $this->previousText = $text;
        return $this;
    }

    /**
     * Get the text for the previous page link
     *
     * @return string
     */
    public function getPreviousText()
    {
        return $this->previousText;
    }

    /**
     * Set the text for the next page link
     *
     * @param string $text The text for the previous page link
     *
     * @return Paginator
     */
    public function setNextText($text)
    {
        $this->nextText = $text;
        return $this;
    }

    /**
     * Get the text for the next page link
     *
     * @return string
     */
    public function getNextText()
    {
        return $this->nextText;
    }

    /**
     * Render an HTML pagination control.
     *
     * @return string
     */
    public function render()
    {
        if($this->getNumPages() <= 1)
        {
            return '';
        }
        return $this->renderer->render($this);
    }

    /**
     * Render an HTML pagination control.
     *
     * @return string
     */
    public function __toString()
    {
        return $this->render();
    }
}