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

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 as MenuRenderer;
  24. use Pimcore\Navigation\Renderer\RendererInterface;
  25. use Pimcore\Twig\Extension\Templating\Navigation\Exception\InvalidRendererException;
  26. use Pimcore\Twig\Extension\Templating\Navigation\Exception\RendererNotFoundException;
  27. use Pimcore\Twig\Extension\Templating\Traits\HelperCharsetTrait;
  28. use Psr\Container\ContainerInterface;
  29. use Twig\Extension\RuntimeExtensionInterface;
  31. /**
  32. * @method MenuRenderer menu()
  33. * @method Breadcrumbs breadcrumbs()
  34. *
  35. */
  36. class Navigation implements RuntimeExtensionInterface
  37. {
  38. use HelperCharsetTrait;
  40. /**
  41. * @var Builder
  42. */
  43. private $builder;
  45. /**
  46. * @var ContainerInterface
  47. */
  48. private $rendererLocator;
  50. /**
  51. * @param Builder $builder
  52. * @param ContainerInterface $rendererLocator
  53. */
  54. public function __construct(Builder $builder, ContainerInterface $rendererLocator)
  55. {
  56. $this->builder = $builder;
  57. $this->rendererLocator = $rendererLocator;
  58. }
  60. /**
  61. * Builds a navigation container by passing params
  62. * Possible config params are: 'root', 'htmlMenuPrefix', 'pageCallback', 'cache', 'cacheLifetime', 'maxDepth', 'active', 'markActiveTrail'
  63. *
  64. * @param array $params
  65. *
  66. * @return Container
  67. *
  68. * @throws \Exception
  69. */
  70. public function build(array $params): Container
  71. {
  72. return $this->builder->getNavigation($params);
  73. }
  75. /**
  76. * Get a named renderer
  77. *
  78. * @param string $alias
  79. *
  80. * @return RendererInterface
  81. */
  82. public function getRenderer(string $alias): RendererInterface
  83. {
  84. if (!$this->rendererLocator->has($alias)) {
  85. throw RendererNotFoundException::create($alias);
  86. }
  88. $renderer = $this->rendererLocator->get($alias);
  90. if (!$renderer instanceof RendererInterface) {
  91. throw InvalidRendererException::create($alias, $renderer);
  92. }
  94. return $renderer;
  95. }
  97. /**
  98. * Renders a navigation with the given renderer
  99. *
  100. * @param Container $container
  101. * @param string $rendererName
  102. * @param string $renderMethod Optional render method to use (e.g. menu -> renderMenu)
  103. * @param array<int, mixed> $rendererArguments Option arguments to pass to the render method after the container
  104. *
  105. * @return string
  106. */
  107. public function render(
  108. Container $container,
  109. string $rendererName = 'menu',
  110. string $renderMethod = 'render',
  111. ...$rendererArguments
  112. ) {
  113. $renderer = $this->getRenderer($rendererName);
  115. if (!method_exists($renderer, $renderMethod)) {
  116. throw new \InvalidArgumentException(sprintf('Method "%s" does not exist on renderer "%s"', $renderMethod, $rendererName));
  117. }
  119. $args = array_merge([$container], array_values($rendererArguments));
  121. return call_user_func_array([$renderer, $renderMethod], $args);
  122. }
  124. /**
  125. * Magic overload is an alias to getRenderer()
  126. *
  127. * @param string $method
  128. * @param array $arguments
  129. *
  130. * @return RendererInterface
  131. */
  132. public function __call($method, array $arguments = []): RendererInterface
  133. {
  134. return $this->getRenderer($method);
  135. }
  136. }