Jaxon\Plugin\Response\Pagination\PaginatorPlugin

Complexity

Total Complexity

9

Size/Duplication

Total Lines	115
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	getName()	0	3	1
A	render()	0	25	4
A	_render()	0	15	1
A	wrapper()	0	4	1
A	getHash()	0	4	1
A	__construct()	0	3	1

<?php

/**
 * PaginatorPlugin.php - The Jaxon Paginator plugin
 *
 * @package jaxon-core

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

 * @copyright 2024 Thierry Feuzeu
 * @license https://opensource.org/licenses/MIT MIT License
 * @link https://github.com/jaxon-php/jaxon-core
 */

PHP version not specified

Missing @category tag in file comment

Missing @author tag in file comment

namespace Jaxon\Plugin\Response\Pagination;

use Jaxon\App\View\ViewRenderer;
use Jaxon\App\View\Store;
use Jaxon\Plugin\ResponsePlugin;
use Jaxon\Request\Call\Call;
use Jaxon\Request\Call\Parameter;

use function array_map;
use function array_pop;
use function array_shift;
use function count;
use function trim;

/**
 * Usage
 *
 * Step 1: Create a wrapper for the pagination.
 *
 * $html = $this->render($pageTemplate, [
 *     // ...
 *     'pagination' => $this->response->pg->wrapper($wrapperId),
 * ]);
 *
 * Step 2: Render the pagination into the wrapper.
 *
 * $this->response->pg->render($this->rq()->page(), $pageNumber, $perPage, $total);
 * // Or, using the response shortcut
 * $this->response->paginate($this->rq()->page(), $pageNumber, $perPage, $total);
 * // Or, in a class that inherits from CallableClass
 * $this->paginate($this->rq()->page(), $pageNumber, $perPage, $total);
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class PaginatorPlugin extends ResponsePlugin
{
    /**
     * @const The plugin name
     */
    const NAME = 'pg';

    /**
     * @var ViewRenderer
     */
    protected $xRenderer;

    /**
     * @var string
     */
    protected $sWrapperId = '';

    /**
     * The constructor.
     *
     * @param ViewRenderer $xRenderer

Missing parameter comment

     */
    public function __construct(ViewRenderer $xRenderer)

Expected 2 blank lines before function; 1 found

    {
        $this->xRenderer = $xRenderer;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getName(): string
    {
        return self::NAME;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @inheritDoc
     */

Missing @return tag in function comment

    public function getHash(): string
    {
        // Use the version number as hash
        return '5.0.0';
    }

Expected 2 blank lines after function; 1 found

    /**
     * Get the pagination wrapper HTML
     *
     * @param string $sWrapperId        The pagination wrapper id

Expected 1 spaces after parameter name; 8 found

     *
     * @return string
     */
    public function wrapper(string $sWrapperId): string
    {
        $this->sWrapperId = trim($sWrapperId);
        return $this->sWrapperId;
    }

Expected 2 blank lines after function; 1 found

    /**
     * @param array<Page> $aPages

Missing parameter comment

     *
     * @return null|Store
     */
    private function _render(array $aPages): ?Store
    {
        $aPages = array_map(function($xPage) {

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

            return $this->xRenderer->render('pagination::links/' . $xPage->sType, [
                'page' => $xPage->nNumber,
                'text' => $xPage->sText,
            ]);
        }, $aPages);
        $aPrevPage = array_shift($aPages); // The first entry in the array
        $aNextPage = array_pop($aPages); // The last entry in the array

        return $this->xRenderer->render('pagination::wrapper', [
            'links' => $aPages,
            'prev' => $aPrevPage,
            'next' => $aNextPage,
        ]);
    }

Expected 2 blank lines after function; 1 found

    /**
     * Render an HTML pagination control.
     *
     * @param Call $xCall

Missing parameter comment

     * @param int $nCurrentPage     The current page number

Expected 2 spaces after parameter name; 5 found

Expected 2 spaces after parameter type; 1 found

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

Expected 1 spaces after parameter name; 4 found

Expected 2 spaces after parameter type; 1 found

     * @param int $nTotalItems      The total number of items

Expected 3 spaces after parameter name; 6 found

Expected 2 spaces after parameter type; 1 found

     *
     * @return void
     */
    public function render(Call $xCall, int $nCurrentPage, int $nItemsPerPage, int $nTotalItems)
    {
        $xPaginator = new Paginator($nCurrentPage, $nItemsPerPage, $nTotalItems);
        $aPages = $xPaginator->pages();

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

        if(count($aPages) === 0)
        {
            return;
        }
        $xStore = $this->_render($aPages);
        if(!$xStore)
        {
            return;
        }

        // Append the page number to the parameter list, if not yet given.
        if(!$xCall->hasPageNumber())
        {
            $xCall->addParameter(Parameter::PAGE_NUMBER, 0);
        }
        // Show the pagination links
        $this->response()->html($this->sWrapperId, $xStore->__toString());
        // Set click handlers on the pagination links
        $this->addCommand('pg.paginate', [
            'id' => $this->sWrapperId,
            'call' => $xCall->toArray(),
            // 'pages' => array_map(function(Page $xPage) {
            //     return ['type' => $xPage->sType, 'number' => $xPage->nNumber];
            // }, $aPages),
        ]);
    }

Expected 2 blank lines after function; 0 found

}