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

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\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. * @param string $structureType
  32. * @param string $locale
  33. * @param string $prefix
  34. * @param string $internalPrefix
  35. * @param string $webspaceName
  36. */
  37. public function __construct(
  38. private $structureType,
  39. private ExtensionManagerInterface $extensionManager,
  40. private NodeInterface $node,
  41. private $locale,
  42. private $prefix,
  43. private $internalPrefix,
  44. private $webspaceName
  45. ) {
  46. parent::__construct();
  47. }
  49. /**
  50. * Lazily evaluate the value for the given extension.
  51. *
  52. * @param string $extensionName
  53. */
  54. #[\ReturnTypeWillChange]
  55. public function offsetGet($extensionName)
  56. {
  57. if (isset($this->data[$extensionName])) {
  58. return $this->data[$extensionName];
  59. }
  61. $extension = $this->extensionManager->getExtension($this->structureType, $extensionName);
  63. // TODO: should not pass namespace here.
  64. // and indeed this call should be removed and the extension should be
  65. // passed the document.
  66. $extension->setLanguageCode($this->locale, $this->prefix, $this->internalPrefix);
  68. // passing the webspace and locale would also be unnecessary if we passed the
  69. // document
  70. $data = $extension->load($this->node, $this->webspaceName, $this->locale);
  72. $this->data[$extensionName] = $data;
  74. return $data;
  75. }
  77. #[\ReturnTypeWillChange]
  78. public function offsetExists($extensionName)
  79. {
  80. return $this->extensionManager->hasExtension($this->structureType, $extensionName);
  81. }
  83. public function toArray()
  84. {
  85. $result = [];
  87. foreach ($this->extensionManager->getExtensions($this->structureType) as $extension) {
  88. $result[$extension->getName()] = $this->offsetGet($extension->getName());
  89. }
  91. return $result;
  92. }
  93. }