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

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. * @var ContentQueryExecutorInterface
  29. */
  30. #[Exclude]
  31. private $contentQueryExecutor;
  33. /**
  34. * The content mapper, which is needed for lazy loading.
  35. *
  36. * @var ContentQueryBuilderInterface
  37. */
  38. #[Exclude]
  39. private $contentQueryBuilder;
  41. /**
  42. * The params to load.
  43. *
  44. * @var array
  45. */
  46. #[Exclude]
  47. private $params;
  49. /**
  50. * The key of the webspace.
  51. *
  52. * @var string
  53. */
  54. #[Exclude]
  55. private $webspaceKey;
  57. /**
  58. * The code of the language.
  59. *
  60. * @var string
  61. */
  62. #[Exclude]
  63. private $languageCode;
  65. /**
  66. * @var string[]
  67. */
  68. private $ids;
  70. /**
  71. * @var StructureInterface[]
  72. */
  73. #[Exclude]
  74. private $data;
  76. /**
  77. * @var bool
  78. */
  79. private $showDrafts;
  81. /**
  82. * @var array
  83. */
  84. private $permission;
  86. /**
  87. * @var array
  88. */
  89. private $enabledTwigAttributes = [];
  91. public function __construct(
  92. $ids,
  93. ContentQueryExecutorInterface $contentQueryExecutor,
  94. ContentQueryBuilderInterface $contentQueryBuilder,
  95. $params,
  96. $webspaceKey,
  97. $languageCode,
  98. $showDrafts,
  99. $permission = null,
  100. array $enabledTwigAttributes = [
  101. 'path' => true,
  102. ]
  103. ) {
  104. $this->ids = $ids;
  105. $this->contentQueryExecutor = $contentQueryExecutor;
  106. $this->contentQueryBuilder = $contentQueryBuilder;
  107. $this->webspaceKey = $webspaceKey;
  108. $this->languageCode = $languageCode;
  109. $this->params = $params;
  110. $this->showDrafts = $showDrafts;
  111. $this->permission = $permission;
  112. $this->enabledTwigAttributes = $enabledTwigAttributes;
  114. if ($enabledTwigAttributes['path'] ?? true) {
  115. @trigger_deprecation('sulu/sulu', '2.3', 'Enabling the "path" parameter is deprecated.');
  116. }
  117. }
  119. /**
  120. * Lazy loads the data based on the filter criteria from the config.
  121. *
  122. * @return StructureInterface[]
  123. */
  124. public function getData()
  125. {
  126. if (null === $this->data) {
  127. $this->data = $this->loadData();
  128. }
  130. return $this->data;
  131. }
  133. /**
  134. * lazy load data.
  135. */
  136. private function loadData()
  137. {
  138. $result = [];
  139. if (null !== $this->ids && \count($this->ids) > 0) {
  140. $this->contentQueryBuilder->init(
  141. [
  142. 'ids' => $this->ids,
  143. 'properties' => (isset($this->params['properties']) ? $this->params['properties']->getValue() : []),
  144. 'published' => !$this->showDrafts,
  145. ]
  146. );
  147. $pages = $this->contentQueryExecutor->execute(
  148. $this->webspaceKey,
  149. [$this->languageCode],
  150. $this->contentQueryBuilder,
  151. true,
  152. -1,
  153. null,
  154. null,
  155. false,
  156. $this->permission
  157. );
  159. // init vars
  160. $map = [];
  162. // map pages
  163. foreach ($pages as $page) {
  164. if (!($this->enabledTwigAttributes['path'] ?? true)) {
  165. unset($page['path']);
  166. }
  168. $map[$page['id']] = $page;
  169. }
  171. foreach ($this->ids as $id) {
  172. if (isset($map[$id])) {
  173. $result[] = $map[$id];
  174. }
  175. }
  176. }
  178. return $result;
  179. }
  181. /**
  182. * magic getter.
  183. */
  184. public function __get($name)
  185. {
  186. switch ($name) {
  187. case 'data':
  188. return $this->getData();
  189. }
  191. return;
  192. }
  194. /**
  195. * magic isset.
  196. */
  197. public function __isset($name)
  198. {
  199. return 'data' == $name;
  200. }
  202. public function toArray($depth = null)
  203. {
  204. return ['ids' => $this->ids];
  205. }
  206. }