Maslosoft Mangan API
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 <?php
/**
* This software package is licensed under AGPL or Commercial license.
*
* @package maslosoft/mangan
* @licence AGPL or Commercial
* @copyright Copyright (c) Piotr Masełkowski <pmaselkowski@gmail.com>
* @copyright Copyright (c) Maslosoft
* @copyright Copyright (c) Others as mentioned in code
* @link https://maslosoft.com/mangan/
*/
namespace Maslosoft\Mangan\Interfaces;
use Maslosoft\Mangan\Interfaces\Criteria\LimitableInterface;
/**
*
* @author Piotr Maselkowski <pmaselkowski at gmail.com>
*/
interface PaginationInterface
{
const DefaultPageSize = 25;
const FirstPageId = 1;
public function getSize();
/**
* Set size of page, how many items should appear on page.
* @param int $pageSize
*/
public function setSize($pageSize);
public function getPage();
/**
* Get pages
* @return int Number of pages
*/
public function getPages();
/**
* Set page number
* @param int $page
*/
public function setPage($page);
public function setCount($total);
public function apply(LimitableInterface $criteria);
public function getLimit();
public function getOffset();
}
API documentation generated by ApiGen