[+FEATURE] Comment ViewHelper
authorClaus Due <claus@wildside.dk>
Sun, 21 Aug 2011 13:04:52 +0000 (15:04 +0200)
committerBastian Waidelich <bastian@typo3.org>
Tue, 6 Sep 2011 18:49:45 +0000 (20:49 +0200)
This adds a commenting ViewHelper to prevent output and parsing
of specific parts of Fluid templates.
Usage:
<f:comment>This won't be rendered</f:comment>

Change-Id: I68634012ad99a004020a13d0dbfcded3fd2c0970
Resolves: #13592

typo3/sysext/fluid/Classes/ViewHelpers/CommentViewHelper.php [new file with mode: 0644]

diff --git a/typo3/sysext/fluid/Classes/ViewHelpers/CommentViewHelper.php b/typo3/sysext/fluid/Classes/ViewHelpers/CommentViewHelper.php
new file mode 100644 (file)
index 0000000..c660df0
--- /dev/null
@@ -0,0 +1,57 @@
+<?php
+
+/*                                                                        *
+ * This script belongs to the FLOW3 package "Fluid".                      *
+ *                                                                        *
+ * It is free software; you can redistribute it and/or modify it under    *
+ * the terms of the GNU Lesser General Public License as published by the *
+ * Free Software Foundation, either version 3 of the License, or (at your *
+ * option) any later version.                                             *
+ *                                                                        *
+ * This script is distributed in the hope that it will be useful, but     *
+ * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHAN-    *
+ * TABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser       *
+ * General Public License for more details.                               *
+ *                                                                        *
+ * You should have received a copy of the GNU Lesser General Public       *
+ * License along with the script.                                         *
+ * If not, see http://www.gnu.org/licenses/lgpl.html                      *
+ *                                                                        *
+ * The TYPO3 project - inspiring people to share!                         *
+ *                                                                        */
+
+/**
+ * This ViewHelper prevents parsing and output of any content inside the tag
+ *
+ * = Examples =
+ *
+ * <code title="Commenting out fluid code">
+ * Before
+ * <f:comment>
+ *   This is completely hidden.
+ *   <f:debug>This does not get parsed</f:debug>
+ * </f:comment>
+ * After
+ * </code>
+ * <output>
+ * Before
+ * After
+ * </output>
+ *
+ * @license http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License, version 3 or later
+ * @api
+ */
+class Tx_Fluid_ViewHelpers_CommentViewHelper extends Tx_Fluid_Core_ViewHelper_AbstractViewHelper {
+
+       /**
+        * Comments out the tag content
+        *
+        * @return string
+        * @author Claus Due <claus@wildside.dk>
+        * @api
+        */
+       public function render() {
+       }
+}
+
+?>