Symfony Profiler

<?php
declare(strict_types=1);
/**
* Pimcore
*
* This source file is available under two different licenses:
* - GNU General Public License version 3 (GPLv3)
* - Pimcore Commercial License (PCL)
* Full copyright and license information is available in
* LICENSE.md which is distributed with this source code.
*
* @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
* @license http://www.pimcore.org/license GPLv3 and PCL
*/
namespace Pimcore\Twig\Extension\Templating;
use Pimcore\Model\Document;
use Pimcore\Navigation\Builder;
use Pimcore\Navigation\Container;
use Pimcore\Navigation\Renderer\Breadcrumbs;
use Pimcore\Navigation\Renderer\Menu;
use Pimcore\Navigation\Renderer\Menu as MenuRenderer;
use Pimcore\Navigation\Renderer\RendererInterface;
use Pimcore\Twig\Extension\Templating\Navigation\Exception\InvalidRendererException;
use Pimcore\Twig\Extension\Templating\Navigation\Exception\RendererNotFoundException;
use Pimcore\Twig\Extension\Templating\Traits\HelperCharsetTrait;
use Psr\Container\ContainerInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Twig\Extension\RuntimeExtensionInterface;
/**
* @method MenuRenderer menu()
* @method Breadcrumbs breadcrumbs()
*
*/
class Navigation implements RuntimeExtensionInterface
{
use HelperCharsetTrait;
/**
* @var Builder
*/
private $builder;
/**
* @var ContainerInterface
*/
private $rendererLocator;
/**
* @param Builder $builder
* @param ContainerInterface $rendererLocator
*/
public function __construct(Builder $builder, ContainerInterface $rendererLocator)
{
$this->builder = $builder;
$this->rendererLocator = $rendererLocator;
}
/**
* Builds a navigation container by passing arguments
*
* @deprecated
*
* @param Document $activeDocument
* @param Document|null $navigationRootDocument
* @param string|null $htmlMenuPrefix
* @param callable|null $pageCallback
* @param bool|string $cache
* @param int|null $maxDepth
* @param int|null $cacheLifetime
*
* @return Container
*
* @throws \Exception
*/
public function buildNavigation(
Document $activeDocument,
Document $navigationRootDocument = null,
string $htmlMenuPrefix = null,
callable $pageCallback = null,
$cache = true,
$maxDepth = null,
$cacheLifetime = null
): Container {
return $this->builder->getNavigation(
$activeDocument,
$navigationRootDocument,
$htmlMenuPrefix,
$pageCallback,
$cache,
$maxDepth,
$cacheLifetime
);
}
/**
* Builds a navigation container by passing params
* Possible config params are: 'root', 'htmlMenuPrefix', 'pageCallback', 'cache', 'maxDepth', 'active'
*
* @param array $params
*
* @return Container
*
* @throws \Exception
*/
public function build(array $params): Container
{
$optionsResolver = new OptionsResolver();
$optionsResolver->setDefaults([
'root' => null,
'htmlMenuPrefix' => null,
'pageCallback' => null,
'cache' => true,
'cacheLifetime' => null,
'maxDepth' => null,
'active' => null,
]);
$options = $optionsResolver->resolve($params);
return $this->builder->getNavigation(
$options['active'],
$options['root'],
$options['htmlMenuPrefix'],
$options['pageCallback'],
$options['cache'],
$options['maxDepth'],
$options['cacheLifetime']
);
}
/**
* Get a named renderer
*
* @param string $alias
*
* @return RendererInterface
*/
public function getRenderer(string $alias): RendererInterface
{
if (!$this->rendererLocator->has($alias)) {
throw RendererNotFoundException::create($alias);
}
$renderer = $this->rendererLocator->get($alias);
if (!$renderer instanceof RendererInterface) {
throw InvalidRendererException::create($alias, $renderer);
}
return $renderer;
}
/**
* Renders a navigation with the given renderer
*
* @param Container $container
* @param string $rendererName
* @param string $renderMethod Optional render method to use (e.g. menu -> renderMenu)
* @param array<int, mixed> $rendererArguments Option arguments to pass to the render method after the container
*
* @return string
*/
public function render(
Container $container,
string $rendererName = 'menu',
string $renderMethod = 'render',
...$rendererArguments
) {
$renderer = $this->getRenderer($rendererName);
if (!method_exists($renderer, $renderMethod)) {
throw new \InvalidArgumentException(sprintf('Method "%s" does not exist on renderer "%s"', $renderMethod, $rendererName));
}
$args = array_merge([$container], array_values($rendererArguments));
return call_user_func_array([$renderer, $renderMethod], $args);
}
/**
* Magic overload is an alias to getRenderer()
*
* @param string $method
* @param array $arguments
*
* @return RendererInterface
*/
public function __call($method, array $arguments = []): RendererInterface
{
return $this->getRenderer($method);
}
}
class_alias(Navigation::class, 'Pimcore\Templating\Helper\Navigation');

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