vendor/sulu/sulu/src/Sulu/Component/Content/Compat/Structure/LegacyPropertyFactory.php line 177

  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\Component\Content\Compat\Block\BlockProperty;
  15. use Sulu\Component\Content\Compat\Block\BlockPropertyType;
  16. use Sulu\Component\Content\Compat\Property as LegacyProperty;
  17. use Sulu\Component\Content\Compat\PropertyInterface;
  18. use Sulu\Component\Content\Compat\PropertyParameter;
  19. use Sulu\Component\Content\Compat\PropertyTag;
  20. use Sulu\Component\Content\Compat\PropertyType;
  21. use Sulu\Component\Content\Compat\Section\SectionProperty;
  22. use Sulu\Component\Content\Compat\StructureInterface;
  23. use Sulu\Component\Content\Mapper\Translation\TranslatedProperty;
  24. use Sulu\Component\Content\Metadata\BlockMetadata;
  25. use Sulu\Component\Content\Metadata\ItemMetadata;
  26. use Sulu\Component\Content\Metadata\Property;
  27. use Sulu\Component\Content\Metadata\PropertyMetadata;
  28. use Sulu\Component\Content\Metadata\SectionMetadata;
  29. use Sulu\Component\DocumentManager\NamespaceRegistry;
  31. /**
  32.  * Creates legacy properties from "new" properties.
  33.  *
  34.  * @deprecated
  35.  */
  36. class LegacyPropertyFactory
  37. {
  38.     private $namespaceRegistry;
  40.     public function __construct(NamespaceRegistry $namespaceRegistry)
  41.     {
  42.         $this->namespaceRegistry = $namespaceRegistry;
  43.     }
  45.     /**
  46.      * Create a new "translated" property.
  47.      *
  48.      * @param object $property
  49.      * @param string $locale
  50.      *
  51.      * @return PropertyInterface
  52.      */
  53.     public function createTranslatedProperty($property, $locale, StructureInterface $structure = null)
  54.     {
  55.         if ($property instanceof ItemMetadata) {
  56.             $property = $this->createProperty($property, $structure);
  57.         }
  58.         $property = new TranslatedProperty(
  59.             $property,
  60.             $locale,
  61.             $this->namespaceRegistry->getPrefix('content_localized')
  62.         );
  64.         return $property;
  65.     }
  67.     /**
  68.      * Create a new property.
  69.      *
  70.      * @return PropertyInterface $property
  71.      */
  72.     public function createProperty(ItemMetadata $property, StructureInterface $structure = null)
  73.     {
  74.         if ($property instanceof SectionMetadata) {
  75.             return $this->createSectionProperty($property, $structure);
  76.         }
  78.         if ($property instanceof BlockMetadata) {
  79.             return $this->createBlockProperty($property, $structure);
  80.         }
  82.         if (!$property instanceof PropertyMetadata) {
  83.             throw new \RuntimeException(\sprintf(
  84.                 'Property needs to be of type [%s].',
  85.                 \implode(', ', [
  86.                     PropertyMetadata::class,
  87.                     BlockMetadata::class,
  88.                     SectionMetadata::class,
  89.                 ])
  90.             ));
  91.         }
  93.         if (null === $property->getType()) {
  94.             throw new \RuntimeException(\sprintf(
  95.                 'Property name "%s" has no type.',
  96.                 $property->getName()
  97.             ));
  98.         }
  100.         $parameters = $this->convertArrayToParameters($property->getParameters());
  101.         $propertyBridge = new LegacyProperty(
  102.             $property->getName(),
  103.             [
  104.                 'title' => $property->getTitles(),
  105.                 'info_text' => $property->getDescriptions(),
  106.                 'placeholder' => $property->getPlaceholders(),
  107.             ],
  108.             $property->getType(),
  109.             $property->isRequired(),
  110.             $property->isLocalized(),
  111.             $property->getMaxOccurs(),
  112.             $property->getMinOccurs(),
  113.             $parameters,
  114.             [],
  115.             $property->getColSpan(),
  116.             $property->getDefaultComponentName()
  117.         );
  119.         foreach ($property->getTags() as $tag) {
  120.             $propertyBridge->addTag(new PropertyTag($tag['name'], $tag['priority'], $tag['attributes']));
  121.         }
  123.         foreach ($property->getComponents() as $component) {
  124.             $propertyType = new PropertyType(
  125.                 $component->getName(),
  126.                 [
  127.                     'title' => $component->getTitles(),
  128.                     'info_text' => $component->getDescriptions(),
  129.                 ]
  130.             );
  132.             foreach ($component->getChildren() as $property) {
  133.                 $propertyType->addChild($this->createProperty($property, $structure));
  134.             }
  136.             $propertyBridge->addType($propertyType);
  137.         }
  138.         $propertyBridge->setStructure($structure);
  140.         return $propertyBridge;
  141.     }
  143.     private function convertArrayToParameters($arrayParams)
  144.     {
  145.         $parameters = [];
  146.         foreach ($arrayParams as $arrayParam) {
  147.             $value = $arrayParam['value'];
  149.             if (\is_array($value)) {
  150.                 $value = $this->convertArrayToParameters($value);
  151.             }
  153.             $parameters[$arrayParam['name']] = new PropertyParameter($arrayParam['name'], $value, $arrayParam['type'], $arrayParam['meta']);
  154.         }
  156.         return $parameters;
  157.     }
  159.     private function createSectionProperty(SectionMetadata $property, StructureInterface $structure = null)
  160.     {
  161.         $sectionProperty = new SectionProperty(
  162.             $property->getName(),
  163.             [
  164.                 'title' => $property->getTitles(),
  165.                 'info_text' => $property->getDescriptions(),
  166.             ],
  167.             $property->getColSpan()
  168.         );
  170.         foreach ($property->getChildren() as $child) {
  171.             $sectionProperty->addChild($this->createProperty($child, $structure));
  172.         }
  174.         return $sectionProperty;
  175.     }
  177.     private function createBlockProperty(BlockMetadata $property, StructureInterface $structure = null)
  178.     {
  179.         $blockProperty = new BlockProperty(
  180.             $property->getName(),
  181.             [
  182.                 'title' => $property->getTitles(),
  183.                 'info_text' => $property->getDescriptions(),
  184.             ],
  185.             $property->getDefaultComponentName(),
  186.             $property->isRequired(),
  187.             $property->isLocalized(),
  188.             $property->getMaxOccurs(),
  189.             $property->getMinOccurs(),
  190.             $property->getParameters(),
  191.             [],
  192.             $property->getColSpan()
  193.         );
  194.         $blockProperty->setStructure($structure);
  196.         foreach ($property->getComponents() as $component) {
  197.             $blockPropertyType = new BlockPropertyType(
  198.                 $component->getName(),
  199.                 [
  200.                     'title' => $component->getTitles(),
  201.                     'info_text' => $component->getDescriptions(),
  202.                 ]
  203.             );
  205.             foreach ($component->getChildren() as $property) {
  206.                 $blockPropertyType->addChild($this->createProperty($property, $structure));
  207.             }
  209.             $blockProperty->addType($blockPropertyType);
  210.         }
  212.         return $blockProperty;
  213.     }
  214. }