1: <?php
2: /**
3: * CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
4: * Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
5: *
6: * Licensed under The MIT License
7: * For full copyright and license information, please see the LICENSE.txt
8: * Redistributions of files must retain the above copyright notice.
9: *
10: * @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
11: * @link http://cakephp.org CakePHP(tm) Project
12: * @since 3.5.0
13: * @license http://www.opensource.org/licenses/mit-license.php MIT License
14: */
15: namespace Cake\Datasource;
16:
17: /**
18: * This interface describes the methods for paginator instance.
19: */
20: interface PaginatorInterface
21: {
22: /**
23: * Handles pagination of datasource records.
24: *
25: * @param \Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object The repository or query to paginate.
26: * @param array $params Request params
27: * @param array $settings The settings/configuration used for pagination.
28: * @return \Cake\Datasource\ResultSetInterface Query results
29: */
30: public function paginate($object, array $params = [], array $settings = []);
31:
32: /**
33: * Get paging params after pagination operation.
34: *
35: * @return array
36: */
37: public function getPagingParams();
38: }
39: