vendor/sulu/sulu/src/Sulu/Component/Content/Document/Extension/ManagedExtensionContainer.php line 97

  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\Extension;
  14. use PHPCR\NodeInterface;
  15. use Sulu\Component\Content\Extension\ExtensionManagerInterface;
  17. /**
  18.  * The managed extension container lazily loads data from the actual
  19.  * extension classes. It serves a similar, but not identical, role to
  20.  * the ManagedStructure.
  21.  *
  22.  * In contrast to the Structure, which is a container of properties and returns Property instances,
  23.  * extensions return simple arrays.
  24.  *
  25.  * Note that we should remove this class as retrieving the processed data
  26.  * for extensions should be done externally to the document.
  27.  */
  28. class ManagedExtensionContainer extends ExtensionContainer
  29. {
  30.     /**
  31.      * @var ExtensionManagerInterface
  32.      */
  33.     private $extensionManager;
  35.     /**
  36.      * @var NodeInterface
  37.      */
  38.     private $node;
  40.     /**
  41.      * @var string
  42.      */
  43.     private $locale;
  45.     /**
  46.      * @var string
  47.      */
  48.     private $prefix;
  50.     /**
  51.      * @var string
  52.      */
  53.     private $internalPrefix;
  55.     /**
  56.      * @var string
  57.      */
  58.     private $structureType;
  60.     /**
  61.      * @var string
  62.      */
  63.     private $webspaceName;
  65.     /**
  66.      * @param string $structureType
  67.      * @param string $locale
  68.      * @param string $prefix
  69.      * @param string $internalPrefix
  70.      * @param string $webspaceName
  71.      */
  72.     public function __construct(
  73.         $structureType,
  74.         ExtensionManagerInterface $extensionManager,
  75.         NodeInterface $node,
  76.         $locale,
  77.         $prefix,
  78.         $internalPrefix,
  79.         $webspaceName
  80.     ) {
  81.         parent::__construct();
  82.         $this->extensionManager = $extensionManager;
  83.         $this->node = $node;
  84.         $this->locale = $locale;
  85.         $this->prefix = $prefix;
  86.         $this->internalPrefix = $internalPrefix;
  87.         $this->structureType = $structureType;
  88.         $this->webspaceName = $webspaceName;
  89.     }
  91.     /**
  92.      * Lazily evaluate the value for the given extension.
  93.      *
  94.      * @param string $extensionName
  95.      */
  96.     #[\ReturnTypeWillChange]
  97.     public function offsetGet($extensionName)
  98.     {
  99.         if (isset($this->data[$extensionName])) {
  100.             return $this->data[$extensionName];
  101.         }
  103.         $extension = $this->extensionManager->getExtension($this->structureType, $extensionName);
  105.         // TODO: should not pass namespace here.
  106.         //       and indeed this call should be removed and the extension should be
  107.         //       passed the document.
  108.         $extension->setLanguageCode($this->locale, $this->prefix, $this->internalPrefix);
  110.         // passing the webspace and locale would also be unnecessary if we passed the
  111.         // document
  112.         $data = $extension->load($this->node, $this->webspaceName, $this->locale);
  114.         $this->data[$extensionName] = $data;
  116.         return $data;
  117.     }
  119.     #[\ReturnTypeWillChange]
  120.     public function offsetExists($extensionName)
  121.     {
  122.         return $this->extensionManager->hasExtension($this->structureType, $extensionName);
  123.     }
  125.     public function toArray()
  126.     {
  127.         $result = [];
  129.         foreach ($this->extensionManager->getExtensions($this->structureType) as $extension) {
  130.             $result[$extension->getName()] = $this->offsetGet($extension->getName());
  131.         }
  133.         return $result;
  134.     }
  135. }