PaginatorInterface.php 1.3 KB

123456789101112131415161718192021222324252627282930313233343536373839
  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. * This interface describes the methods for paginator instance.
  18. */
  19. interface PaginatorInterface
  20. {
  21. /**
  22. * Handles pagination of datasource records.
  23. *
  24. * @param \Cake\Datasource\RepositoryInterface|\Cake\Datasource\QueryInterface $object The repository or query to paginate.
  25. * @param array $params Request params
  26. * @param array $settings The settings/configuration used for pagination.
  27. * @return \Cake\Datasource\ResultSetInterface Query results
  28. */
  29. public function paginate($object, array $params = [], array $settings = []);
  30. /**
  31. * Get paging params after pagination operation.
  32. *
  33. * @return array
  34. */
  35. public function getPagingParams();
  36. }