Merge "[TASK] Increase version number"
[Packages/TYPO3.CMS.git] / typo3 / sysext / fluid / Classes / ViewHelpers / CommentViewHelper.php
1 <?php
2
3 /* *
4 * This script is backported from the FLOW3 package "TYPO3.Fluid". *
5 * *
6 * It is free software; you can redistribute it and/or modify it under *
7 * the terms of the GNU Lesser General Public License, either version 3 *
8 * of the License, or (at your option) any later version. *
9 * *
10 * The TYPO3 project - inspiring people to share! *
11 * */
12
13 /**
14 * This ViewHelper prevents rendering of any content inside the tag
15 * Note: Contents of the comment will still be *parsed* thus throwing an
16 * Exception if it contains syntax errors. You can put child nodes in
17 * CDATA tags to avoid this.
18 *
19 * = Examples =
20 *
21 * <code title="Commenting out fluid code">
22 * Before
23 * <f:comment>
24 * This is completely hidden.
25 * <f:debug>This does not get parsed</f:debug>
26 * </f:comment>
27 * After
28 * </code>
29 * <output>
30 * Before
31 * After
32 * </output>
33 *
34 * <code title="Prevent parsing">
35 * <f:comment><![CDATA[
36 * <f:some.invalid.syntax />
37 * ]]></f:comment>
38 * </code>
39 * <output>
40 * </output>
41 *
42 * @api
43 */
44 class Tx_Fluid_ViewHelpers_CommentViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
45
46 /**
47 * @var boolean
48 */
49 protected $escapingInterceptorEnabled = FALSE;
50
51 /**
52 * Comments out the tag content
53 *
54 * @return string
55 * @api
56 */
57 public function render() {
58 }
59 }
60
61 ?>