93 lines
3.6 KiB
PHP
93 lines
3.6 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!
|
|
*/
|
|
|
|
namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
|
|
|
|
use Psr\Http\Message\ServerRequestInterface;
|
|
use TYPO3\CMS\Extbase\Mvc\RequestInterface;
|
|
use TYPO3Fluid\Fluid\Core\Variables\ScopedVariableProvider;
|
|
use TYPO3Fluid\Fluid\Core\Variables\StandardVariableProvider;
|
|
use TYPO3Fluid\Fluid\Core\ViewHelper\AbstractViewHelper;
|
|
|
|
/**
|
|
* ViewHelper which renders form validation results.
|
|
*
|
|
* ```
|
|
* <f:form.validationResults>
|
|
* <f:if condition="{validationResults.flattenedErrors}">
|
|
* <ul>
|
|
* <f:for each="{validationResults.flattenedErrors}" as="errors" key="propertyPath">
|
|
* <li>{propertyPath}
|
|
* <ul>
|
|
* <f:for each="{errors}" as="error">
|
|
* <li>{error.code}: {error}</li>
|
|
* </f:for>
|
|
* </ul>
|
|
* </li>
|
|
* </f:for>
|
|
* </ul>
|
|
* </f:if>
|
|
* </f:form.validationResults>
|
|
*
|
|
* <f:form.validationResults for="someProperty">
|
|
* <f:for each="{validationResults.flattenedErrors}" as="errors" key="propertyPath">
|
|
* <f:for each="{errors}" as="error">
|
|
* <p data-property-path="{propertyPath}">{error.code}: {error}</p>
|
|
* </f:for>
|
|
* </f:for>
|
|
* </f:form.validationResults>
|
|
* ```
|
|
*
|
|
* @see https://docs.typo3.org/permalink/t3viewhelper:typo3-fluid-form-validationresults
|
|
*/
|
|
final class ValidationResultsViewHelper extends AbstractViewHelper
|
|
{
|
|
/**
|
|
* As this ViewHelper renders HTML, the output must not be escaped.
|
|
*
|
|
* @var bool
|
|
*/
|
|
protected $escapeOutput = false;
|
|
|
|
public function initializeArguments(): void
|
|
{
|
|
$this->registerArgument('for', 'string', 'The name of the error name (e.g. argument name or property name). This can also be a property path (like blog.title), and will then only display the validation errors of that property.', false, '');
|
|
$this->registerArgument('as', 'string', 'The name of the variable to store the current error', false, 'validationResults');
|
|
}
|
|
|
|
public function render(): string
|
|
{
|
|
$for = $this->arguments['for'];
|
|
$as = $this->arguments['as'];
|
|
if (!$this->renderingContext->hasAttribute(ServerRequestInterface::class)
|
|
|| !$this->renderingContext->getAttribute(ServerRequestInterface::class) instanceof RequestInterface
|
|
) {
|
|
throw new \RuntimeException('ValidationResultsViewHelper needs an extbase request to work.', 1724244193);
|
|
}
|
|
$extbaseRequestParameters = $this->renderingContext->getAttribute(ServerRequestInterface::class)->getAttribute('extbase');
|
|
$validationResults = $extbaseRequestParameters->getOriginalRequestMappingResults();
|
|
if ($validationResults !== null && $for !== '') {
|
|
$validationResults = $validationResults->forProperty($for);
|
|
}
|
|
$variableProvider = new ScopedVariableProvider($this->renderingContext->getVariableProvider(), new StandardVariableProvider([$as => $validationResults]));
|
|
$this->renderingContext->setVariableProvider($variableProvider);
|
|
$output = (string)$this->renderChildren();
|
|
$this->renderingContext->setVariableProvider($variableProvider->getGlobalVariableProvider());
|
|
return $output;
|
|
}
|
|
}
|