Jaxon\Utils\Pagination\Renderer

Complexity

Total Complexity

16

Size/Duplication

Total Lines	191
Duplicated Lines	10.47 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	setPreviousText()	0	4	1
A	setNextText()	0	4	1
A	setRequest()	0	9	3
A	getPageCall()	0	4	1
A	getPrevLink()	10	10	2
A	getNextLink()	10	10	2
A	getLink()	0	18	3
A	render()	0	17	2

<?php

/**
 * Renderer.php - Paginator renderer
 *
 * Render pagination links.
 *
 * @package jaxon-core

Package name "jaxon-core" is not valid; consider "Jaxoncore" instead

 * @author Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @copyright 2016 Thierry Feuzeu <thierry.feuzeu@gmail.com>
 * @license https://opensource.org/licenses/BSD-3-Clause BSD 3-Clause License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

namespace Jaxon\Utils\Pagination;

use Jaxon\Contracts\Template\Renderer as TemplateRenderer;

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

class Renderer

Missing doc comment for class Renderer

{
    /**
     * The template renderer.
     *
     * Will be used to render HTML code for links.
     *
     * @var TemplateRenderer
     */
    protected $xRenderer = null;

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

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

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

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

    /**
     * @var string
     */
    protected $ellipsysText = '...';

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

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

    /**
     * The class contructor
     *
     * @param TemplateRenderer          $xRenderer

Missing parameter comment

Expected 1 spaces after parameter type; 10 found

     */
    public function __construct(TemplateRenderer $xRenderer)
    {
        $this->xRenderer = $xRenderer;
    }

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

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

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

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

    /**
     * Render the previous link.
     *
     * @return string
     */
    protected function getPrevLink()

This method seems to be duplicated in your project.

    {
        $aVars = ['text' => $this->previousText];
        if($this->currentPage > 1)
        {
            $aVars['call'] = $this->getPageCall($this->currentPage - 1);
            return $this->xRenderer->render('pagination::links/prev', $aVars);
        }
        return $this->xRenderer->render('pagination::links/disabled', $aVars);
    }

    /**
     * Render the next link.
     *
     * @return string
     */
    protected function getNextLink()

This method seems to be duplicated in your project.

    {
        $aVars = ['text' => $this->nextText];
        if($this->currentPage < $this->totalPages)
        {
            $aVars['call'] = $this->getPageCall($this->currentPage + 1);
            return $this->xRenderer->render('pagination::links/next', $aVars);
        }
        return $this->xRenderer->render('pagination::links/disabled', $aVars);
    }

    /**
     * Render the pagination links.
     *
     * @param integer        $nNumber         The page number

Expected 1 spaces after parameter type; 8 found

Expected 1 spaces after parameter name; 9 found

     *
     * @return string
     */
    protected function getLink($nNumber)
    {
        if($nNumber <= 0)
        {
            // Disabled page
            return $this->xRenderer->render('pagination::links/disabled', ['text' => $this->ellipsysText]);
        }
        if($nNumber == $this->currentPage)
        {
            // Current page
            return $this->xRenderer->render('pagination::links/current', ['text' => $nNumber]);
        }
        // Enabled page
        return $this->xRenderer->render('pagination::links/enabled',[
            'text' => $nNumber,
            'call' => $this->getPageCall($nNumber)
        ]);
    }

    /**
     * Render an HTML pagination control.
     *
     * @param array     $aPageNumbers       The page numbers to be rendered

Expected 3 spaces after parameter type; 5 found

Expected 1 spaces after parameter name; 7 found

     * @param integer   $currentPage        The current page number

Expected 1 spaces after parameter type; 3 found

Expected 2 spaces after parameter name; 8 found

     * @param integer   $totalPages         The total number of pages

Expected 1 spaces after parameter type; 3 found

Expected 3 spaces after parameter name; 9 found

     *
     * @return string
     */
    public function render(array $aPageNumbers, $currentPage, $totalPages)
    {
        $this->currentPage = $currentPage;
        $this->totalPages = $totalPages;

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

        $sLinks = '';
        foreach($aPageNumbers as $nNumber)
        {
            $sLinks .= $this->getLink($nNumber);
        }

        return $this->xRenderer->render('pagination::wrapper', [
            'links' => $sLinks,
            'prev' => $this->getPrevLink(),
            'next' => $this->getNextLink(),
        ]);
    }
}