85 lines
2.9 KiB
PHP
85 lines
2.9 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
/*
|
|
* This file is part of the TYPO3 CMS project.
|
|
*
|
|
* It is free software; you can redistribute it and/or modify it under
|
|
* the terms of the GNU General Public License, either version 2
|
|
* of the License, or any later version.
|
|
*
|
|
* For the full copyright and license information, please read the
|
|
* LICENSE.txt file that was distributed with this source code.
|
|
*
|
|
* The TYPO3 project - inspiring people to share!
|
|
*/
|
|
|
|
/*
|
|
* Inspired by and partially taken from the Neos.Form package (www.neos.io)
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Form\ViewHelpers;
|
|
|
|
use Psr\EventDispatcher\EventDispatcherInterface;
|
|
use TYPO3\CMS\Form\Domain\Model\Renderable\RenderableInterface;
|
|
use TYPO3\CMS\Form\Domain\Model\Renderable\RootRenderableInterface;
|
|
use TYPO3\CMS\Form\Domain\Runtime\FormRuntime;
|
|
use TYPO3\CMS\Form\Event\BeforeRenderableIsRenderedEvent;
|
|
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
|
|
|
|
/**
|
|
* Render a renderable.
|
|
*
|
|
* Set the renderable into the \TYPO3\CMS\Form\Mvc\View\FormView
|
|
* and return the rendered content.
|
|
*
|
|
* Scope: frontend
|
|
*
|
|
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-form-renderrenderable
|
|
*/
|
|
final class RenderRenderableViewHelper extends AbstractViewHelper
|
|
{
|
|
/**
|
|
* @var bool
|
|
*/
|
|
protected $escapeOutput = false;
|
|
|
|
public function __construct(
|
|
private readonly EventDispatcherInterface $eventDispatcher,
|
|
) {}
|
|
|
|
public function initializeArguments(): void
|
|
{
|
|
$this->registerArgument('renderable', RootRenderableInterface::class, 'A RenderableInterface instance', true);
|
|
}
|
|
|
|
public function render(): string
|
|
{
|
|
/** @var FormRuntime $formRuntime */
|
|
$formRuntime = $this->renderingContext
|
|
->getViewHelperVariableContainer()
|
|
->get(self::class, 'formRuntime');
|
|
$renderable = $this->arguments['renderable'];
|
|
$this->eventDispatcher->dispatch(new BeforeRenderableIsRenderedEvent($renderable, $formRuntime));
|
|
$content = '';
|
|
if ($renderable instanceof FormRuntime || ($renderable instanceof RenderableInterface && $renderable->isEnabled())) {
|
|
$content = $this->renderChildren();
|
|
}
|
|
// Wrap every renderable with a span with an identifier path data attribute if previewMode is active
|
|
if (!empty($content)) {
|
|
$renderingOptions = $formRuntime->getRenderingOptions();
|
|
if (isset($renderingOptions['previewMode']) && $renderingOptions['previewMode'] === true) {
|
|
$path = $renderable->getIdentifier();
|
|
if ($renderable instanceof RenderableInterface) {
|
|
while ($renderable = $renderable->getParentRenderable()) {
|
|
$path = $renderable->getIdentifier() . '/' . $path;
|
|
}
|
|
}
|
|
$content = '<span data-element-identifier-path="' . $path . '">' . $content . '</span>';
|
|
}
|
|
}
|
|
return $content;
|
|
}
|
|
}
|