Jaxon\Ui\Pagination\Paginator

Complexity

Total Complexity

14

Size/Duplication

Total Lines	174
Duplicated Lines	0 %

Importance

Changes

0

12 Methods

Rating	Name	Duplication	Size	Complexity
A	setup()	0	5	1
A	__toString()	0	7	2
A	setNextText()	0	4	1
A	updateTotalPages()	0	4	2
A	setMaxPagesToShow()	0	4	1
A	setTotalItems()	0	4	1
A	__construct()	0	3	1
A	setItemsPerPage()	0	4	1
A	render()	0	3	1
A	setPreviousText()	0	4	1
A	getPages()	0	5	1
A	setCurrentPage()	0	4	1

<?php

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

/*

Empty line not required before block 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\Ui\Pagination;

use Jaxon\Request\Factory\Request;
use Jaxon\Ui\View\Store;

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 $totalPages = 0;

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

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

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

Missing parameter comment

     */
    public function __construct(Renderer $xRenderer)

Expected 2 blank lines before function; 1 found

    {
        $this->xRenderer = $xRenderer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * 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->xRenderer->setPreviousText($text);
        return $this;
    }

Expected 2 blank lines after function; 1 found

    /**
     * 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->xRenderer->setNextText($text);
        return $this;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Set the max number of pages to show
     *
     * @param int $maxPagesToShow The max number of pages to show
     *
     * @return Paginator
     */
    public function setMaxPagesToShow($maxPagesToShow)
    {
        $this->xRenderer->setMaxPagesToShow($maxPagesToShow);
        return $this;
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Set the number of items per page
     *
     * @param int $itemsPerPage The number of items per page
     *
     * @return Paginator
     */
    protected function setItemsPerPage($itemsPerPage)
    {
        $this->itemsPerPage = intval($itemsPerPage);
        return $this->updateTotalPages();
    }

Expected 2 blank lines after function; 1 found

    /**
     * Set the total number of items
     *
     * @param int $totalItems The total number of items
     *
     * @return Paginator
     */
    protected function setTotalItems($totalItems)
    {
        $this->totalItems = intval($totalItems);
        return $this->updateTotalPages();
    }

Expected 2 blank lines after function; 1 found

    /**
     * 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 $xRequest The request to be paginated

Expected 5 spaces after parameter name; 1 found

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

Expected 2 blank lines after function; 1 found

    /**
     * Get the pages.
     *
     * @return array
     */
    public function getPages()
    {
        return array_map(function($aPage) {
            return (object)['type' => $aPage[0], 'text' => $aPage[1], 'call' => $aPage[2]];
        }, $this->xRenderer->getPages($this->totalPages));
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render an HTML pagination control.
     *
     * @return null|Store
     */
    public function render()
    {
        return $this->xRenderer->render($this->totalPages);
    }

Expected 2 blank lines after function; 1 found

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

Expected 2 blank lines after function; 0 found

}