6d946877026b80dcf9796f16e817fc69527f1a4f
[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 script is backported from the TYPO3 Flow package "TYPO3.Fluid". *
6 * *
7 * It is free software; you can redistribute it and/or modify it under *
8 * the terms of the GNU Lesser General Public License, either version 3 *
9 * of the License, or (at your option) any later version. *
10 * *
11 * *
12 * This script is distributed in the hope that it will be useful, but *
13 * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN- *
14 * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser *
15 * General Public License for more details. *
16 * *
17 * You should have received a copy of the GNU Lesser General Public *
18 * License along with the script. *
19 * If not, see http://www.gnu.org/licenses/lgpl.html *
20 * *
21 * The TYPO3 project - inspiring people to share! *
22 * */
23 /**
24 * Error messages view helper
25 *
26 * = Examples =
27 *
28 * <code title="Output error messages as a list">
29 * <ul class="errors">
30 * <f:form.errors>
31 * <li>{error.code}: {error.message}</li>
32 * </f:form.errors>
33 * </ul>
34 * </code>
35 * <output>
36 * <ul>
37 * <li>1234567890: Validation errors for argument "newBlog"</li>
38 * </ul>
39 * </output>
40 *
41 * <code title="Output error messages for a single property">
42 * <f:form.errors for="someProperty">
43 * <div class="error">
44 * <strong>{error.propertyName}</strong>: <f:for each="{error.errors}" as="errorDetail">{errorDetail.message}</f:for>
45 * </div>
46 * </f:form.errors>
47 * </code>
48 * <output>
49 * <div class="error>
50 * <strong>someProperty:</strong> errorMessage1 errorMessage2
51 * </div>
52 * </output>
53 *
54 * @api
55 */
56 class ValidationResultsViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
57
58 /**
59 * Iterates through selected errors of the request.
60 *
61 * @param string $for 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.
62 * @param string $as The name of the variable to store the current error
63 * @return string Rendered string
64 * @api
65 */
66 public function render($for = '', $as = 'validationResults') {
67 $validationResults = $this->controllerContext->getRequest()->getOriginalRequestMappingResults();
68 if ($for !== '') {
69 $validationResults = $validationResults->forProperty($for);
70 }
71 $this->templateVariableContainer->add($as, $validationResults);
72 $output = $this->renderChildren();
73 $this->templateVariableContainer->remove($as);
74 return $output;
75 }
76 }
77
78 ?>