vendor/knplabs/knp-menu/src/Knp/Menu/Twig/Helper.php line 35

  1. <?php
  3. namespace Knp\Menu\Twig;
  5. use Knp\Menu\ItemInterface;
  6. use Knp\Menu\Matcher\MatcherInterface;
  7. use Knp\Menu\Provider\MenuProviderInterface;
  8. use Knp\Menu\Renderer\RendererProviderInterface;
  9. use Knp\Menu\Util\MenuManipulator;
  11. /**
  12.  * Helper class containing logic to retrieve and render menus from templating engines
  13.  */
  14. class Helper
  15. {
  16.     public function __construct(
  17.         private RendererProviderInterface $rendererProvider,
  18.         private ?MenuProviderInterface $menuProvider = null,
  19.         private ?MenuManipulator $menuManipulator = null,
  20.         private ?MatcherInterface $matcher = null
  21.     ) {
  22.     }
  24.     /**
  25.      * Retrieves item in the menu, eventually using the menu provider.
  26.      *
  27.      * @param ItemInterface|string $menu
  28.      * @param array<int, string>   $path
  29.      * @param array<string, mixed> $options
  30.      *
  31.      * @throws \BadMethodCallException   when there is no menu provider and the menu is given by name
  32.      * @throws \LogicException
  33.      * @throws \InvalidArgumentException when the path is invalid
  34.      */
  35.     public function get($menu, array $path = [], array $options = []): ItemInterface
  36.     {
  37.         if (!$menu instanceof ItemInterface) {
  38.             if (null === $this->menuProvider) {
  39.                 throw new \BadMethodCallException('A menu provider must be set to retrieve a menu');
  40.             }
  42.             $menuName = $menu;
  43.             $menu = $this->menuProvider->get($menuName, $options);
  45.             if (!$menu instanceof ItemInterface) {
  46.                 throw new \LogicException(\sprintf('The menu "%s" exists, but is not a valid menu item object. Check where you created the menu to be sure it returns an ItemInterface object.', $menuName));
  47.             }
  48.         }
  50.         foreach ($path as $child) {
  51.             $menu = $menu->getChild($child);
  52.             if (null === $menu) {
  53.                 throw new \InvalidArgumentException(\sprintf('The menu has no child named "%s"', $child));
  54.             }
  55.         }
  57.         return $menu;
  58.     }
  60.     /**
  61.      * Renders a menu with the specified renderer.
  62.      *
  63.      * If the argument is an array, it will follow the path in the tree to
  64.      * get the needed item. The first element of the array is the whole menu.
  65.      * If the menu is a string instead of an ItemInterface, the provider
  66.      * will be used.
  67.      *
  68.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  69.      * @param array<string, mixed>                             $options
  70.      *
  71.      * @throws \InvalidArgumentException
  72.      */
  73.     public function render($menu, array $options = [], ?string $renderer = null): string
  74.     {
  75.         $menu = $this->castMenu($menu);
  77.         return $this->rendererProvider->get($renderer)->render($menu, $options);
  78.     }
  80.     /**
  81.      * Renders an array ready to be used for breadcrumbs.
  82.      *
  83.      * Each element in the array will be an array with 3 keys:
  84.      * - `label` containing the label of the item
  85.      * - `url` containing the url of the item (may be `null`)
  86.      * - `item` containing the original item (may be `null` for the extra items)
  87.      *
  88.      * The subItem can be one of the following forms
  89.      *   * 'subItem'
  90.      *   * ItemInterface object
  91.      *   * ['subItem' => '@homepage']
  92.      *   * ['subItem1', 'subItem2']
  93.      *   * [['label' => 'subItem1', 'url' => '@homepage'], ['label' => 'subItem2']]
  94.      *
  95.      * @param mixed $menu
  96.      * @param mixed $subItem A string or array to append onto the end of the array
  97.      *
  98.      * @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
  99.      *
  100.      * @return array<int, array<string, mixed>>
  101.      *
  102.      * @phpstan-return list<array{label: string, uri: string|null, item: ItemInterface|null}>
  103.      */
  104.     public function getBreadcrumbsArray($menu, $subItem = null): array
  105.     {
  106.         if (null === $this->menuManipulator) {
  107.             throw new \BadMethodCallException('The menu manipulator must be set to get the breadcrumbs array');
  108.         }
  110.         $menu = $this->castMenu($menu);
  112.         return $this->menuManipulator->getBreadcrumbsArray($menu, $subItem);
  113.     }
  115.     /**
  116.      * Returns the current item of a menu.
  117.      *
  118.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  119.      */
  120.     public function getCurrentItem($menu): ?ItemInterface
  121.     {
  122.         $menu = $this->castMenu($menu);
  124.         return $this->retrieveCurrentItem($menu);
  125.     }
  127.     /**
  128.      * @param ItemInterface|string|array<ItemInterface|string> $menu
  129.      */
  130.     private function castMenu($menu): ItemInterface
  131.     {
  132.         if (!$menu instanceof ItemInterface) {
  133.             $path = [];
  134.             if (\is_array($menu)) {
  135.                 if (empty($menu)) {
  136.                     throw new \InvalidArgumentException('The array cannot be empty');
  137.                 }
  138.                 $path = $menu;
  139.                 $menu = \array_shift($path);
  140.             }
  142.             return $this->get($menu, $path);
  143.         }
  145.         return $menu;
  146.     }
  148.     private function retrieveCurrentItem(ItemInterface $item): ?ItemInterface
  149.     {
  150.         if (null === $this->matcher) {
  151.             throw new \BadMethodCallException('The matcher must be set to get the current item of a menu');
  152.         }
  154.         if ($this->matcher->isCurrent($item)) {
  155.             return $item;
  156.         }
  158.         if ($this->matcher->isAncestor($item)) {
  159.             foreach ($item->getChildren() as $child) {
  160.                 $currentItem = $this->retrieveCurrentItem($child);
  162.                 if (null !== $currentItem) {
  163.                     return $currentItem;
  164.                 }
  165.             }
  166.         }
  168.         return null;
  169.     }
  170. }