vendor/sulu/sulu/src/Sulu/Bundle/SnippetBundle/Content/SnippetContent.php line 168

  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\SnippetBundle\Content;
  14. use PHPCR\NodeInterface;
  15. use PHPCR\PropertyType;
  16. use PHPCR\Util\UUIDHelper;
  17. use Sulu\Bundle\SnippetBundle\Snippet\DefaultSnippetManagerInterface;
  18. use Sulu\Bundle\SnippetBundle\Snippet\SnippetResolverInterface;
  19. use Sulu\Bundle\SnippetBundle\Snippet\WrongSnippetTypeException;
  20. use Sulu\Bundle\WebsiteBundle\ReferenceStore\ReferenceStoreInterface;
  21. use Sulu\Component\Content\Compat\PropertyInterface;
  22. use Sulu\Component\Content\Compat\PropertyParameter;
  23. use Sulu\Component\Content\Compat\Structure\PageBridge;
  24. use Sulu\Component\Content\Compat\Structure\SnippetBridge;
  25. use Sulu\Component\Content\ComplexContentType;
  26. use Sulu\Component\Content\ContentTypeExportInterface;
  27. use Sulu\Component\Content\PreResolvableContentTypeInterface;
  29. class SnippetContent extends ComplexContentType implements ContentTypeExportInterface, PreResolvableContentTypeInterface
  30. {
  31.     /**
  32.      * @var SnippetResolverInterface
  33.      */
  34.     private $snippetResolver;
  36.     /**
  37.      * @var DefaultSnippetManagerInterface
  38.      */
  39.     private $defaultSnippetManager;
  41.     /**
  42.      * @var ReferenceStoreInterface
  43.      */
  44.     private $referenceStore;
  46.     /**
  47.      * @var bool
  48.      */
  49.     protected $defaultEnabled;
  51.     /**
  52.      * @param true $defaultEnabled
  53.      */
  54.     public function __construct(
  55.         DefaultSnippetManagerInterface $defaultSnippetManager,
  56.         SnippetResolverInterface $snippetResolver,
  57.         ReferenceStoreInterface $referenceStore,
  58.         $defaultEnabled
  59.     ) {
  60.         $this->snippetResolver = $snippetResolver;
  61.         $this->defaultSnippetManager = $defaultSnippetManager;
  62.         $this->referenceStore = $referenceStore;
  63.         $this->defaultEnabled = $defaultEnabled;
  64.     }
  66.     public function read(NodeInterface $node, PropertyInterface $property, $webspaceKey, $languageCode, $segmentKey)
  67.     {
  68.         $refs = [];
  69.         if ($node->hasProperty($property->getName())) {
  70.             $refs = $node->getProperty($property->getName())->getString();
  71.         }
  73.         $property->setValue($refs);
  74.     }
  76.     public function write(
  77.         NodeInterface $node,
  78.         PropertyInterface $property,
  79.         $userId,
  80.         $webspaceKey,
  81.         $languageCode,
  82.         $segmentKey
  83.     ) {
  84.         $values = $property->getValue();
  86.         $snippetReferences = [];
  87.         $values = \is_array($values) ? $values : [];
  89.         foreach ($values as $value) {
  90.             if ($value instanceof SnippetBridge) {
  91.                 $snippetReferences[] = $value->getUuid();
  92.             } elseif (\is_array($value) && \array_key_exists('uuid', $value) && UUIDHelper::isUUID($value['uuid'])) {
  93.                 $snippetReferences[] = $value['uuid'];
  94.             } elseif (UUIDHelper::isUUID($value)) {
  95.                 $snippetReferences[] = $value;
  96.             } else {
  97.                 throw new \InvalidArgumentException(
  98.                     \sprintf(
  99.                         'Property value must either be a UUID or a Snippet, "%s" given.',
  100.                         \gettype($value)
  101.                     )
  102.                 );
  103.             }
  104.         }
  106.         $node->setProperty($property->getName(), $snippetReferences, PropertyType::REFERENCE);
  107.     }
  109.     public function remove(NodeInterface $node, PropertyInterface $property, $webspaceKey, $languageCode, $segmentKey)
  110.     {
  111.         if ($node->hasProperty($property->getName())) {
  112.             $node->getProperty($property->getName())->remove();
  113.         }
  114.     }
  116.     public function getViewData(PropertyInterface $property)
  117.     {
  118.         $viewData = [];
  119.         foreach ($this->getSnippets($property) as $snippet) {
  120.             $viewData[] = $snippet['view'];
  121.         }
  123.         return $viewData;
  124.     }
  126.     public function getContentData(PropertyInterface $property)
  127.     {
  128.         $contentData = [];
  129.         foreach ($this->getSnippets($property) as $snippet) {
  130.             $contentData[] = $snippet['content'];
  131.         }
  133.         return $contentData;
  134.     }
  136.     /**
  137.      * Returns snippets with given property value.
  138.      */
  139.     private function getSnippets(PropertyInterface $property)
  140.     {
  141.         /** @var PageBridge $page */
  142.         $page = $property->getStructure();
  143.         $webspaceKey = $page->getWebspaceKey();
  144.         $locale = $page->getLanguageCode();
  145.         $shadowLocale = null;
  146.         if ($page->getIsShadow()) {
  147.             $shadowLocale = $page->getShadowBaseLanguage();
  148.         }
  150.         $refs = $property->getValue();
  151.         $ids = $this->getUuids($refs);
  153.         $snippetType = $this->getParameterValue($property->getParams(), 'snippetType');
  154.         $default = $this->getParameterValue($property->getParams(), 'default', false);
  156.         $snippetArea = $default;
  157.         if (true === $snippetArea || 'true' === $snippetArea) {
  158.             $snippetArea = $snippetType;
  159.         }
  161.         if (empty($ids) && $snippetArea && $this->defaultEnabled) {
  162.             $ids = $this->loadSnippetAreaIds($webspaceKey, $snippetArea, $locale);
  163.         }
  165.         $params = $property->getParams();
  166.         $loadExcerpt = isset($params['loadExcerpt']) ? $params['loadExcerpt']->getValue() : false;
  168.         return $this->snippetResolver->resolve($ids, $webspaceKey, $locale, $shadowLocale, $loadExcerpt);
  169.     }
  171.     private function loadSnippetAreaIds($webspaceKey, $snippetArea, $locale)
  172.     {
  173.         try {
  174.             $snippet = $this->defaultSnippetManager->load($webspaceKey, $snippetArea, $locale);
  175.         } catch (WrongSnippetTypeException $exception) {
  176.             return [];
  177.         }
  179.         if (!$snippet) {
  180.             return [];
  181.         }
  183.         return [$snippet->getUuid()];
  184.     }
  186.     /**
  187.      * The data is not always normalized, so we normalize the data here.
  188.      */
  189.     private function getUuids($data)
  190.     {
  191.         return \is_array($data) ? $data : [];
  192.     }
  194.     /**
  195.      * Returns value of parameter.
  196.      * If parameter not exists the default will be returned.
  197.      *
  198.      * @param PropertyParameter[] $parameter
  199.      * @param string $name
  200.      */
  201.     private function getParameterValue(array $parameter, $name, $default = null)
  202.     {
  203.         if (!\array_key_exists($name, $parameter)) {
  204.             return $default;
  205.         }
  207.         return $parameter[$name]->getValue();
  208.     }
  210.     public function exportData($propertyValue)
  211.     {
  212.         $uuids = $this->getUuids($propertyValue);
  214.         if (empty($uuids)) {
  215.             return '';
  216.         }
  218.         return \json_encode($this->getUuids($propertyValue));
  219.     }
  221.     public function importData(
  222.         NodeInterface $node,
  223.         PropertyInterface $property,
  224.         $value,
  225.         $userId,
  226.         $webspaceKey,
  227.         $languageCode,
  228.         $segmentKey = null
  229.     ) {
  230.         $property->setValue(\json_decode($value));
  231.         $this->write($node, $property, $userId, $webspaceKey, $languageCode, $segmentKey);
  232.     }
  234.     public function preResolve(PropertyInterface $property)
  235.     {
  236.         foreach ($this->getUuids($property->getValue()) as $uuid) {
  237.             $this->referenceStore->add($uuid);
  238.         }
  239.     }
  240. }