vendor/sulu/sulu/src/Sulu/Component/Content/Document/Structure/ManagedStructure.php line 83

  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\Document\Structure;
  14. use PHPCR\NodeInterface;
  15. use Sulu\Bundle\DocumentManagerBundle\Bridge\DocumentInspector;
  16. use Sulu\Component\Content\Compat\PropertyInterface;
  17. use Sulu\Component\Content\Compat\Structure\LegacyPropertyFactory;
  18. use Sulu\Component\Content\Compat\Structure\StructureBridge;
  19. use Sulu\Component\Content\ContentTypeManagerInterface;
  20. use Sulu\Component\Content\Document\Behavior\StructureBehavior;
  21. use Sulu\Component\Content\Metadata\StructureMetadata;
  23. /**
  24.  * Lazy loading container for content properties.
  25.  */
  26. class ManagedStructure extends Structure
  27. {
  28.     /**
  29.      * @var ContentTypeManagerInterface
  30.      */
  31.     private $contentTypeManager;
  33.     /**
  34.      * @var StructureBehavior
  35.      */
  36.     private $document;
  38.     /**
  39.      * @var LegacyPropertyFactory
  40.      */
  41.     private $legacyPropertyFactory;
  43.     /**
  44.      * @var DocumentInspector
  45.      */
  46.     private $inspector;
  48.     /**
  49.      * @var StructureMetadata
  50.      */
  51.     private $structureMetadata;
  53.     /**
  54.      * @var NodeInterface
  55.      */
  56.     private $node;
  58.     /**
  59.      * @var PropertyInterface[]
  60.      */
  61.     private $legacyProperties = [];
  63.     /**
  64.      * @var PropertyValue[]
  65.      */
  66.     private $propertyValues = [];
  68.     /**
  69.      * @param object $document
  70.      */
  71.     public function __construct(
  72.         ContentTypeManagerInterface $contentTypeManager,
  73.         LegacyPropertyFactory $legacyPropertyFactory,
  74.         DocumentInspector $inspector,
  75.         $document
  76.     ) {
  77.         $this->contentTypeManager = $contentTypeManager;
  78.         $this->document = $document;
  79.         $this->legacyPropertyFactory = $legacyPropertyFactory;
  80.         $this->inspector = $inspector;
  81.     }
  83.     public function getProperty($name)
  84.     {
  85.         $this->init();
  87.         if (isset($this->properties[$name])) {
  88.             return $this->properties[$name];
  89.         }
  91.         if (!$this->node) {
  92.             $this->node = $this->inspector->getNode($this->document);
  93.         }
  95.         $structureProperty = $this->structureMetadata->getProperty($name);
  97.         $contentTypeName = $structureProperty->getType();
  99.         $bridge = new StructureBridge(
  100.             $this->structureMetadata,
  101.             $this->inspector,
  102.             $this->legacyPropertyFactory,
  103.             $this->document
  104.         );
  106.         if ($structureProperty->isLocalized()) {
  107.             $locale = $this->inspector->getLocale($this->document);
  108.             $property = $this->legacyPropertyFactory->createTranslatedProperty($structureProperty, $locale, $bridge);
  109.         } else {
  110.             $property = $this->legacyPropertyFactory->createProperty($structureProperty);
  111.         }
  113.         $this->legacyProperties[$name] = $property;
  115.         $property->setStructure($bridge);
  117.         $contentType = $this->contentTypeManager->get($contentTypeName);
  118.         $contentType->read(
  119.             $this->node,
  120.             $property,
  121.             $bridge->getWebspaceKey(),
  122.             $bridge->getLanguageCode(),
  123.             null
  124.         );
  126.         $valueProperty = new PropertyValue($name, $property->getValue());
  127.         $this->properties[$name] = $valueProperty;
  129.         return $valueProperty;
  130.     }
  132.     public function getContentViewProperty($name)
  133.     {
  134.         if (isset($this->propertyValues[$name])) {
  135.             return $this->propertyValues[$name];
  136.         }
  138.         // initialize the legacy property
  139.         $this->getProperty($name);
  140.         $legacyProperty = $this->legacyProperties[$name];
  142.         $structureProperty = $this->structureMetadata->getProperty($name);
  143.         $contentTypeName = $structureProperty->getType();
  144.         $contentType = $this->contentTypeManager->get($contentTypeName);
  145.         $propertyValue = new PropertyValue(
  146.             $name,
  147.             $contentType->getContentData($legacyProperty)
  148.         );
  149.         $this->propertyValues[$name] = $propertyValue;
  151.         return $propertyValue;
  152.     }
  154.     /**
  155.      * Update the structure.
  156.      */
  157.     public function setStructureMetadata(StructureMetadata $structure)
  158.     {
  159.         $this->structureMetadata = $structure;
  160.     }
  162.     /**
  163.      * Return an array copy of the property data.
  164.      *
  165.      * @return array
  166.      */
  167.     public function toArray()
  168.     {
  169.         $this->init();
  170.         $values = [];
  171.         foreach (\array_keys($this->structureMetadata->getProperties()) as $childName) {
  172.             $values[$childName] = $this->normalize($this->getProperty($childName)->getValue());
  173.         }
  175.         return $values;
  176.     }
  178.     #[\ReturnTypeWillChange]
  179.     public function offsetExists($offset)
  180.     {
  181.         $this->init();
  183.         return $this->structureMetadata->hasProperty($offset);
  184.     }
  186.     public function bind($data, $clearMissing = true)
  187.     {
  188.         $this->init();
  190.         foreach ($this->structureMetadata->getProperties() as $childName => $child) {
  191.             if (false === $clearMissing && !\array_key_exists($childName, $data)) {
  192.                 continue;
  193.             }
  195.             $value = isset($data[$childName]) ? $data[$childName] : null;
  197.             $property = $this->getProperty($childName);
  198.             $property->setValue($value);
  199.         }
  200.     }
  202.     private function init()
  203.     {
  204.         if (!$this->structureMetadata) {
  205.             $this->structureMetadata = $this->inspector->getStructureMetadata($this->document);
  206.         }
  207.     }
  208. }