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

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 Symfony\Component\OptionsResolver\OptionsResolver;
  31. use Twig\Extension\RuntimeExtensionInterface;
  33. /**
  34.  * @method MenuRenderer menu()
  35.  * @method Breadcrumbs breadcrumbs()
  36.  *
  37.  */
  38. class Navigation implements RuntimeExtensionInterface
  39. {
  40.     use HelperCharsetTrait;
  42.     /**
  43.      * @var Builder
  44.      */
  45.     private $builder;
  47.     /**
  48.      * @var ContainerInterface
  49.      */
  50.     private $rendererLocator;
  52.     /**
  53.      * @param Builder $builder
  54.      * @param ContainerInterface $rendererLocator
  55.      */
  56.     public function __construct(Builder $builder, ContainerInterface $rendererLocator)
  57.     {
  58.         $this->builder = $builder;
  59.         $this->rendererLocator = $rendererLocator;
  60.     }
  62.     /**
  63.      * Builds a navigation container by passing params
  64.      * Possible config params are: 'root', 'htmlMenuPrefix', 'pageCallback', 'cache', 'maxDepth', 'active'
  65.      *
  66.      * @param array $params
  67.      *
  68.      * @return Container
  69.      *
  70.      * @throws \Exception
  71.      */
  72.     public function build(array $params): Container
  73.     {
  74.         $optionsResolver = new OptionsResolver();
  75.         $optionsResolver->setDefaults([
  76.            'root' => null,
  77.            'htmlMenuPrefix' => null,
  78.            'pageCallback' => null,
  79.            'cache' => true,
  80.            'cacheLifetime' => null,
  81.            'maxDepth' => null,
  82.            'active' => null,
  83.         ]);
  85.         $options = $optionsResolver->resolve($params);
  87.         return $this->builder->getNavigation(
  88.             $options['active'],
  89.             $options['root'],
  90.             $options['htmlMenuPrefix'],
  91.             $options['pageCallback'],
  92.             $options['cache'],
  93.             $options['maxDepth'],
  94.             $options['cacheLifetime']
  95.         );
  96.     }
  98.     /**
  99.      * Get a named renderer
  100.      *
  101.      * @param string $alias
  102.      *
  103.      * @return RendererInterface
  104.      */
  105.     public function getRenderer(string $alias): RendererInterface
  106.     {
  107.         if (!$this->rendererLocator->has($alias)) {
  108.             throw RendererNotFoundException::create($alias);
  109.         }
  111.         $renderer = $this->rendererLocator->get($alias);
  113.         if (!$renderer instanceof RendererInterface) {
  114.             throw InvalidRendererException::create($alias, $renderer);
  115.         }
  117.         return $renderer;
  118.     }
  120.     /**
  121.      * Renders a navigation with the given renderer
  122.      *
  123.      * @param Container $container
  124.      * @param string $rendererName
  125.      * @param string $renderMethod     Optional render method to use (e.g. menu -> renderMenu)
  126.      * @param array<int, mixed> $rendererArguments      Option arguments to pass to the render method after the container
  127.      *
  128.      * @return string
  129.      */
  130.     public function render(
  131.         Container $container,
  132.         string $rendererName = 'menu',
  133.         string $renderMethod = 'render',
  134.         ...$rendererArguments
  135.     ) {
  136.         $renderer = $this->getRenderer($rendererName);
  138.         if (!method_exists($renderer, $renderMethod)) {
  139.             throw new \InvalidArgumentException(sprintf('Method "%s" does not exist on renderer "%s"', $renderMethod, $rendererName));
  140.         }
  142.         $args = array_merge([$container], array_values($rendererArguments));
  144.         return call_user_func_array([$renderer, $renderMethod], $args);
  145.     }
  147.     /**
  148.      * Magic overload is an alias to getRenderer()
  149.      *
  150.      * @param string $method
  151.      * @param array $arguments
  152.      *
  153.      * @return RendererInterface
  154.      */
  155.     public function __call($method, array $arguments = []): RendererInterface
  156.     {
  157.         return $this->getRenderer($method);
  158.     }
  159. }