-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
PaginatedInterface.php
92 lines (81 loc) · 1.91 KB
/
PaginatedInterface.php
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
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 5.0.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Datasource\Paging;
use Countable;
use Traversable;
/**
* This interface describes the methods for pagination instance.
*
* @template-extends \Traversable<mixed>
*/
interface PaginatedInterface extends Countable, Traversable
{
/**
* Get current page number.
*
* @return int
*/
public function currentPage(): int;
/**
* Get items per page.
*
* @return int
*/
public function perPage(): int;
/**
* Get Total items counts.
*
* @return int|null
*/
public function totalCount(): ?int;
/**
* Get total page count.
*
* @return int|null
*/
public function pageCount(): ?int;
/**
* Get whether there's a previous page.
*
* @return bool
*/
public function hasPrevPage(): bool;
/**
* Get whether there's a next page.
*
* @return bool
*/
public function hasNextPage(): bool;
/**
* Get paginated items.
*
* @return iterable
*/
public function items(): iterable;
/**
* Get paging param.
*
* @param string $name
* @return mixed
*/
public function pagingParam(string $name): mixed;
/**
* Get all paging params.
*
* @return array
*/
public function pagingParams(): array;
}