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

Open in your IDE?
  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.     /**
  16.      * @var Helper
  17.      */
  18.     private $helper;
  20.     /**
  21.      * @var MatcherInterface|null
  22.      */
  23.     private $matcher;
  25.     /**
  26.      * @var MenuManipulator|null
  27.      */
  28.     private $menuManipulator;
  30.     public function __construct(Helper $helper, ?MatcherInterface $matcher = null, ?MenuManipulator $menuManipulator = null)
  31.     {
  32.         $this->helper = $helper;
  33.         $this->matcher = $matcher;
  34.         $this->menuManipulator = $menuManipulator;
  35.     }
  37.     /**
  38.      * @return array<int, TwigFunction>
  39.      */
  40.     public function getFunctions(): array
  41.     {
  42.         return [
  43.              new TwigFunction('knp_menu_get', [$this, 'get']),
  44.              new TwigFunction('knp_menu_render', [$this, 'render'], ['is_safe' => ['html']]),
  45.              new TwigFunction('knp_menu_get_breadcrumbs_array', [$this, 'getBreadcrumbsArray']),
  46.              new TwigFunction('knp_menu_get_current_item', [$this, 'getCurrentItem']),
  47.         ];
  48.     }
  50.     /**
  51.      * @return array<int, TwigFilter>
  52.      */
  53.     public function getFilters(): array
  54.     {
  55.         return [
  56.             new TwigFilter('knp_menu_as_string', [$this, 'pathAsString']),
  57.         ];
  58.     }
  60.     /**
  61.      * @return array<int, TwigTest>
  62.      */
  63.     public function getTests(): array
  64.     {
  65.         return [
  66.             new TwigTest('knp_menu_current', [$this, 'isCurrent']),
  67.             new TwigTest('knp_menu_ancestor', [$this, 'isAncestor']),
  68.         ];
  69.     }
  71.     /**
  72.      * Retrieves an item following a path in the tree.
  73.      *
  74.      * @param ItemInterface|string $menu
  75.      * @param array<int, string>   $path
  76.      * @param array<string, mixed> $options
  77.      */
  78.     public function get($menu, array $path = [], array $options = []): ItemInterface
  79.     {
  80.         return $this->helper->get($menu, $path, $options);
  81.     }
  83.     /**
  84.      * Renders a menu with the specified renderer.
  85.      *
  86.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  87.      * @param array<string, mixed>                             $options
  88.      */
  89.     public function render($menu, array $options = [], ?string $renderer = null): string
  90.     {
  91.         return $this->helper->render($menu, $options, $renderer);
  92.     }
  94.     /**
  95.      * Returns an array ready to be used for breadcrumbs.
  96.      *
  97.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  98.      * @param string|array<string|null>|null                   $subItem
  99.      * @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
  100.      *
  101.      * @return array<int, array<string, mixed>>
  102.      * @phpstan-return list<array{label: string, uri: string|null, item: ItemInterface|null}>
  103.      */
  104.     public function getBreadcrumbsArray($menu, $subItem = null): array
  105.     {
  106.         return $this->helper->getBreadcrumbsArray($menu, $subItem);
  107.     }
  109.     /**
  110.      * Returns the current item of a menu.
  111.      *
  112.      * @param ItemInterface|string $menu
  113.      */
  114.     public function getCurrentItem($menu): ItemInterface
  115.     {
  116.         $rootItem = $this->get($menu);
  118.         $currentItem = $this->helper->getCurrentItem($rootItem);
  120.         if (null === $currentItem) {
  121.             $currentItem = $rootItem;
  122.         }
  124.         return $currentItem;
  125.     }
  127.     /**
  128.      * A string representation of this menu item
  129.      *
  130.      * e.g. Top Level > Second Level > This menu
  131.      */
  132.     public function pathAsString(ItemInterface $menu, string $separator = ' > '): string
  133.     {
  134.         if (null === $this->menuManipulator) {
  135.             throw new \BadMethodCallException('The menu manipulator must be set to get the breadcrumbs array');
  136.         }
  138.         return $this->menuManipulator->getPathAsString($menu, $separator);
  139.     }
  141.     /**
  142.      * Checks whether an item is current.
  143.      */
  144.     public function isCurrent(ItemInterface $item): bool
  145.     {
  146.         if (null === $this->matcher) {
  147.             throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  148.         }
  150.         return $this->matcher->isCurrent($item);
  151.     }
  153.     /**
  154.      * Checks whether an item is the ancestor of a current item.
  155.      *
  156.      * @param int|null $depth The max depth to look for the item
  157.      */
  158.     public function isAncestor(ItemInterface $item, ?int $depth = null): bool
  159.     {
  160.         if (null === $this->matcher) {
  161.             throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  162.         }
  164.         return $this->matcher->isAncestor($item, $depth);
  165.     }
  166. }