<?php
/**
* PaginatorPlugin.php - The Jaxon Paginator plugin
*
* @package jaxon-core
* @copyright 2024 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\App\Pagination\Paginator;
use Jaxon\App\Pagination\RendererInterface;
use Jaxon\Plugin\AbstractResponsePlugin;
/**
* Usage
*
* Step 1: Render a template containing a wrapper for the pagination.
*
* $html = $this->render($pageTemplate, [
* // ...
* ]);
*
* Step 2: Create a paginator and render the pagination into the wrapper.
*
* $this->response->pg->paginator($pageNumber, $perPage, $total)
* ->render($this->rq()->page(), $wrapperId);
*
* // Or, using the response shortcut
* $this->response->paginator($pageNumber, $perPage, $total)
* ->render($this->rq()->page(), $wrapperId);
*
* // In a class that inherits from CallableClass
* $this->paginator($pageNumber, $perPage, $total)
* ->render($this->rq()->page(), $wrapperId);
*
* // In a class that inherits from NodeComponent (no need for a wrapper id)
* $this->paginator($pageNumber, $perPage, $total)
* ->render($this->rq()->page());
*/
class PaginatorPlugin extends AbstractResponsePlugin
{
/**
* @const The plugin name
*/
public const NAME = 'pg';
/**
* The constructor.
*
* @param RendererInterface $xRenderer
*/
public function __construct(protected RendererInterface $xRenderer)
{}
/**
* @inheritDoc
*/
public function getName(): string
{
return self::NAME;
}
/**
* @inheritDoc
*/
public function getHash(): string
{
return '5.0.0'; // Use the version number as hash
}
/**
* @inheritDoc
*/
public function getCss(): string
{
return '
<style>
.pagination li a {
cursor: pointer;
}
</style>
';
}
/**
* Get the view renderer
*
* @return RendererInterface
*/
public function renderer(): RendererInterface
{
return $this->xRenderer;
}
/**
* Create a paginator
*
* @param int $nPageNumber The current page number
* @param int $nItemsPerPage The number of items per page
* @param int $nTotalItems The total number of items
*
* @return Paginator
*/
public function paginator(int $nPageNumber, int $nItemsPerPage, int $nTotalItems): Paginator
{
return new Paginator($this, $nPageNumber, $nItemsPerPage, $nTotalItems);
}
}
|
Download
