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

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\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);
  44. }
  46. foreach ($path as $child) {
  47. $menu = $menu->getChild($child);
  48. if (null === $menu) {
  49. throw new \InvalidArgumentException(\sprintf('The menu has no child named "%s"', $child));
  50. }
  51. }
  53. return $menu;
  54. }
  56. /**
  57. * Renders a menu with the specified renderer.
  58. *
  59. * If the argument is an array, it will follow the path in the tree to
  60. * get the needed item. The first element of the array is the whole menu.
  61. * If the menu is a string instead of an ItemInterface, the provider
  62. * will be used.
  63. *
  64. * @param ItemInterface|string|array<ItemInterface|string> $menu
  65. * @param array<string, mixed> $options
  66. *
  67. * @throws \InvalidArgumentException
  68. */
  69. public function render($menu, array $options = [], ?string $renderer = null): string
  70. {
  71. $menu = $this->castMenu($menu);
  73. return $this->rendererProvider->get($renderer)->render($menu, $options);
  74. }
  76. /**
  77. * Renders an array ready to be used for breadcrumbs.
  78. *
  79. * Each element in the array will be an array with 3 keys:
  80. * - `label` containing the label of the item
  81. * - `uri` containing the url of the item (may be `null`)
  82. * - `item` containing the original item (may be `null` for the extra items)
  83. *
  84. * The subItem can be one of the following forms
  85. * * 'subItem'
  86. * * ItemInterface object
  87. * * ['subItem' => '@homepage']
  88. * * ['subItem1', 'subItem2']
  89. * * [['label' => 'subItem1', 'uri' => '@homepage'], ['label' => 'subItem2']]
  90. *
  91. * @param mixed $menu
  92. * @param mixed $subItem A string or array to append onto the end of the array
  93. *
  94. * @phpstan-param string|ItemInterface|array<int|string, string|int|float|null|array{label: string, uri: string|null, item: ItemInterface|null}|ItemInterface>|\Traversable<string|int|float|null|array{label: string, uri: string|null, item: ItemInterface|null}|ItemInterface> $subItem
  95. *
  96. * @return array<int, array<string, mixed>>
  97. *
  98. * @phpstan-return list<array{label: string, uri: string|null, item: ItemInterface|null}>
  99. */
  100. public function getBreadcrumbsArray($menu, $subItem = null): array
  101. {
  102. if (null === $this->menuManipulator) {
  103. throw new \BadMethodCallException('The menu manipulator must be set to get the breadcrumbs array');
  104. }
  106. $menu = $this->castMenu($menu);
  108. return $this->menuManipulator->getBreadcrumbsArray($menu, $subItem);
  109. }
  111. /**
  112. * Returns the current item of a menu.
  113. *
  114. * @param ItemInterface|string|array<ItemInterface|string> $menu
  115. */
  116. public function getCurrentItem($menu): ?ItemInterface
  117. {
  118. $menu = $this->castMenu($menu);
  120. return $this->retrieveCurrentItem($menu);
  121. }
  123. /**
  124. * @param ItemInterface|string|array<ItemInterface|string> $menu
  125. */
  126. private function castMenu($menu): ItemInterface
  127. {
  128. if (!$menu instanceof ItemInterface) {
  129. $path = [];
  130. if (\is_array($menu)) {
  131. if (empty($menu)) {
  132. throw new \InvalidArgumentException('The array cannot be empty');
  133. }
  134. $path = $menu;
  135. $menu = \array_shift($path);
  136. }
  138. return $this->get($menu, $path);
  139. }
  141. return $menu;
  142. }
  144. private function retrieveCurrentItem(ItemInterface $item): ?ItemInterface
  145. {
  146. if (null === $this->matcher) {
  147. throw new \BadMethodCallException('The matcher must be set to get the current item of a menu');
  148. }
  150. if ($this->matcher->isCurrent($item)) {
  151. return $item;
  152. }
  154. if ($this->matcher->isAncestor($item)) {
  155. foreach ($item->getChildren() as $child) {
  156. $currentItem = $this->retrieveCurrentItem($child);
  158. if (null !== $currentItem) {
  159. return $currentItem;
  160. }
  161. }
  162. }
  164. return null;
  165. }
  166. }