vendor/pimcore/pimcore/lib/Twig/Extension/DocumentEditableExtension.php line 92

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\Twig\Extension;
  18. use Pimcore\Model\Document\Editable\BlockInterface;
  19. use Pimcore\Model\Document\PageSnippet;
  20. use Pimcore\Templating\Renderer\EditableRenderer;
  21. use Twig\Extension\AbstractExtension;
  22. use Twig\TwigFunction;
  24. /**
  25. * @internal
  26. */
  27. class DocumentEditableExtension extends AbstractExtension
  28. {
  29. /**
  30. * @var EditableRenderer
  31. */
  32. protected $editableRenderer;
  34. /**
  35. * @param EditableRenderer $editableRenderer
  36. */
  37. public function __construct(EditableRenderer $editableRenderer)
  38. {
  39. $this->editableRenderer = $editableRenderer;
  40. }
  42. /**
  43. * {@inheritdoc}
  44. */
  45. public function getFunctions(): array
  46. {
  47. return [
  48. new TwigFunction('pimcore_*', [$this, 'renderEditable'], [
  49. 'needs_context' => true,
  50. 'is_safe' => ['html'],
  51. ]),
  52. new TwigFunction('pimcore_iterate_block', [$this, 'getBlockIterator']),
  53. ];
  55. // @phpstan-ignore-next-line those are just for auto-complete, not nice, but works ;-)
  56. new TwigFunction('pimcore_area');
  57. new TwigFunction('pimcore_areablock');
  58. new TwigFunction('pimcore_block');
  59. new TwigFunction('pimcore_checkbox');
  60. new TwigFunction('pimcore_date');
  61. new TwigFunction('pimcore_embed');
  62. new TwigFunction('pimcore_image');
  63. new TwigFunction('pimcore_input');
  64. new TwigFunction('pimcore_link');
  65. new TwigFunction('pimcore_multiselect');
  66. new TwigFunction('pimcore_numeric');
  67. new TwigFunction('pimcore_pdf');
  68. new TwigFunction('pimcore_relation');
  69. new TwigFunction('pimcore_relations');
  70. new TwigFunction('pimcore_renderlet');
  71. new TwigFunction('pimcore_scheduledblock');
  72. new TwigFunction('pimcore_select');
  73. new TwigFunction('pimcore_snippet');
  74. new TwigFunction('pimcore_table');
  75. new TwigFunction('pimcore_textarea');
  76. new TwigFunction('pimcore_video');
  77. new TwigFunction('pimcore_wysiwyg');
  78. }
  80. /**
  81. * @internal
  82. *
  83. * @param array $context
  84. * @param string $type
  85. * @param string $name
  86. * @param array $options
  87. *
  88. * @return \Pimcore\Model\Document\Editable\EditableInterface|string
  89. *
  90. * @throws \Exception
  91. */
  92. public function renderEditable(array $context, string $type, string $name, array $options = [])
  93. {
  94. $document = $context['document'];
  95. $editmode = $context['editmode'];
  96. if (!($document instanceof PageSnippet)) {
  97. return '';
  98. }
  100. return $this->editableRenderer->render($document, $type, $name, $options, $editmode);
  101. }
  103. /**
  104. * Returns an iterator which can be used instead of while($block->loop())
  105. *
  106. * @internal
  107. *
  108. * @param BlockInterface $block
  109. *
  110. * @return \Generator
  111. */
  112. public function getBlockIterator(BlockInterface $block): \Generator
  113. {
  114. return $block->getIterator();
  115. }
  116. }