ffb09635226b9b6ef26f213b6d9e12fc99b2ee76
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / CaseViewHelper.php
1 <?php
2 namespace TYPO3\CMS\Fluid\ViewHelpers;
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 * The TYPO3 project - inspiring people to share! *
12 * */
13
14 use TYPO3\CMS\Core\Utility\GeneralUtility;
15 use TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper;
16 use TYPO3\CMS\Fluid\Core\ViewHelper\Exception;
17 use TYPO3Fluid\Fluid\Core\Rendering\RenderingContextInterface;
18 use TYPO3Fluid\Fluid\ViewHelpers\SwitchViewHelper as OriginalSwitchViewHelper;
19
20 /**
21 * Case view helper that is only usable within the SwitchViewHelper.
22 * @see \TYPO3\CMS\Fluid\ViewHelpers\SwitchViewHelper
23 *
24 * @api
25 */
26 class CaseViewHelper extends AbstractViewHelper
27 {
28 /**
29 * @var bool
30 */
31 protected $escapeOutput = false;
32
33 /**
34 * Initialize ViewHelper arguments
35 *
36 * @return void
37 */
38 public function initializeArguments()
39 {
40 $this->registerArgument('value', 'mixed', 'The switch value. If it matches, the child will be rendered.', false, null);
41 $this->registerArgument('default', 'bool', 'If this is set, this child will be rendered, if none else matches.', false, false);
42 }
43
44 /***
45 * @return string the contents of this view helper if $value equals the expression of the surrounding switch view helper, or $default is TRUE. otherwise an empty string
46 * @throws Exception
47 *
48 * @api
49 */
50 public function render()
51 {
52 return static::renderStatic(
53 [
54 'value' => $this->arguments['value'],
55 'default' => $this->arguments['default']
56 ],
57 $this->buildRenderChildrenClosure(),
58 $this->renderingContext
59 );
60 }
61
62 /**
63 * @param array $arguments
64 * @param \Closure $renderChildrenClosure
65 * @param RenderingContextInterface $renderingContext
66 *
67 * @return mixed|string
68 * @throws Exception
69 */
70 public static function renderStatic(array $arguments, \Closure $renderChildrenClosure, RenderingContextInterface $renderingContext)
71 {
72 $value = $arguments['value'];
73 $default = $arguments['default'];
74 $viewHelperVariableContainer = $renderingContext->getViewHelperVariableContainer();
75 if ($default !== false) {
76 GeneralUtility::deprecationLog('Argument "default" on f:case is deprecated - use f:defaultCase instead');
77 }
78 if ($value === null && $default === false) {
79 throw new Exception('The case View helper must have either value or default argument', 1382867521);
80 }
81 $expression = $viewHelperVariableContainer->get(OriginalSwitchViewHelper::class, 'switchExpression');
82
83 // non-type-safe comparison by intention
84 if ($default === true || $expression == $value) {
85 $viewHelperVariableContainer->addOrUpdate(OriginalSwitchViewHelper::class, 'break', true);
86 return $renderChildrenClosure();
87 }
88
89 return '';
90 }
91 }