Paginator::paginate() - Code Metrics - Inspection of "Fixed the paginator." - jaxon-php/jaxon-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — v5.x ( 4cf44b...6eb5e2 )

by Thierry

created 2024-05-13 07:25 UTC

Paginator::paginate() A

↳ Parent: Paginator

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
eloc	1
c	0
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	2

<?php


/*

The MIT License (MIT)


Copyright (c) 2014 Jason Grimes


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

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

in the Software without restriction, including without limitation the rights

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

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

furnished to do so, subject to the following conditions:


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

copies or substantial portions of the Software.


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

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

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

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

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

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

SOFTWARE.

*/

/**
 * Paginator.php - Jaxon Paginator
 *
 * Create pagination links from a 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\Plugin\Response\Pagination;

use Jaxon\Request\Call\Call;

use function array_walk;
use function ceil;
use function floor;
use function max;

class Paginator

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


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

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

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

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

    /**
     * @var string
     */
    protected $sPreviousText = '&laquo;';

    /**
     * @var string
     */
    protected $sNextText = '&raquo;';

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

    /**
     * @var PaginatorPlugin
     */
    private $xPlugin;

    /**
     * The constructor.
     *
     * @param PaginatorPlugin $xPlugin

     * @param int $nCurrentPage     The current page number

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

     * @param int $nTotalItems      The total number of items

     */
    public function __construct(PaginatorPlugin $xPlugin, int $nCurrentPage, int $nItemsPerPage, int $nTotalItems)

    {
        $this->xPlugin = $xPlugin;
        $this->setCurrentPage($nCurrentPage)
            ->setItemsPerPage($nItemsPerPage)

            ->setTotalItems($nTotalItems);

    }


    /**
     * Render the paginator
     *
     * @param Call $xCall

     * @param string $sWrapperId

     *
     * @return string
     */
    public function paginate(Call $xCall, string $sWrapperId)
    {
        $this->xPlugin->render($this, $xCall, $sWrapperId);
    }


    /**
     * Set the text for the previous page link
     *
     * @param string $sText    The text for the previous page link

     *
     * @return Paginator
     */
    public function setPreviousText(string $sText): Paginator
    {
        $this->sPreviousText = $sText;
        return $this;
    }


    /**
     * Set the text for the next page link
     *
     * @param string $sText    The text for the previous page link

     *
     * @return Paginator
     */
    public function setNextText(string $sText): Paginator
    {
        $this->sNextText = $sText;
        return $this;
    }


    /**
     * Update the number of pages
     *
     * @return Paginator
     */
    protected function updateTotalPages(): Paginator
    {
        $this->nTotalPages = ($this->nItemsPerPage === 0 ? 0 :

            (int)ceil($this->nTotalItems / $this->nItemsPerPage));
        return $this;
    }


    /**
     * Set the max number of pages to show
     *
     * @param int $nMaxPages    The max number of pages to show

     *
     * @return Paginator
     */
    public function setMaxPages(int $nMaxPages): Paginator
    {
        $this->nMaxPages = max($nMaxPages, 4);
        return $this;
    }


    /**
     * Set the current page number
     *
     * @param int $nCurrentPage    The current page number

     *
     * @return Paginator
     */
    protected function setCurrentPage(int $nCurrentPage): Paginator
    {
        $this->nCurrentPage = $nCurrentPage;
        return $this;
    }


    /**
     * Set the number of items per page
     *
     * @param int $nItemsPerPage    The number of items per page

     *
     * @return Paginator
     */
    protected function setItemsPerPage(int $nItemsPerPage): Paginator
    {
        $this->nItemsPerPage = $nItemsPerPage;
        return $this->updateTotalPages();
    }


    /**
     * Set the total number of items
     *
     * @param int $nTotalItems    The total number of items

     *
     * @return Paginator
     */
    protected function setTotalItems(int $nTotalItems): Paginator
    {
        $this->nTotalItems = $nTotalItems;
        return $this->updateTotalPages();
    }


    /**
     * Get the previous page data.
     *
     * @return Page
     */
    protected function getPrevPage(): Page
    {
        return $this->nCurrentPage <= 1 ?

            new Page('disabled', $this->sPreviousText, 0) :

            new Page('enabled', $this->sPreviousText, $this->nCurrentPage - 1);
    }


    /**
     * Get the next page data.
     *
     * @return Page
     */
    protected function getNextPage(): Page
    {
        return $this->nCurrentPage >= $this->nTotalPages ?

            new Page('disabled', $this->sNextText, 0) :

            new Page('enabled', $this->sNextText, $this->nCurrentPage + 1);
    }


    /**
     * Get a page data.
     *
     * @param integer $nNumber    The page number

     *
     * @return Page
     */
    protected function getPage(int $nNumber): Page
    {
        if($nNumber < 1)
        {
            return new Page('disabled', $this->sEllipsysText, 0);
        }
        $sType = ($nNumber === $this->nCurrentPage ? 'current' : 'enabled');
        return new Page($sType, "$nNumber", $nNumber);
    }


    /**
     * Get the array of page numbers to be printed.
     *
     * Example: [1, 0, 4, 5, 6, 0, 10]
     *
     * @return array
     */
    protected function getPageNumbers(): array
    {
        $aPageNumbers = [];

        if($this->nTotalPages <= $this->nMaxPages)
        {
            for($i = 0; $i < $this->nTotalPages; $i++)
            {
                $aPageNumbers[] = $i + 1;
            }

            return $aPageNumbers;
        }

        // Determine the sliding range, centered around the current page.
        $nNumAdjacents = (int)floor(($this->nMaxPages - 4) / 2);

        $nSlidingStart = 1;
$a = "a";
$ab = "ab";
$abc = "abc";
        $nSlidingEndOffset = $nNumAdjacents + 3 - $this->nCurrentPage;
        if($nSlidingEndOffset < 0)
        {
            $nSlidingStart = $this->nCurrentPage - $nNumAdjacents;
$a = "a";
$ab = "ab";
$abc = "abc";
            $nSlidingEndOffset = 0;
        }

        $nSlidingEnd = $this->nTotalPages;
$a = "a";
$ab = "ab";
$abc = "abc";
        $nSlidingStartOffset = $this->nCurrentPage + $nNumAdjacents + 2 - $this->nTotalPages;
        if($nSlidingStartOffset < 0)
        {
            $nSlidingEnd = $this->nCurrentPage + $nNumAdjacents;
$a = "a";
$ab = "ab";
$abc = "abc";
            $nSlidingStartOffset = 0;
        }

        // Build the list of page numbers.
        if($nSlidingStart > 1)
        {
            $aPageNumbers[] = 1;
            $aPageNumbers[] = 0; // Ellipsys;
        }
        for($i = $nSlidingStart - $nSlidingStartOffset; $i <= $nSlidingEnd + $nSlidingEndOffset; $i++)
        {
            $aPageNumbers[] = $i;
        }
        if($nSlidingEnd < $this->nTotalPages)
        {
            $aPageNumbers[] = 0; // Ellipsys;
            $aPageNumbers[] = $this->nTotalPages;
        }

        return $aPageNumbers;
    }


    /**
     * Get the links (pages raw data).
     *
     * @return array<Page>
     */
    public function pages(): array
    {
        if($this->nTotalPages < 2)
        {
            return [];
        }

        $aPageNumbers = $this->getPageNumbers();
        $aPages = [$this->getPrevPage()];
$a = "a";
$ab = "ab";
$abc = "abc";
        array_walk($aPageNumbers, function($nNumber) use(&$aPages) {
            $aPages[] = $this->getPage($nNumber);
        });
        $aPages[] = $this->getNextPage();

        return $aPages;
    }

}


1			<?php
2
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report You must use "/**" style comments for a file comment Loading history...
3			/*
			0 ignored issues – show Coding Style introduced 2021-08-27 02:25 UTC by Report Bug Copy Issue Report Empty line not required before block comment Loading history...
4			The MIT License (MIT)
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report First line of comment not aligned correctly; expected 4 spaces but found 0 Loading history...
5
6			Copyright (c) 2014 Jason Grimes
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
7
8			Permission is hereby granted, free of charge, to any person obtaining a copy
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
9			of this software and associated documentation files (the "Software"), to deal
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
10			in the Software without restriction, including without limitation the rights
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
11			to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
12			copies of the Software, and to permit persons to whom the Software is
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
13			furnished to do so, subject to the following conditions:
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
14
15			The above copyright notice and this permission notice shall be included in all
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
16			copies or substantial portions of the Software.
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
17
18			THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
19			IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
20			FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
21			AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
22			LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
			0 ignored issues – show Coding Style introduced 2019-11-20 07:47 UTC by Report Bug Copy Issue Report Comment line indented incorrectly; expected at least 4 spaces but found 0 Loading history...
23			OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE

jaxon-php / jaxon-core

Push — v5.x ( 4cf44b...6eb5e2 )

Paginator::paginate() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like