vendor/knplabs/knp-menu/src/Knp/Menu/Twig/MenuExtension.php line 62

  1. <?php
  3. namespace Knp\Menu\Twig;
  5. use Knp\Menu\ItemInterface;
  6. use Knp\Menu\Matcher\MatcherInterface;
  7. use Knp\Menu\Util\MenuManipulator;
  8. use Twig\Extension\AbstractExtension;
  9. use Twig\TwigFilter;
  10. use Twig\TwigFunction;
  11. use Twig\TwigTest;
  13. class MenuExtension extends AbstractExtension
  14. {
  15.     public function __construct(private Helper $helper, private ?MatcherInterface $matcher = null, private ?MenuManipulator $menuManipulator = null)
  16.     {
  17.     }
  19.     /**
  20.      * @return array<int, TwigFunction>
  21.      */
  22.     public function getFunctions(): array
  23.     {
  24.         return [
  25.              new TwigFunction('knp_menu_get', [$this, 'get']),
  26.              new TwigFunction('knp_menu_render', [$this, 'render'], ['is_safe' => ['html']]),
  27.              new TwigFunction('knp_menu_get_breadcrumbs_array', [$this, 'getBreadcrumbsArray']),
  28.              new TwigFunction('knp_menu_get_current_item', [$this, 'getCurrentItem']),
  29.         ];
  30.     }
  32.     /**
  33.      * @return array<int, TwigFilter>
  34.      */
  35.     public function getFilters(): array
  36.     {
  37.         return [
  38.             new TwigFilter('knp_menu_as_string', [$this, 'pathAsString']),
  39.         ];
  40.     }
  42.     /**
  43.      * @return array<int, TwigTest>
  44.      */
  45.     public function getTests(): array
  46.     {
  47.         return [
  48.             new TwigTest('knp_menu_current', [$this, 'isCurrent']),
  49.             new TwigTest('knp_menu_ancestor', [$this, 'isAncestor']),
  50.         ];
  51.     }
  53.     /**
  54.      * Retrieves an item following a path in the tree.
  55.      *
  56.      * @param ItemInterface|string $menu
  57.      * @param array<int, string>   $path
  58.      * @param array<string, mixed> $options
  59.      */
  60.     public function get($menu, array $path = [], array $options = []): ItemInterface
  61.     {
  62.         return $this->helper->get($menu, $path, $options);
  63.     }
  65.     /**
  66.      * Renders a menu with the specified renderer.
  67.      *
  68.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  69.      * @param array<string, mixed>                             $options
  70.      */
  71.     public function render($menu, array $options = [], ?string $renderer = null): string
  72.     {
  73.         return $this->helper->render($menu, $options, $renderer);
  74.     }
  76.     /**
  77.      * Returns an array ready to be used for breadcrumbs.
  78.      *
  79.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  80.      * @param string|array<string|null>|null                   $subItem
  81.      *
  82.      * @phpstan-param string|ItemInterface|array<int|string, string|int|float|null|array{label: string, url: string|null, item: ItemInterface|null}|ItemInterface>|\Traversable<string|int|float|null|array{label: string, url: string|null, item: ItemInterface|null}|ItemInterface> $subItem
  83.      *
  84.      * @return array<int, array<string, mixed>>
  85.      * @phpstan-return list<array{label: string, uri: string|null, item: ItemInterface|null}>
  86.      */
  87.     public function getBreadcrumbsArray($menu, $subItem = null): array
  88.     {
  89.         return $this->helper->getBreadcrumbsArray($menu, $subItem);
  90.     }
  92.     /**
  93.      * Returns the current item of a menu.
  94.      *
  95.      * @param ItemInterface|string $menu
  96.      */
  97.     public function getCurrentItem($menu): ItemInterface
  98.     {
  99.         $rootItem = $this->get($menu);
  101.         $currentItem = $this->helper->getCurrentItem($rootItem);
  103.         if (null === $currentItem) {
  104.             $currentItem = $rootItem;
  105.         }
  107.         return $currentItem;
  108.     }
  110.     /**
  111.      * A string representation of this menu item
  112.      *
  113.      * e.g. Top Level > Second Level > This menu
  114.      */
  115.     public function pathAsString(ItemInterface $menu, string $separator = ' > '): string
  116.     {
  117.         if (null === $this->menuManipulator) {
  118.             throw new \BadMethodCallException('The menu manipulator must be set to get the breadcrumbs array');
  119.         }
  121.         return $this->menuManipulator->getPathAsString($menu, $separator);
  122.     }
  124.     /**
  125.      * Checks whether an item is current.
  126.      */
  127.     public function isCurrent(ItemInterface $item): bool
  128.     {
  129.         if (null === $this->matcher) {
  130.             throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  131.         }
  133.         return $this->matcher->isCurrent($item);
  134.     }
  136.     /**
  137.      * Checks whether an item is the ancestor of a current item.
  138.      *
  139.      * @param int|null $depth The max depth to look for the item
  140.      */
  141.     public function isAncestor(ItemInterface $item, ?int $depth = null): bool
  142.     {
  143.         if (null === $this->matcher) {
  144.             throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  145.         }
  147.         return $this->matcher->isAncestor($item, $depth);
  148.     }
  149. }