vendor/pimcore/pimcore/lib/Templating/Renderer/EditableRenderer.php line 142

Open in your IDE?
  1. <?php
  3. /**
  4. * Pimcore
  5. *
  6. * This source file is available under two different licenses:
  7. * - GNU General Public License version 3 (GPLv3)
  8. * - Pimcore Commercial License (PCL)
  9. * Full copyright and license information is available in
  10. * LICENSE.md which is distributed with this source code.
  11. *
  12. * @copyright Copyright (c) Pimcore GmbH (http://www.pimcore.org)
  13. * @license http://www.pimcore.org/license GPLv3 and PCL
  14. */
  16. namespace Pimcore\Templating\Renderer;
  18. use Pimcore\Document\Editable\EditmodeEditableDefinitionCollector;
  19. use Pimcore\Http\Request\Resolver\EditmodeResolver;
  20. use Pimcore\Model\Document\Editable;
  21. use Pimcore\Model\Document\Editable\LazyLoadingInterface;
  22. use Pimcore\Model\Document\Editable\Loader\EditableLoaderInterface;
  23. use Pimcore\Model\Document\PageSnippet;
  24. use Psr\Log\LoggerAwareInterface;
  25. use Psr\Log\LoggerAwareTrait;
  27. /**
  28. * @internal
  29. */
  30. class EditableRenderer implements LoggerAwareInterface
  31. {
  32. use LoggerAwareTrait;
  34. /**
  35. * @var EditableLoaderInterface
  36. */
  37. protected $editableLoader;
  39. /**
  40. * @var EditmodeResolver
  41. */
  42. protected $editmodeResolver;
  44. protected ?EditmodeEditableDefinitionCollector $configCollector;
  46. /**
  47. * @param EditableLoaderInterface $editableLoader
  48. * @param EditmodeResolver $editmodeResolver
  49. * @param EditmodeEditableDefinitionCollector $configCollector
  50. */
  51. public function __construct(EditableLoaderInterface $editableLoader, EditmodeResolver $editmodeResolver, EditmodeEditableDefinitionCollector $configCollector)
  52. {
  53. $this->editableLoader = $editableLoader;
  54. $this->editmodeResolver = $editmodeResolver;
  55. $this->configCollector = $configCollector;
  56. }
  58. /**
  59. * @param string $type
  60. *
  61. * @return bool
  62. */
  63. public function editableExists($type)
  64. {
  65. return $this->editableLoader->supports($type);
  66. }
  68. /**
  69. * @param PageSnippet $document
  70. * @param string $type
  71. * @param string $name
  72. * @param array $config
  73. * @param bool|null $editmode
  74. *
  75. * @return Editable\EditableInterface
  76. *
  77. * @throws \Exception
  78. */
  79. public function getEditable(PageSnippet $document, string $type, string $name, array $config = [], bool $editmode = null): Editable\EditableInterface
  80. {
  81. $type = strtolower($type);
  83. $originalName = $name;
  84. $name = Editable::buildEditableName($type, $originalName, $document);
  85. $realName = Editable::buildEditableRealName($originalName, $document);
  87. if (null === $editmode) {
  88. $editmode = $this->editmodeResolver->isEditmode();
  89. }
  91. $editable = $document->getEditable($name);
  92. if ($editable instanceof Editable\EditableInterface && $editable->getType() === $type) {
  93. // call the load() method if it exists to reinitialize the data (eg. from serializing, ...)
  94. //TODO Pimcore 11: remove method_exists BC layer
  95. if ($editable instanceof LazyLoadingInterface || method_exists($editable, 'load')) {
  96. if (!$editable instanceof LazyLoadingInterface) {
  97. trigger_deprecation('pimcore/pimcore', '10.3',
  98. sprintf('Usage of method_exists is deprecated since version 10.3 and will be removed in Pimcore 11.' .
  99. 'Implement the %s interface instead.', LazyLoadingInterface::class));
  100. }
  101. $editable->load();
  102. }
  103. } else {
  104. $editable = $this->editableLoader->build($type);
  105. $editable->setName($name);
  106. $document->setEditable($editable);
  108. //set default value on initial build
  109. if (isset($config['defaultValue'])) {
  110. $editable->setDataFromResource($config['defaultValue']);
  111. }
  112. }
  114. $editable->setDocument($document);
  115. $editable->setEditmode($editmode);
  116. // set the real name of this editable, without the prefixes and suffixes from blocks and areablocks
  117. $editable->setRealName($realName);
  118. $editable->setConfig($config);
  120. if ($editmode) {
  121. $editable->setEditableDefinitionCollector($this->configCollector);
  122. }
  124. return $editable;
  125. }
  127. /**
  128. * Renders an editable
  129. *
  130. * @param PageSnippet $document
  131. * @param string $type
  132. * @param string $name
  133. * @param array $options
  134. * @param bool|null $editmode
  135. *
  136. * @return Editable\EditableInterface
  137. *
  138. * @throws \Exception
  139. */
  140. public function render(PageSnippet $document, string $type, string $name, array $options = [], bool $editmode = null)
  141. {
  142. return $this->getEditable($document, $type, $name, $options, $editmode);
  143. }
  144. }