vendor/pimcore/pimcore/lib/Twig/Extension/NavigationExtension.php line 69

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;
  20. use Pimcore\Model\Document;
  21. use Pimcore\Navigation\Container;
  22. use Pimcore\Navigation\Renderer\RendererInterface;
  23. use Pimcore\Twig\Extension\Templating\Navigation;
  24. use Twig\Extension\AbstractExtension;
  25. use Twig\TwigFunction;
  27. /**
  28.  * @internal
  29.  */
  30. class NavigationExtension extends AbstractExtension
  31. {
  32.     /**
  33.      * @var Navigation
  34.      */
  35.     private $navigationExtension;
  37.     /**
  38.      * @param Navigation $navigationExtension
  39.      */
  40.     public function __construct(Navigation $navigationExtension)
  41.     {
  42.         $this->navigationExtension = $navigationExtension;
  43.     }
  45.     public function getFunctions(): array
  46.     {
  47.         return [
  48.             new TwigFunction('pimcore_build_nav', [$this, 'buildNavigation']),
  49.             new TwigFunction('pimcore_render_nav', [$this, 'render'], [
  50.                 'is_safe' => ['html'],
  51.             ]),
  52.             new TwigFunction('pimcore_nav_renderer', [$this, 'getRenderer']),
  53.         ];
  54.     }
  56.     /**
  57.      * This is essentially the same as the build() method on the
  58.      * Navigation helper, but without a pageCallback as it does not make
  59.      * sense in Twig context. If you need a more customized navigation
  60.      * with a callback, build the navigation externally, pass it to the
  61.      * view and just call render through the extension.
  62.      *
  63.      * @param mixed $params config array or active document (legacy mode)
  64.      *
  65.      * @return Container
  66.      *
  67.      * @throws \Exception
  68.      */
  69.     public function buildNavigation(
  70.         $params = null
  71.     ): Container {
  72.         return $this->navigationExtension->build($params);
  73.     }
  75.     /**
  76.      * Loads a renderer instance
  77.      *
  78.      * @param string $alias
  79.      *
  80.      * @return RendererInterface
  81.      */
  82.     public function getRenderer(string $alias): RendererInterface
  83.     {
  84.         return $this->navigationExtension->getRenderer($alias);
  85.     }
  87.     /**
  88.      * Renders a navigation with the given renderer
  89.      *
  90.      * @param Container $container
  91.      * @param string $rendererName
  92.      * @param string|null $renderMethod     Optional render method to use (e.g. menu -> renderMenu)
  93.      * @param array<int, mixed> $rendererArguments      Option arguments to pass to the render method after the container
  94.      *
  95.      * @return string
  96.      */
  97.     public function render(
  98.         Container $container,
  99.         string $rendererName = 'menu',
  100.         string $renderMethod = null,
  101.         ...$rendererArguments
  102.     ) {
  103.         return call_user_func_array([$this->navigationExtension, 'render'], func_get_args());
  104.     }
  105. }