vendor/sulu/sulu/src/Sulu/Component/Content/Compat/Structure/StructureBridge.php line 179

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\Component\Content\Compat\Structure;
  14. use Sulu\Bundle\DocumentManagerBundle\Bridge\DocumentInspector;
  15. use Sulu\Component\Content\Compat\StructureInterface;
  16. use Sulu\Component\Content\Compat\StructureType;
  17. use Sulu\Component\Content\Document\Behavior\ExtensionBehavior;
  18. use Sulu\Component\Content\Document\Behavior\NavigationContextBehavior;
  19. use Sulu\Component\Content\Document\Behavior\OrderBehavior;
  20. use Sulu\Component\Content\Document\Behavior\RedirectTypeBehavior;
  21. use Sulu\Component\Content\Document\Behavior\ResourceSegmentBehavior;
  22. use Sulu\Component\Content\Document\Behavior\ShadowLocaleBehavior;
  23. use Sulu\Component\Content\Document\Behavior\StructureBehavior;
  24. use Sulu\Component\Content\Document\Behavior\WorkflowStageBehavior;
  25. use Sulu\Component\Content\Document\LocalizationState;
  26. use Sulu\Component\Content\Document\RedirectType;
  27. use Sulu\Component\Content\Document\WorkflowStage;
  28. use Sulu\Component\Content\Metadata\StructureMetadata;
  30. /**
  31. * @deprecated Should be replaced by a proper StructureInterface implementation
  32. */
  33. class StructureBridge implements StructureInterface
  34. {
  35. /**
  36. * @var StructureMetadata
  37. */
  38. protected $structure;
  40. /**
  41. * @var DocumentInspector
  42. */
  43. protected $inspector;
  45. /**
  46. * @var array
  47. */
  48. private $loadedProperties = [];
  50. /**
  51. * Needed by structure extensions when the document has not been set..
  52. *
  53. * @var string
  54. */
  55. protected $locale;
  57. /**
  58. * @param object $document
  59. */
  60. public function __construct(
  61. StructureMetadata $structure,
  62. DocumentInspector $inspector,
  63. private LegacyPropertyFactory $propertyFactory,
  64. protected $document = null
  65. ) {
  66. $this->structure = $structure;
  67. $this->inspector = $inspector;
  68. }
  70. public function setDocument(StructureBehavior $document)
  71. {
  72. $this->document = $document;
  73. }
  75. public function setLanguageCode($locale)
  76. {
  77. $this->locale = $locale;
  78. }
  80. public function getLanguageCode()
  81. {
  82. if (!$this->document) {
  83. return $this->locale;
  84. }
  86. return $this->inspector->getLocale($this->getDocument());
  87. }
  89. public function setWebspaceKey($webspace)
  90. {
  91. $this->readOnlyException(__METHOD__);
  92. }
  94. public function getWebspaceKey()
  95. {
  96. if (!$this->document) {
  97. return null;
  98. }
  100. return $this->inspector->getWebspace($this->getDocument());
  101. }
  103. public function getUuid()
  104. {
  105. return $this->getDocument()->getUuid();
  106. }
  108. public function setUuid($uuid)
  109. {
  110. $this->readOnlyException(__METHOD__);
  111. }
  113. public function getCreator()
  114. {
  115. return $this->getDocument()->getCreator();
  116. }
  118. public function setCreator($userId)
  119. {
  120. $this->readOnlyException(__METHOD__);
  121. }
  123. public function getChanger()
  124. {
  125. return $this->getDocument()->getChanger();
  126. }
  128. public function setChanger($userId)
  129. {
  130. $this->readOnlyException(__METHOD__);
  131. }
  133. public function getCreated()
  134. {
  135. return $this->getDocument()->getCreated();
  136. }
  138. public function setCreated(\DateTime $created)
  139. {
  140. $this->readOnlyException(__METHOD__);
  141. }
  143. public function getChanged()
  144. {
  145. return $this->getDocument()->getChanged();
  146. }
  148. public function setChanged(\DateTime $changed)
  149. {
  150. $this->readOnlyException(__METHOD__);
  151. }
  153. public function getKey()
  154. {
  155. return $this->structure->getName();
  156. }
  158. public function getInternal()
  159. {
  160. return $this->structure->isInternal();
  161. }
  163. public function getProperty($name)
  164. {
  165. if ($this->hasProperty($name)) {
  166. $property = $this->structure->getProperty($name);
  167. } else {
  168. $property = $this->structure->getChild($name);
  169. }
  171. return $this->createLegacyPropertyFromItem($property);
  172. }
  174. public function hasProperty($name)
  175. {
  176. return $this->structure->hasProperty($name);
  177. }
  179. public function getProperties($flatten = false)
  180. {
  181. if ($flatten) {
  182. $items = $this->structure->getProperties();
  183. } else {
  184. $items = $this->structure->getChildren();
  185. }
  187. $propertyBridges = [];
  188. foreach ($items as $property) {
  189. $propertyBridges[$property->getName()] = $this->createLegacyPropertyFromItem($property);
  190. }
  192. return $propertyBridges;
  193. }
  195. public function getExt()
  196. {
  197. return $this->document->getExtensionsData();
  198. }
  200. public function setExt($data)
  201. {
  202. $this->readOnlyException(__METHOD__);
  203. }
  205. public function setHasChildren($hasChildren)
  206. {
  207. $this->readOnlyException(__METHOD__);
  208. }
  210. public function getHasChildren()
  211. {
  212. return $this->inspector->hasChildren($this->getDocument());
  213. }
  215. public function setChildren($children)
  216. {
  217. $this->readOnlyException(__METHOD__);
  218. }
  220. public function getChildren()
  221. {
  222. $children = [];
  224. foreach ($this->getDocument()->getChildren() as $child) {
  225. $children[] = $this->documentToStructure($child);
  226. }
  228. return $children;
  229. }
  231. /**
  232. * @return $this
  233. */
  234. public function getParent()
  235. {
  236. return $this->documentToStructure($this->inspector->getParent($this->getDocument()));
  237. }
  239. public function getPublishedState()
  240. {
  241. return WorkflowStage::PUBLISHED === $this->getWorkflowDocument(__METHOD__)->getWorkflowStage();
  242. }
  244. public function setPublished($published)
  245. {
  246. $this->readOnlyException(__METHOD__);
  247. }
  249. public function getPublished()
  250. {
  251. return $this->getWorkflowDocument(__METHOD__)->getPublished();
  252. }
  254. public function getPropertyValue($name)
  255. {
  256. return $this->getProperty($name)->getValue();
  257. }
  259. public function getPropertyNames()
  260. {
  261. return \array_keys($this->structure->getChildren());
  262. }
  264. public function setType($type)
  265. {
  266. $this->readOnlyException(__METHOD__);
  267. }
  269. public function getType()
  270. {
  271. $document = $this->getDocument();
  272. $localizationState = $this->inspector->getLocalizationState($document);
  274. if (LocalizationState::GHOST === $localizationState) {
  275. return StructureType::getGhost($this->getDocument()->getLocale());
  276. }
  278. if (LocalizationState::SHADOW === $this->inspector->getLocalizationState($document)) {
  279. return StructureType::getShadow($this->getDocument()->getLocale());
  280. }
  281. }
  283. public function getPath()
  284. {
  285. return $this->inspector->getContentPath($this->getDocument());
  286. }
  288. public function setPath($path)
  289. {
  290. $this->readOnlyException(__METHOD__);
  291. }
  293. public function setHasTranslation($hasTranslation)
  294. {
  295. $this->readOnlyException(__METHOD__);
  296. }
  298. public function getHasTranslation()
  299. {
  300. return $this->getTitle() ? true : false;
  301. }
  303. public function toArray($complete = true)
  304. {
  305. $document = $this->getDocument();
  307. $result = [
  308. 'id' => $this->inspector->getUuid($document),
  309. 'path' => $this->inspector->getContentPath($document),
  310. 'nodeType' => $this->getNodeType(),
  311. 'nodeState' => $this->getNodeState(),
  312. 'internal' => false,
  313. 'availableLocales' => $this->inspector->getLocales($document),
  314. 'contentLocales' => $this->inspector->getConcreteLocales($document),
  315. 'hasSub' => $this->getHasChildren(),
  316. 'title' => $document->getTitle(), // legacy system returns diffent fields for title depending on $complete
  317. ];
  319. if ($document instanceof OrderBehavior) {
  320. $result['order'] = $document->getSuluOrder();
  321. }
  323. if ($document instanceof RedirectTypeBehavior) {
  324. $redirectType = $document->getRedirectType();
  325. $result['linked'] = null;
  326. if (RedirectType::INTERNAL == $redirectType && null !== $document->getRedirectTarget()) {
  327. $result['linked'] = 'internal';
  328. $result['internal_link'] = $document->getRedirectTarget()->getUuid();
  329. } elseif (RedirectType::EXTERNAL == $redirectType) {
  330. $result['linked'] = 'external';
  331. $result['external'] = $document->getRedirectExternal();
  332. }
  333. }
  335. if ($document instanceof WorkflowStageBehavior) {
  336. $result['publishedState'] = WorkflowStage::PUBLISHED === $document->getWorkflowStage();
  337. $result['published'] = $document->getPublished();
  338. }
  340. $result['navContexts'] = [];
  341. if ($document instanceof NavigationContextBehavior) {
  342. $result['navContexts'] = $document->getNavigationContexts();
  343. }
  345. if (null !== $this->getType()) {
  346. $result['type'] = $this->getType()->toArray();
  347. }
  349. if ($complete) {
  350. if ($document instanceof ShadowLocaleBehavior) {
  351. $result = \array_merge(
  352. $result,
  353. [
  354. 'shadowLocales' => $this->inspector->getShadowLocales($document),
  355. 'shadowOn' => $document->isShadowLocaleEnabled(),
  356. 'shadowBaseLanguage' => $document->getShadowLocale(),
  357. ]
  358. );
  359. }
  361. $result = \array_merge(
  362. $result,
  363. [
  364. 'template' => $this->structure->getName(),
  365. 'originTemplate' => $this->structure->getName(),
  366. 'creator' => $document->getCreator(),
  367. 'changer' => $document->getChanger(),
  368. 'created' => $document->getCreated(),
  369. 'changed' => $document->getChanged(),
  370. 'title' => $document->getTitle(),
  371. 'url' => null,
  372. ]
  373. );
  375. if ($document instanceof ResourceSegmentBehavior) {
  376. $result['url'] = $document->getResourceSegment();
  377. }
  379. if ($document instanceof ExtensionBehavior) {
  380. $result['ext'] = $document->getExtensionsData();
  381. }
  383. $result = \array_merge($this->getDocument()->getStructure()->toArray(), $result);
  385. return $result;
  386. }
  388. return $result;
  389. }
  391. #[\ReturnTypeWillChange]
  392. public function jsonSerialize()
  393. {
  394. }
  396. public function getPropertyByTagName($tagName, $highest = true)
  397. {
  398. return $this->createLegacyPropertyFromItem($this->structure->getPropertyByTagName($tagName, $highest));
  399. }
  401. public function getPropertiesByTagName($tagName)
  402. {
  403. $properties = [];
  404. foreach ($this->structure->getPropertiesByTagName($tagName) as $structureProperty) {
  405. $properties[] = $this->createLegacyPropertyFromItem($structureProperty);
  406. }
  408. return $properties;
  409. }
  411. public function getPropertyValueByTagName($tagName)
  412. {
  413. return $this->getPropertyByTagName($tagName)->getValue();
  414. }
  416. public function hasTag($tag)
  417. {
  418. return $this->structure->hasPropertyWithTagName($tag);
  419. }
  421. public function getNodeType()
  422. {
  423. if ($this->getDocument() instanceof RedirectTypeBehavior) {
  424. return $this->getDocument()->getRedirectType();
  425. }
  427. return RedirectType::NONE;
  428. }
  430. public function getNodeName()
  431. {
  432. if ($this->document instanceof RedirectTypeBehavior
  433. && RedirectType::INTERNAL == $this->document->getRedirectType()
  434. && null !== $this->document->getRedirectTarget()
  435. ) {
  436. return $this->getDocument()->getRedirectTarget()->getTitle();
  437. }
  439. return $this->getDocument()->getTitle();
  440. }
  442. public function getLocalizedTitle($languageCode)
  443. {
  444. return $this->structure->getTitle($languageCode);
  445. }
  447. public function getNodeState()
  448. {
  449. $document = $this->getDocument();
  451. if (!$document instanceof WorkflowStageBehavior) {
  452. return WorkflowStage::PUBLISHED;
  453. }
  455. return $this->getDocument()->getWorkflowStage();
  456. }
  458. public function getTitle()
  459. {
  460. return $this->getDocument()->getTitle();
  461. }
  463. public function getUrl()
  464. {
  465. return $this->getDocument()->getResourceSegment();
  466. }
  468. public function copyFrom(StructureInterface $structure)
  469. {
  470. foreach ($this->getProperties(true) as $property) {
  471. if ($structure->hasProperty($property->getName())) {
  472. $property->setValue($structure->getPropertyValue($property->getName()));
  473. }
  474. }
  476. $this->setDocument($structure->getDocument());
  477. }
  479. /**
  480. * Magic getter.
  481. *
  482. * @deprecated Do not use magic getters. Use ArrayAccess instead
  483. */
  484. public function __get($name)
  485. {
  486. return $this->getProperty($name)->getValue();
  487. }
  489. public function getShadowLocales()
  490. {
  491. return $this->inspector->getShadowLocales($this->getDocument());
  492. }
  494. public function getContentLocales()
  495. {
  496. return $this->inspector->getConcreteLocales($this->getDocument());
  497. }
  499. public function getIsShadow()
  500. {
  501. if (!$this->document) {
  502. return false;
  503. }
  505. $document = $this->getDocument();
  506. if (!$document instanceof ShadowLocaleBehavior) {
  507. return false;
  508. }
  510. return $document->isShadowLocaleEnabled();
  511. }
  513. public function getShadowBaseLanguage()
  514. {
  515. $document = $this->getDocument();
  516. if (!$document instanceof ShadowLocaleBehavior) {
  517. return;
  518. }
  520. return $document->getShadowLocale();
  521. }
  523. public function getResourceLocator()
  524. {
  525. $document = $this->getDocument();
  526. if (RedirectType::EXTERNAL == $document->getRedirectType()) {
  527. return $document->getRedirectExternal();
  528. }
  530. if (RedirectType::INTERNAL === $document->getRedirectType()) {
  531. $target = $document->getRedirectTarget();
  533. if (!$target) {
  534. throw new \RuntimeException('Document is an internal redirect, but no redirect target has been set.');
  535. }
  537. return $target->getResourceSegment();
  538. }
  540. return $document->getResourceSegment();
  541. }
  543. /**
  544. * Returns document.
  545. *
  546. * @return object
  547. */
  548. public function getDocument()
  549. {
  550. if (!$this->document) {
  551. throw new \RuntimeException(
  552. 'Document has not been applied to structure yet, cannot retrieve data from structure.'
  553. );
  554. }
  556. return $this->document;
  557. }
  559. /**
  560. * Returns structure metadata.
  561. *
  562. * @return StructureMetadata
  563. */
  564. public function getStructure()
  565. {
  566. return $this->structure;
  567. }
  569. protected function readOnlyException($method)
  570. {
  571. throw new \BadMethodCallException(
  572. \sprintf(
  573. 'Compatibility layer StructureBridge instances are readonly. Tried to call "%s"',
  574. $method
  575. )
  576. );
  577. }
  579. /**
  580. * @param StructureBehavior $document The document to convert
  581. *
  582. * @return $this
  583. */
  584. protected function documentToStructure(StructureBehavior $document)
  585. {
  586. return new $this(
  587. $this->inspector->getStructureMetadata($document),
  588. $this->inspector,
  589. $this->propertyFactory,
  590. $document
  591. );
  592. }
  594. private function getWorkflowDocument($method)
  595. {
  596. $document = $this->getDocument();
  597. if (!$document instanceof WorkflowStageBehavior) {
  598. throw new \BadMethodCallException(
  599. \sprintf(
  600. 'Cannot call "%s" on Document which does not implement PageInterface. Is "%s"',
  601. $method,
  602. \get_class($document)
  603. )
  604. );
  605. }
  607. return $document;
  608. }
  610. private function notImplemented($method)
  611. {
  612. throw new \InvalidArgumentException(
  613. \sprintf(
  614. 'Method "%s" is not yet implemented',
  615. $method
  616. )
  617. );
  618. }
  620. private function normalizeData(?array $data = null)
  621. {
  622. if (null === $data) {
  623. return;
  624. }
  626. if (false === \is_array($data)) {
  627. return $this->normalizeValue($data);
  628. }
  630. foreach ($data as &$value) {
  631. if (\is_array($value)) {
  632. foreach ($value as $childKey => $childValue) {
  633. $data[$childKey] = $this->normalizeData($childValue);
  634. }
  635. }
  637. $value = $this->normalizeValue($value);
  638. }
  640. return $data;
  641. }
  643. private function normalizeValue($value)
  644. {
  645. if ($value instanceof StructureBehavior) {
  646. return $this->documentToStructure($value);
  647. }
  649. return $value;
  650. }
  652. private function createLegacyPropertyFromItem($item)
  653. {
  654. $name = $item->getName();
  655. if (isset($this->loadedProperties[$name])) {
  656. return $this->loadedProperties[$name];
  657. }
  659. $propertyBridge = $this->propertyFactory->createProperty($item, $this);
  661. if ($this->document) {
  662. $property = $this->getDocument()->getStructure()->getProperty($name);
  663. $propertyBridge->setPropertyValue($property);
  664. }
  666. $this->loadedProperties[$name] = $propertyBridge;
  668. return $propertyBridge;
  669. }
  670. }