vendor/pimcore/pimcore/lib/Twig/Extension/Templating/Navigation.php line 71

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /**
  6. * Pimcore
  7. *
  8. * This source file is available under two different licenses:
  9. * - GNU General Public License version 3 (GPLv3)
  10. * - Pimcore Commercial License (PCL)
  11. * Full copyright and license information is available in
  12. * LICENSE.md which is distributed with this source code.
  13. *
  14. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  15. * @license http://www.pimcore.org/license GPLv3 and PCL
  16. */
  18. namespace Pimcore\Twig\Extension\Templating;
  20. use Pimcore\Navigation\Builder;
  21. use Pimcore\Navigation\Container;
  22. use Pimcore\Navigation\Renderer\Breadcrumbs;
  23. use Pimcore\Navigation\Renderer\Menu;
  24. use Pimcore\Navigation\Renderer\Menu as MenuRenderer;
  25. use Pimcore\Navigation\Renderer\RendererInterface;
  26. use Pimcore\Twig\Extension\Templating\Navigation\Exception\InvalidRendererException;
  27. use Pimcore\Twig\Extension\Templating\Navigation\Exception\RendererNotFoundException;
  28. use Pimcore\Twig\Extension\Templating\Traits\HelperCharsetTrait;
  29. use Psr\Container\ContainerInterface;
  30. use Twig\Extension\RuntimeExtensionInterface;
  32. /**
  33. * @method MenuRenderer menu()
  34. * @method Breadcrumbs breadcrumbs()
  35. *
  36. */
  37. class Navigation implements RuntimeExtensionInterface
  38. {
  39. use HelperCharsetTrait;
  41. /**
  42. * @var Builder
  43. */
  44. private $builder;
  46. /**
  47. * @var ContainerInterface
  48. */
  49. private $rendererLocator;
  51. /**
  52. * @param Builder $builder
  53. * @param ContainerInterface $rendererLocator
  54. */
  55. public function __construct(Builder $builder, ContainerInterface $rendererLocator)
  56. {
  57. $this->builder = $builder;
  58. $this->rendererLocator = $rendererLocator;
  59. }
  61. /**
  62. * Builds a navigation container by passing params
  63. * Possible config params are: 'root', 'htmlMenuPrefix', 'pageCallback', 'cache', 'cacheLifetime', 'maxDepth', 'active', 'markActiveTrail'
  64. *
  65. * @param array $params
  66. *
  67. * @return Container
  68. *
  69. * @throws \Exception
  70. */
  71. public function build(array $params): Container
  72. {
  73. return $this->builder->getNavigation($params);
  74. }
  76. /**
  77. * Get a named renderer
  78. *
  79. * @param string $alias
  80. *
  81. * @return RendererInterface
  82. */
  83. public function getRenderer(string $alias): RendererInterface
  84. {
  85. if (!$this->rendererLocator->has($alias)) {
  86. throw RendererNotFoundException::create($alias);
  87. }
  89. $renderer = $this->rendererLocator->get($alias);
  91. if (!$renderer instanceof RendererInterface) {
  92. throw InvalidRendererException::create($alias, $renderer);
  93. }
  95. return $renderer;
  96. }
  98. /**
  99. * Renders a navigation with the given renderer
  100. *
  101. * @param Container $container
  102. * @param string $rendererName
  103. * @param string $renderMethod Optional render method to use (e.g. menu -> renderMenu)
  104. * @param array<int, mixed> $rendererArguments Option arguments to pass to the render method after the container
  105. *
  106. * @return string
  107. */
  108. public function render(
  109. Container $container,
  110. string $rendererName = 'menu',
  111. string $renderMethod = 'render',
  112. ...$rendererArguments
  113. ) {
  114. $renderer = $this->getRenderer($rendererName);
  116. if (!method_exists($renderer, $renderMethod)) {
  117. throw new \InvalidArgumentException(sprintf('Method "%s" does not exist on renderer "%s"', $renderMethod, $rendererName));
  118. }
  120. $args = array_merge([$container], array_values($rendererArguments));
  122. return call_user_func_array([$renderer, $renderMethod], $args);
  123. }
  125. /**
  126. * Magic overload is an alias to getRenderer()
  127. *
  128. * @param string $method
  129. * @param array $arguments
  130. *
  131. * @return RendererInterface
  132. */
  133. public function __call($method, array $arguments = []): RendererInterface
  134. {
  135. return $this->getRenderer($method);
  136. }
  137. }