[TASK] Sync CMS Fluid with Flow Fluid 1.1 (part1)
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / CommentViewHelper.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 /**
15 * This ViewHelper prevents rendering of any content inside the tag
16 * Note: Contents of the comment will still be **parsed** thus throwing an
17 * Exception if it contains syntax errors. You can put child nodes in
18 * CDATA tags to avoid this.
19 *
20 * = Examples =
21 *
22 * <code title="Commenting out fluid code">
23 * Before
24 * <f:comment>
25 * This is completely hidden.
26 * <f:debug>This does not get parsed</f:debug>
27 * </f:comment>
28 * After
29 * </code>
30 * <output>
31 * Before
32 * After
33 * </output>
34 *
35 * <code title="Prevent parsing">
36 * <f:comment><![CDATA[
37 * <f:some.invalid.syntax />
38 * ]]></f:comment>
39 * </code>
40 * <output>
41 * </output>
42 *
43 * @api
44 */
45 class CommentViewHelper extends \TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper {
46
47 /**
48 * @var boolean
49 */
50 protected $escapingInterceptorEnabled = FALSE;
51
52 /**
53 * Comments out the tag content
54 *
55 * @return string
56 * @api
57 */
58 public function render() {
59 }
60 }
61
62 ?>