51 lines
1.6 KiB
PHP
51 lines
1.6 KiB
PHP
|
<?php
|
||
|
|
declare(strict_types=1);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
|
||
|
|
* Copyright (c) Cake Software Foundation, Inc. (https://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. (https://cakefoundation.org)
|
||
|
|
* @link https://cakephp.org CakePHP(tm) Project
|
||
|
|
* @since 3.5.0
|
||
|
|
* @license https://www.opensource.org/licenses/mit-license.php MIT License
|
||
|
|
*/
|
||
|
|
namespace Cake\Datasource\Paging;
|
||
|
|
|
||
|
|
use Cake\Datasource\ResultSetInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* This interface describes the methods for paginator instance.
|
||
|
|
*/
|
||
|
|
interface PaginatorInterface
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Handles pagination of datasource records.
|
||
|
|
*
|
||
|
|
* @param \Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object The repository or query
|
||
|
|
* to paginate.
|
||
|
|
* @param array $params Request params
|
||
|
|
* @param array $settings The settings/configuration used for pagination.
|
||
|
|
* @return \Cake\Datasource\ResultSetInterface Query results
|
||
|
|
*/
|
||
|
|
public function paginate(object $object, array $params = [], array $settings = []): ResultSetInterface;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Get paging params after pagination operation.
|
||
|
|
*
|
||
|
|
* @return array
|
||
|
|
*/
|
||
|
|
public function getPagingParams(): array;
|
||
|
|
}
|
||
|
|
|
||
|
|
// phpcs:disable
|
||
|
|
class_alias(
|
||
|
|
'Cake\Datasource\Paging\PaginatorInterface',
|
||
|
|
'Cake\Datasource\PaginatorInterface'
|
||
|
|
);
|
||
|
|
// phpcs:enable
|