vendor/knplabs/knp-paginator-bundle/src/Twig/Extension/PaginationExtension.php line 39

Open in your IDE?
  1. <?php
  3. namespace Knp\Bundle\PaginatorBundle\Twig\Extension;
  5. use Knp\Bundle\PaginatorBundle\Helper\Processor;
  6. use Knp\Bundle\PaginatorBundle\Pagination\SlidingPaginationInterface;
  7. use Twig\Environment;
  8. use Twig\Extension\AbstractExtension;
  9. use Twig\TwigFunction;
  11. final class PaginationExtension extends AbstractExtension
  12. {
  13.     /**
  14.      * @var Processor
  15.      */
  16.     private $processor;
  18.     public function __construct(Processor $processor)
  19.     {
  20.         $this->processor = $processor;
  21.     }
  23.     public function getFunctions(): array
  24.     {
  25.         return [
  26.             new TwigFunction('knp_pagination_render', [$this, 'render'], ['is_safe' => ['html'], 'needs_environment' => true]),
  27.             new TwigFunction('knp_pagination_sortable', [$this, 'sortable'], ['is_safe' => ['html'], 'needs_environment' => true]),
  28.             new TwigFunction('knp_pagination_filter', [$this, 'filter'], ['is_safe' => ['html'], 'needs_environment' => true]),
  29.         ];
  30.     }
  32.     /**
  33.      * Renders the pagination template.
  34.      *
  35.      * @param \Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination<mixed> $pagination
  36.      * @param array<string, mixed>                                            $queryParams
  37.      * @param array<string, mixed>                                            $viewParams
  38.      */
  39.     public function render(Environment $env, SlidingPaginationInterface $pagination, ?string $template = null, ?array $queryParams = [], ?array $viewParams = []): string
  40.     {
  41.         return $env->render(
  42.             $template ?: $pagination->getTemplate(),
  43.             $this->processor->render($pagination, $queryParams ?? [], $viewParams ?? [])
  44.         );
  45.     }
  47.     /**
  48.      * Create a sort url for the field named $title
  49.      * and identified by $key which consists of
  50.      * alias and field. $options holds all link
  51.      * parameters like "alt, class" and so on.
  52.      *
  53.      * $key example: "article.title"
  54.      *
  55.      * @param \Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination<mixed> $pagination
  56.      * @param string|array<string, mixed>                                     $key
  57.      * @param array<string, mixed>                                            $options
  58.      * @param array<string, mixed>                                            $params
  59.      */
  60.     public function sortable(Environment $env, SlidingPaginationInterface $pagination, string $title, $key, array $options = [], array $params = [], ?string $template = null): string
  61.     {
  62.         return $env->render(
  63.             $template ?: $pagination->getSortableTemplate(),
  64.             $this->processor->sortable($pagination, $title, $key, $options, $params)
  65.         );
  66.     }
  68.     /**
  69.      * Create a filter url for the field named $title
  70.      * and identified by $key which consists of
  71.      * alias and field. $options holds all link
  72.      * parameters like "alt, class" and so on.
  73.      *
  74.      * $key example: "article.title"
  75.      *
  76.      * @param \Knp\Bundle\PaginatorBundle\Pagination\SlidingPagination<mixed> $pagination
  77.      * @param array<string, mixed>                                            $fields
  78.      * @param array<string, mixed>                                            $options
  79.      * @param array<string, mixed>|null                                       $params
  80.      */
  81.     public function filter(Environment $env, SlidingPaginationInterface $pagination, array $fields, ?array $options = [], ?array $params = [], ?string $template = null): string
  82.     {
  83.         return $env->render(
  84.             $template ?: $pagination->getFiltrationTemplate(),
  85.             $this->processor->filter($pagination, $fields, $options ?? [], $params ?? [])
  86.         );
  87.     }
  88. }