dda72daa070cdc9523553a3f9a5f5c19446dd6cc
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / Form / ValidationResultsViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers\Form;
3
4 /*
5 * This file is part of the TYPO3 CMS project.
6 *
7 * It is free software; you can redistribute it and/or modify it under
8 * the terms of the GNU General Public License, either version 2
9 * of the License, or any later version.
10 *
11 * For the full copyright and license information, please read the
12 * LICENSE.txt file that was distributed with this source code.
13 *
14 * The TYPO3 project - inspiring people to share!
15 */
16
17 /**
18 * Validation results view helper
19 *
20 * = Examples =
21 *
22 * <code title="Output error messages as a list">
23 * <f:form.validationResults>
24 * <f:if condition="{validationResults.flattenedErrors}">
25 * <ul class="errors">
26 * <f:for each="{validationResults.flattenedErrors}" as="errors" key="propertyPath">
27 * <li>{propertyPath}
28 * <ul>
29 * <f:for each="{errors}" as="error">
30 * <li>{error.code}: {error}</li>
31 * </f:for>
32 * </ul>
33 * </li>
34 * </f:for>
35 * </ul>
36 * </f:if>
37 * </f:form.validationResults>
38 * </code>
39 * <output>
40 * <ul class="errors">
41 * <li>1234567890: Validation errors for argument "newBlog"</li>
42 * </ul>
43 * </output>
44 *
45 * <code title="Output error messages for a single property">
46 * <f:form.validationResults for="someProperty">
47 * <f:if condition="{validationResults.flattenedErrors}">
48 * <ul class="errors">
49 * <f:for each="{validationResults.errors}" as="error">
50 * <li>{error.code}: {error}</li>
51 * </f:for>
52 * </ul>
53 * </f:if>
54 * </f:form.validationResults>
55 * </code>
56 * <output>
57 * <ul class="errors">
58 * <li>1234567890: Some error message</li>
59 * </ul>
60 * </output>
61 *
62 * @api
63 */
64 class ValidationResultsViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper
65 {
66 /**
67 * As this ViewHelper renders HTML, the output must not be escaped.
68 *
69 * @var bool
70 */
71 protected $escapeOutput = false;
72
73 /**
74 * Initialize arguments
75 *
76 * @api
77 */
78 public function initializeArguments()
79 {
80 parent::initializeArguments();
81 $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, '');
82 $this->registerArgument('as', 'string', 'The name of the variable to store the current error', false, 'validationResults');
83 }
84
85 /**
86 * Iterates through selected errors of the request.
87 *
88 * @return string Rendered string
89 * @api
90 */
91 public function render()
92 {
93 $for = $this->arguments['for'];
94 $as = $this->arguments['as'];
95
96 $validationResults = $this->controllerContext->getRequest()->getOriginalRequestMappingResults();
97 if ($validationResults !== null && $for !== '') {
98 $validationResults = $validationResults->forProperty($for);
99 }
100 $this->templateVariableContainer->add($as, $validationResults);
101 $output = $this->renderChildren();
102 $this->templateVariableContainer->remove($as);
103 return $output;
104 }
105 }