vendor/knplabs/knp-components/src/Knp/Component/Pager/PaginatorInterface.php line 46

Open in your IDE?
  1. <?php
  3. namespace Knp\Component\Pager;
  5. use Knp\Component\Pager\Pagination\PaginationInterface;
  7. /**
  8. * PaginatorInterface
  9. */
  10. interface PaginatorInterface
  11. {
  12. public const DEFAULT_SORT_FIELD_NAME = 'defaultSortFieldName';
  13. public const DEFAULT_SORT_DIRECTION = 'defaultSortDirection';
  14. public const DEFAULT_FILTER_FIELDS = 'defaultFilterFields';
  15. public const SORT_FIELD_PARAMETER_NAME = 'sortFieldParameterName';
  16. public const SORT_FIELD_ALLOW_LIST = 'sortFieldAllowList';
  17. public const SORT_DIRECTION_PARAMETER_NAME = 'sortDirectionParameterName';
  18. public const PAGE_PARAMETER_NAME = 'pageParameterName';
  19. public const FILTER_FIELD_PARAMETER_NAME = 'filterFieldParameterName';
  20. public const FILTER_VALUE_PARAMETER_NAME = 'filterValueParameterName';
  21. public const FILTER_FIELD_ALLOW_LIST = 'filterFieldAllowList';
  22. public const DISTINCT = 'distinct';
  23. public const PAGE_OUT_OF_RANGE = 'pageOutOfRange';
  24. public const DEFAULT_LIMIT = 'defaultLimit';
  25. public const ODM_QUERY_OPTIONS = 'odmQueryOptions';
  27. public const PAGE_OUT_OF_RANGE_IGNORE = 'ignore'; // do nothing (default)
  28. public const PAGE_OUT_OF_RANGE_FIX = 'fix'; // replace page number out of range with max page
  29. public const PAGE_OUT_OF_RANGE_THROW_EXCEPTION = 'throwException'; // throw PageNumberOutOfRangeException
  30. public const DEFAULT_LIMIT_VALUE = 10;
  32. /**
  33. * Paginates anything (depending on event listeners)
  34. * into Pagination object, which is a view targeted
  35. * pagination object (might be aggregated helper object)
  36. * responsible for the pagination result representation
  37. *
  38. * @param mixed $target anything what needs to be paginated
  39. * @param int $page page number, starting from 1
  40. * @param int|null $limit number of items per page
  41. * @param array $options less used options:
  42. * bool $distinct default true for distinction of results
  43. * string $alias pagination alias, default none
  44. * array $sortFieldAllowList sortable allow list for target fields being paginated
  45. */
  46. public function paginate($target, int $page = 1, int $limit = null, array $options = []): PaginationInterface;
  47. }