vendor/sulu/sulu/src/Sulu/Bundle/PageBundle/Content/PageSelectionContainer.php line 130

Open in your IDE?
  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\PageBundle\Content;
  14. use JMS\Serializer\Annotation\Exclude;
  15. use Sulu\Component\Content\Compat\StructureInterface;
  16. use Sulu\Component\Content\Query\ContentQueryBuilderInterface;
  17. use Sulu\Component\Content\Query\ContentQueryExecutorInterface;
  18. use Sulu\Component\Util\ArrayableInterface;
  20. /**
  21.  * Container for PageSelection, holds the config for a internal links, and lazy loads the structures.
  22.  */
  23. class PageSelectionContainer implements ArrayableInterface
  24. {
  25.     /**
  26.      * The content mapper, which is needed for lazy loading.
  27.      *
  28.      * @Exclude
  29.      *
  30.      * @var ContentQueryExecutorInterface
  31.      */
  32.     private $contentQueryExecutor;
  34.     /**
  35.      * The content mapper, which is needed for lazy loading.
  36.      *
  37.      * @Exclude
  38.      *
  39.      * @var ContentQueryBuilderInterface
  40.      */
  41.     private $contentQueryBuilder;
  43.     /**
  44.      * The params to load.
  45.      *
  46.      * @Exclude
  47.      *
  48.      * @var array
  49.      */
  50.     private $params;
  52.     /**
  53.      * The key of the webspace.
  54.      *
  55.      * @Exclude
  56.      *
  57.      * @var string
  58.      */
  59.     private $webspaceKey;
  61.     /**
  62.      * The code of the language.
  63.      *
  64.      * @Exclude
  65.      *
  66.      * @var string
  67.      */
  68.     private $languageCode;
  70.     /**
  71.      * @var string[]
  72.      */
  73.     private $ids;
  75.     /**
  76.      * @Exclude
  77.      *
  78.      * @var StructureInterface[]
  79.      */
  80.     private $data;
  82.     /**
  83.      * @var bool
  84.      */
  85.     private $showDrafts;
  87.     /**
  88.      * @var array
  89.      */
  90.     private $permission;
  92.     /**
  93.      * @var array
  94.      */
  95.     private $enabledTwigAttributes = [];
  97.     public function __construct(
  98.         $ids,
  99.         ContentQueryExecutorInterface $contentQueryExecutor,
  100.         ContentQueryBuilderInterface $contentQueryBuilder,
  101.         $params,
  102.         $webspaceKey,
  103.         $languageCode,
  104.         $showDrafts,
  105.         $permission = null,
  106.         array $enabledTwigAttributes = [
  107.             'path' => true,
  108.         ]
  109.     ) {
  110.         $this->ids = $ids;
  111.         $this->contentQueryExecutor = $contentQueryExecutor;
  112.         $this->contentQueryBuilder = $contentQueryBuilder;
  113.         $this->webspaceKey = $webspaceKey;
  114.         $this->languageCode = $languageCode;
  115.         $this->params = $params;
  116.         $this->showDrafts = $showDrafts;
  117.         $this->permission = $permission;
  118.         $this->enabledTwigAttributes = $enabledTwigAttributes;
  120.         if ($enabledTwigAttributes['path'] ?? true) {
  121.             @\trigger_error('Enabling the "path" parameter is deprecated since sulu/sulu 2.3.', \E_USER_DEPRECATED);
  122.         }
  123.     }
  125.     /**
  126.      * Lazy loads the data based on the filter criteria from the config.
  127.      *
  128.      * @return StructureInterface[]
  129.      */
  130.     public function getData()
  131.     {
  132.         if (null === $this->data) {
  133.             $this->data = $this->loadData();
  134.         }
  136.         return $this->data;
  137.     }
  139.     /**
  140.      * lazy load data.
  141.      */
  142.     private function loadData()
  143.     {
  144.         $result = [];
  145.         if (null !== $this->ids && \count($this->ids) > 0) {
  146.             $this->contentQueryBuilder->init(
  147.                 [
  148.                     'ids' => $this->ids,
  149.                     'properties' => (isset($this->params['properties']) ? $this->params['properties']->getValue() : []),
  150.                     'published' => !$this->showDrafts,
  151.                 ]
  152.             );
  153.             $pages = $this->contentQueryExecutor->execute(
  154.                 $this->webspaceKey,
  155.                 [$this->languageCode],
  156.                 $this->contentQueryBuilder,
  157.                 true,
  158.                 -1,
  159.                 null,
  160.                 null,
  161.                 false,
  162.                 $this->permission
  163.             );
  165.             // init vars
  166.             $map = [];
  168.             // map pages
  169.             foreach ($pages as $page) {
  170.                 if (!($this->enabledTwigAttributes['path'] ?? true)) {
  171.                     unset($page['path']);
  172.                 }
  174.                 $map[$page['id']] = $page;
  175.             }
  177.             foreach ($this->ids as $id) {
  178.                 if (isset($map[$id])) {
  179.                     $result[] = $map[$id];
  180.                 }
  181.             }
  182.         }
  184.         return $result;
  185.     }
  187.     /**
  188.      * magic getter.
  189.      */
  190.     public function __get($name)
  191.     {
  192.         switch ($name) {
  193.             case 'data':
  194.                 return $this->getData();
  195.         }
  197.         return;
  198.     }
  200.     /**
  201.      * magic isset.
  202.      */
  203.     public function __isset($name)
  204.     {
  205.         return 'data' == $name;
  206.     }
  208.     public function toArray($depth = null)
  209.     {
  210.         return ['ids' => $this->ids];
  211.     }
  212. }