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\Templating\Helper\Navigation;
  24. use Twig\Extension\AbstractExtension;
  25. use Twig\TwigFunction;
  27. class NavigationExtension extends AbstractExtension
  28. {
  29.     /**
  30.      * @var Navigation
  31.      */
  32.     private $navigationHelper;
  34.     /**
  35.      * @param Navigation $navigationHelper
  36.      */
  37.     public function __construct(Navigation $navigationHelper)
  38.     {
  39.         $this->navigationHelper = $navigationHelper;
  40.     }
  42.     public function getFunctions(): array
  43.     {
  44.         return [
  45.             new TwigFunction('pimcore_build_nav', [$this, 'buildNavigation']),
  46.             new TwigFunction('pimcore_render_nav', [$this, 'render'], [
  47.                 'is_safe' => ['html'],
  48.             ]),
  49.             new TwigFunction('pimcore_nav_renderer', [$this, 'getRenderer']),
  50.         ];
  51.     }
  53.     /**
  54.      * This is essentially the same as the buildNavigation method on the
  55.      * Navigation helper, but without a pageCallback as it does not make
  56.      * sense in Twig context. If you need a more customized navigation
  57.      * with a callback, build the navigation externally, pass it to the
  58.      * view and just call render through the extension.
  59.      *
  60.      * @param mixed $params config array or active document (legacy mode)
  61.      * @param Document|null $navigationRootDocument
  62.      * @param string|null $htmlMenuPrefix
  63.      * @param bool|string $cache
  64.      *
  65.      * @return Container
  66.      *
  67.      * @throws \Exception
  68.      */
  69.     public function buildNavigation(
  70.         $params = null,
  71.         Document $navigationRootDocument = null,
  72.         string $htmlMenuPrefix = null,
  73.         $cache = true
  74.     ): Container {
  75.         if (is_array($params)) {
  76.             // using param configuration
  77.             return $this->navigationHelper->build($params);
  78.         } else {
  79.             @trigger_error(sprintf('Passing active document as first param to "pimcore_build_nav" Twig function or %s is deprecated and will throw exception in Pimcore 10. Pass array arguments instead.', __METHOD__), E_USER_DEPRECATED);
  80.             // using deprecated argument configuration ($params = navigation root document)
  81.             return $this->navigationHelper->buildNavigation(
  82.                 $params,
  83.                 $navigationRootDocument,
  84.                 $htmlMenuPrefix,
  85.                 null,
  86.                 $cache
  87.             );
  88.         }
  89.     }
  91.     /**
  92.      * Loads a renderer instance
  93.      *
  94.      * @param string $alias
  95.      *
  96.      * @return RendererInterface
  97.      */
  98.     public function getRenderer(string $alias): RendererInterface
  99.     {
  100.         return $this->navigationHelper->getRenderer($alias);
  101.     }
  103.     /**
  104.      * Renders a navigation with the given renderer
  105.      *
  106.      * @param Container $container
  107.      * @param string $rendererName
  108.      * @param string|null $renderMethod     Optional render method to use (e.g. menu -> renderMenu)
  109.      * @param array<int, mixed> $rendererArguments      Option arguments to pass to the render method after the container
  110.      *
  111.      * @return string
  112.      */
  113.     public function render(
  114.         Container $container,
  115.         string $rendererName = 'menu',
  116.         string $renderMethod = null,
  117.         ...$rendererArguments
  118.     ) {
  119.         return call_user_func_array([$this->navigationHelper, 'render'], func_get_args());
  120.     }
  121. }