vendor/knplabs/knp-menu/src/Knp/Menu/Twig/MenuRuntimeExtension.php line 43

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\RuntimeExtensionInterface;
  10. /**
  11. * @final since 3.8.0
  12. */
  13. class MenuRuntimeExtension implements RuntimeExtensionInterface
  14. {
  15. public function __construct(
  16. private readonly Helper $helper,
  17. private readonly ?MatcherInterface $matcher = null,
  18. private readonly ?MenuManipulator $menuManipulator = null,
  19. ) {
  20. }
  22. /**
  23. * Retrieves an item following a path in the tree.
  24. *
  25. * @param array<int, string> $path
  26. * @param array<string, mixed> $options
  27. *
  28. * @internal since 3.8.0
  29. */
  30. public function get(ItemInterface|string $menu, array $path = [], array $options = []): ItemInterface
  31. {
  32. return $this->helper->get($menu, $path, $options);
  33. }
  35. /**
  36. * Renders a menu with the specified renderer.
  37. *
  38. * @param string|ItemInterface|array<ItemInterface|string> $menu
  39. * @param array<string, mixed> $options
  40. *
  41. * @internal since 3.8.0
  42. */
  43. public function render(array|ItemInterface|string $menu, array $options = [], ?string $renderer = null): string
  44. {
  45. return $this->helper->render($menu, $options, $renderer);
  46. }
  48. /**
  49. * Returns an array ready to be used for breadcrumbs.
  50. *
  51. * @param string|ItemInterface|array<ItemInterface|string> $menu
  52. *
  53. * @phpstan-param string|array<int|string, string|int|float|null|array{label: string, uri: string|null, item: ItemInterface|null}|ItemInterface> $subItem
  54. *
  55. * @return array<int, array<string, mixed>>
  56. * @phpstan-return list<array{label: string, uri: string|null, item: ItemInterface|null}>
  57. *
  58. * @internal since 3.8.0
  59. */
  60. public function getBreadcrumbsArray(array|ItemInterface|string $menu, array|string|null $subItem = null): array
  61. {
  62. return $this->helper->getBreadcrumbsArray($menu, $subItem);
  63. }
  65. /**
  66. * Returns the current item of a menu.
  67. *
  68. * @internal since 3.8.0
  69. */
  70. public function getCurrentItem(ItemInterface|string $menu): ItemInterface
  71. {
  72. $rootItem = $this->get($menu);
  74. $currentItem = $this->helper->getCurrentItem($rootItem);
  76. if (null === $currentItem) {
  77. $currentItem = $rootItem;
  78. }
  80. return $currentItem;
  81. }
  83. /**
  84. * A string representation of this menu item
  85. *
  86. * e.g. Top Level > Second Level > This menu
  87. *
  88. * @internal since 3.8.0
  89. */
  90. public function pathAsString(ItemInterface $menu, string $separator = ' > '): string
  91. {
  92. if (null === $this->menuManipulator) {
  93. throw new \BadMethodCallException('The menu manipulator must be set to get the breadcrumbs array');
  94. }
  96. return $this->menuManipulator->getPathAsString($menu, $separator);
  97. }
  99. /**
  100. * Checks whether an item is current.
  101. *
  102. * @internal since 3.8.0
  103. */
  104. public function isCurrent(ItemInterface $item): bool
  105. {
  106. if (null === $this->matcher) {
  107. throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  108. }
  110. return $this->matcher->isCurrent($item);
  111. }
  113. /**
  114. * Checks whether an item is the ancestor of a current item.
  115. *
  116. * @param int|null $depth The max depth to look for the item
  117. *
  118. * @internal since 3.8.0
  119. */
  120. public function isAncestor(ItemInterface $item, ?int $depth = null): bool
  121. {
  122. if (null === $this->matcher) {
  123. throw new \BadMethodCallException('The matcher must be set to get the breadcrumbs array');
  124. }
  126. return $this->matcher->isAncestor($item, $depth);
  127. }
  128. }