vendor/sulu/sulu/src/Sulu/Bundle/WebsiteBundle/Navigation/NavigationMapper.php line 130

  1. <?php
  3. /*
  4.  * This file is part of Sulu.
  5.  *
  6.  * (c) Sulu GmbH
  7.  *
  8.  * This source file is subject to the MIT license that is bundled
  9.  * with this source code in the file LICENSE.
  10.  */
  12. namespace Sulu\Bundle\WebsiteBundle\Navigation;
  14. use Sulu\Component\Content\Compat\Structure;
  15. use Sulu\Component\Content\Compat\StructureInterface;
  16. use Sulu\Component\Content\Mapper\ContentMapperInterface;
  17. use Sulu\Component\Content\Query\ContentQueryBuilderInterface;
  18. use Sulu\Component\Content\Query\ContentQueryExecutorInterface;
  19. use Sulu\Component\PHPCR\SessionManager\SessionManagerInterface;
  20. use Sulu\Component\Security\Authorization\PermissionTypes;
  21. use Symfony\Component\Stopwatch\Stopwatch;
  23. class NavigationMapper implements NavigationMapperInterface
  24. {
  25.     /**
  26.      * @var ContentMapperInterface
  27.      */
  28.     private $contentMapper;
  30.     /**
  31.      * @var ContentQueryExecutorInterface
  32.      */
  33.     private $contentQueryExecutor;
  35.     /**
  36.      * @var ContentQueryBuilderInterface
  37.      */
  38.     private $queryBuilder;
  40.     /**
  41.      * @var SessionManagerInterface
  42.      */
  43.     private $sessionManager;
  45.     /**
  46.      * @var Stopwatch
  47.      */
  48.     private $stopwatch;
  50.     /**
  51.      * @var array
  52.      */
  53.     private $permissions;
  55.     /**
  56.      * @var array
  57.      */
  58.     private $enabledTwigAttributes = [];
  60.     public function __construct(
  61.         ContentMapperInterface $contentMapper,
  62.         ContentQueryExecutorInterface $contentQueryExecutor,
  63.         ContentQueryBuilderInterface $queryBuilder,
  64.         SessionManagerInterface $sessionManager,
  65.         Stopwatch $stopwatch = null,
  66.         $permissions = null,
  67.         array $enabledTwigAttributes = [
  68.             'path' => true,
  69.         ]
  70.     ) {
  71.         $this->contentMapper = $contentMapper;
  72.         $this->contentQueryExecutor = $contentQueryExecutor;
  73.         $this->queryBuilder = $queryBuilder;
  74.         $this->sessionManager = $sessionManager;
  75.         $this->stopwatch = $stopwatch;
  76.         $this->permissions = $permissions;
  77.         $this->enabledTwigAttributes = $enabledTwigAttributes;
  79.         if ($enabledTwigAttributes['path'] ?? true) {
  80.             @\trigger_error('Enabling the "path" parameter is deprecated since sulu/sulu 2.3.', \E_USER_DEPRECATED);
  81.         }
  82.     }
  84.     public function getNavigation(
  85.         $parent,
  86.         $webspaceKey,
  87.         $locale,
  88.         $depth = 1,
  89.         $flat = false,
  90.         $context = null,
  91.         $loadExcerpt = false,
  92.         $segmentKey = null
  93.     ) {
  94.         if ($this->stopwatch) {
  95.             $this->stopwatch->start('NavigationMapper::getNavigation');
  96.         }
  97.         $rootDepth = \substr_count($this->sessionManager->getContentNode($webspaceKey)->getPath(), '/');
  98.         $parent = $this->sessionManager->getSession()->getNodeByIdentifier($parent)->getPath();
  99.         $depth = $depth + \substr_count($parent, '/') - $rootDepth;
  101.         $this->queryBuilder->init(
  102.             [
  103.                 'context' => $context,
  104.                 'parent' => $parent,
  105.                 'excerpt' => $loadExcerpt,
  106.                 'segmentKey' => $segmentKey,
  107.             ]
  108.         );
  109.         $result = $this->contentQueryExecutor->execute(
  110.             $webspaceKey,
  111.             [$locale],
  112.             $this->queryBuilder,
  113.             $flat,
  114.             $depth,
  115.             null,
  116.             null,
  117.             false,
  118.             $this->permissions[PermissionTypes::VIEW] ?? null
  119.         );
  121.         $result = $this->normalizeResult($result);
  123.         if ($this->stopwatch) {
  124.             $this->stopwatch->stop('NavigationMapper::getNavigation');
  125.         }
  127.         return $result;
  128.     }
  130.     public function getRootNavigation(
  131.         $webspaceKey,
  132.         $locale,
  133.         $depth = 1,
  134.         $flat = false,
  135.         $context = null,
  136.         $loadExcerpt = false,
  137.         $segmentKey = null
  138.     ) {
  139.         if ($this->stopwatch) {
  140.             $this->stopwatch->start('NavigationMapper::getRootNavigation.query');
  141.         }
  143.         $this->queryBuilder->init(['context' => $context, 'excerpt' => $loadExcerpt, 'segmentKey' => $segmentKey]);
  144.         $result = $this->contentQueryExecutor->execute(
  145.             $webspaceKey,
  146.             [$locale],
  147.             $this->queryBuilder,
  148.             $flat,
  149.             $depth,
  150.             null,
  151.             null,
  152.             false,
  153.             $this->permissions[PermissionTypes::VIEW] ?? null
  154.         );
  156.         $result = $this->normalizeResult($result);
  158.         if ($this->stopwatch) {
  159.             $this->stopwatch->stop('NavigationMapper::getRootNavigation.query');
  160.         }
  162.         return $result;
  163.     }
  165.     public function getBreadcrumb($uuid, $webspace, $language)
  166.     {
  167.         $breadcrumbItems = $this->contentMapper->loadBreadcrumb($uuid, $language, $webspace);
  169.         $result = [];
  170.         foreach ($breadcrumbItems as $item) {
  171.             $result[] = $this->contentMapper->load($item->getUuid(), $webspace, $language);
  172.         }
  173.         $result[] = $this->contentMapper->load($uuid, $webspace, $language);
  175.         return $this->generateNavigation($result, $webspace, $language, false, null, true, false);
  176.     }
  178.     /**
  179.      * generate navigation items for given contents.
  180.      */
  181.     private function generateNavigation(
  182.         $contents,
  183.         $webspace,
  184.         $language,
  185.         $flat = false,
  186.         $context = null,
  187.         $breakOnNotInNavigation = false,
  188.         $recursive = true
  189.     ) {
  190.         $result = [];
  192.         /** @var StructureInterface $content */
  193.         foreach ($contents as $content) {
  194.             if ($this->inNavigation($content, $context)) {
  195.                 $url = $content->getResourceLocator();
  196.                 $title = $content->getTitle();
  197.                 $children = $recursive ? $this->generateChildNavigation($content, $webspace, $language, $flat, $context) : [];
  199.                 if (false === $flat) {
  200.                     $result[] = new NavigationItem(
  201.                         $title,
  202.                         $url,
  203.                         isset($content->getExt()['excerpt']) ? $content->getExt()['excerpt'] : null,
  204.                         $children,
  205.                         $content->getUuid(),
  206.                         $content->getNodeType()
  207.                     );
  208.                 } else {
  209.                     $result[] = new NavigationItem(
  210.                         $title,
  211.                         $url,
  212.                         isset($content->getExt()['excerpt']) ? $content->getExt()['excerpt'] : null,
  213.                         null,
  214.                         $content->getUuid(),
  215.                         $content->getNodeType()
  216.                     );
  217.                     $result = \array_merge($result, $children);
  218.                 }
  219.             } elseif (true === $flat) {
  220.                 $children = $recursive ? $this->generateChildNavigation($content, $webspace, $language, $flat, $context) : [];
  221.                 $result = \array_merge($result, $children);
  222.             } elseif ($breakOnNotInNavigation) {
  223.                 break;
  224.             }
  225.         }
  227.         return $result;
  228.     }
  230.     /**
  231.      * generate child navigation of given content.
  232.      */
  233.     private function generateChildNavigation(
  234.         StructureInterface $content,
  235.         $webspace,
  236.         $language,
  237.         $flat = false,
  238.         $context = null
  239.     ) {
  240.         $children = [];
  241.         if (\is_array($content->getChildren()) && \count($content->getChildren()) > 0) {
  242.             $children = $this->generateNavigation(
  243.                 $content->getChildren(),
  244.                 $webspace,
  245.                 $language,
  246.                 $flat,
  247.                 $context
  248.             );
  249.         }
  251.         return $children;
  252.     }
  254.     /**
  255.      * checks if content should be displayed.
  256.      *
  257.      * @param string|null $context
  258.      *
  259.      * @return bool
  260.      */
  261.     public function inNavigation(StructureInterface $content, $context = null)
  262.     {
  263.         $contexts = $content->getNavContexts();
  265.         if (Structure::STATE_PUBLISHED !== $content->getNodeState()) {
  266.             // if node state is not published do not show page
  267.             return false;
  268.         }
  270.         if (\is_array($contexts) && (null === $context || \in_array($context, $contexts))) {
  271.             // all contexts or content has context
  272.             return true;
  273.         }
  275.         // do not show
  276.         return false;
  277.     }
  279.     private function normalizeResult(array $result)
  280.     {
  281.         foreach ($result as $key => $item) {
  282.             if (isset($item['children'])) {
  283.                 $item['children'] = $this->normalizeResult($item['children']);
  284.             } else {
  285.                 $item['children'] = [];
  286.             }
  288.             if (!($this->enabledTwigAttributes['path'] ?? true)) {
  289.                 unset($item['path']);
  290.             }
  292.             $result[$key] = $item;
  293.         }
  295.         return $result;
  296.     }
  297. }