Veles\DataBase\DbPaginator

Complexity

Total Complexity

13

Size/Duplication

Total Lines	120
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	2
Bugs	0	Features	0

9 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	4	1
A	getLimit()	0	3	1
A	getOffset()	0	3	1
A	calcMaxPages()	0	3	1
A	getCurrPage()	0	3	1
A	getSqlLimit()	0	5	1
A	getMaxPages()	0	9	2
A	setLimit()	0	7	2
A	__toString()	0	19	3

<?php
/**
 * Class for data pagination
 *
 * @file      DbPaginator.php
 *
 * PHP version 8.0+
 *
 * @author    Alexander Yancharuk <alex at itvault dot info>
 * @copyright © 2012-2021 Alexander Yancharuk
 * @date      Втр Авг 07 23:04:47 2012
 * @license   The BSD 3-Clause License
 *            <https://tldrlegal.com/license/bsd-3-clause-license-(revised)>
 */

namespace Veles\DataBase;

use stdClass;
use Veles\Tools\SnippetBuilder;

/**
 * Class DbPaginator
 *
 * Additional data for rendering can be stored as public params.
 * For this purpose class extends stdClass.
 *
 * @author  Alexander Yancharuk <alex at itvault dot info>
 */
class DbPaginator extends stdClass
{
	public $offset = 1;
	public $limit  = 5;
	public $page_nums;
	public $curr_page;
	public $template;
	public $first_link;
	public $last_link;
	public $index;

	/**
	 * Constructor
	 * @param string $template Path to template
	 * @param int $curr_page Current page
	 */
	public function __construct($template, $curr_page = 1)
	{
		$this->template  = $template;
		$this->curr_page = (int) $curr_page;
	}

	/**
	 * Pagination rendering
	 */
	public function __toString()
	{
		$this->first_link = false;
		$this->last_link  = false;
		$this->index      = 1;

		if ($this->curr_page > 4) {
			$this->first_link = 1;
			$this->index = $this->curr_page - 3;
		}

		if ($this->page_nums > $this->curr_page + 3) {
			$this->last_link = $this->page_nums;
			$this->page_nums = $this->curr_page + 3;
		}

		$builder = new SnippetBuilder($this);

		return $builder->build($this->template);
	}

	/**
	 * Getting offset
	 * @return int
	 */
	public function getOffset()
	{
		return ($this->curr_page - 1) * $this->getLimit();
	}

	/**
	 * Getting limit
	 * @return int
	 */
	public function getLimit()
	{
		return $this->limit;
	}

	/**
	 * Elements per page setting
	 * @param mixed $limit Кол-во выводимых элементов на странице
	 */
	public function setLimit($limit)
	{
		if (!is_numeric($limit)) {
			return;
		}

		$this->limit = (int) $limit;
	}

	/**
	 * Getting limit for sql-request
	 * @return string
	 */
	public function getSqlLimit()
	{
		$offset = $this->getOffset();
		$limit  = $this->getLimit();
		return " LIMIT $offset, $limit";
	}

	/**
	 * Pages quantity
	 *
	 * @throws \Exception
	 */
	public function getMaxPages()
	{
		if (null !== $this->page_nums) {
			return $this->page_nums;
		}

		$this->calcMaxPages();

		return $this->page_nums;
	}

	/**
	 * Pages quantity calculation
	 *
	 * @throws \Exception
	 */
	public function calcMaxPages()
	{
		$this->page_nums = (int) ceil(Db::getFoundRows() / $this->getLimit());
	}

	/**
	 * Getting current page
	 */
	public function getCurrPage()
	{
		return $this->curr_page;
	}
}