[TASK] Improve View Helper documentation 70/61570/2
authorDaniel Siepmann <daniel.siepmann@typo3.org>
Wed, 28 Aug 2019 16:20:18 +0000 (18:20 +0200)
committerAndreas Fernandez <a.fernandez@scripting-base.de>
Wed, 28 Aug 2019 18:37:02 +0000 (20:37 +0200)
* Fix syntax issue within TranslateViewHelper.
* Make HtmlentitiesDecodeViewHelper and HtmlentitiesViewHelper easier to
  understand.

Resolves: #89034
Releases: master, 9.5
Change-Id: I53efa0ae3ef81d4b41d13042b096c37a3edcd4f6
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/61570
Tested-by: TYPO3com <noreply@typo3.com>
Tested-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Anja Leichsenring <aleichsenring@ab-softlab.de>
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesDecodeViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/Format/HtmlentitiesViewHelper.php
typo3/sysext/fluid/Classes/ViewHelpers/TranslateViewHelper.php

index 7816cc2..95133c4 100644 (file)
@@ -31,7 +31,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  *
  *    <f:format.htmlentitiesDecode>{text}</f:format.htmlentitiesDecode>
  *
- * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities :php:`html_entity_decode` applied.
+ * Text containing the following escaped signs: ``&amp;`` ``&quot;`` ``&#039;`` ``&lt;`` ``&gt;``, will be processed by :php:`html_entity_decode()`.
+ * These will result in: ``&`` ``"`` ``'`` ``<`` ``>``.
  *
  * Inline notation
  * ---------------
@@ -40,7 +41,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  *
  *    {text -> f:format.htmlentitiesDecode(encoding: 'ISO-8859-1')}
  *
- * Text with ``&amp;`` ``&quot;`` ``&lt;`` ``&gt;`` replaced by unescaped entities :php:`html_entity_decode` applied.
+ * Text containing the following escaped signs: ``&amp;`` ``&quot;`` ``&#039;`` ``&lt;`` ``&gt;``, will be processed by :php:`html_entity_decode()`.
+ * These will result in: ``&`` ``"`` ``'`` ``<`` ``>``.
+ *
+ * But encoded as ISO-8859-1.
  */
 class HtmlentitiesDecodeViewHelper extends AbstractEncodingViewHelper
 {
index 3e520cf..67185da 100644 (file)
@@ -31,7 +31,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  *
  *    <f:format.htmlentities>{text}</f:format.htmlentities>
  *
- * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities :php:`htmlentities` applied.
+ * Text containing the following signs ``&`` ``"`` ``'`` ``<`` ``>`` will be processed by :php:`htmlentities()`.
+ * These will result in: ``&amp;`` ``&quot;`` ``&#039;`` ``&lt;`` ``&gt;``.
  *
  * Inline notation
  * ---------------
@@ -40,7 +41,10 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithContentArgumentAndRenderS
  *
  *    {text -> f:format.htmlentities(encoding: 'ISO-8859-1')}
  *
- * Text with ``&`` ``"`` ``'`` ``<`` ``>`` ``*`` replaced by HTML entities :php:`htmlentities` applied.
+ * Text containing the following signs ``&`` ``"`` ``'`` ``<`` ``>`` will be processed by :php:`htmlentities()`.
+ * These will result in: ``&amp;`` ``&quot;`` ``&#039;`` ``&lt;`` ``&gt;``.
+ *
+ * But encoded as ISO-8859-1.
  */
 class HtmlentitiesViewHelper extends AbstractEncodingViewHelper
 {
index a29a917..dcc5903 100644 (file)
@@ -34,8 +34,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <f:translate key="key1" />
  *
- * Value of key "key1" in the current website language. Alternatively id can be used instead of
- * key:
+ * Value of key ``key1`` in the current website language. Alternatively id can
+ * be used instead of key::
  *
  *    <f:translate id="key1" />
  *
@@ -48,7 +48,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <f:format.raw><f:translate key="htmlKey" /></f:format.raw>
  *
- * Value of key "htmlKey" in the current website language, no :php:`htmlspecialchars` applied.
+ * Value of key ``htmlKey`` in the current website language, no :php:`htmlspecialchars()` applied.
  *
  * Translate key from custom locallang file
  * ----------------------------------------
@@ -57,7 +57,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    <f:translate key="LLL:EXT:myext/Resources/Private/Language/locallang.xlf:key1" />
  *
- * Value of key "key1" in the current website language.
+ * Value of key ``key1`` in the current website language.
  *
  * Inline notation with arguments and default value
  * ------------------------------------------------
@@ -66,8 +66,8 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    {f:translate(key: 'argumentsKey', arguments: {0: 'dog', 1: 'fox'}, default: 'default value')}
  *
- * Value of key "argumentsKey" in the current website language
- * with "%1" and "%2" are replaced by "dog" and "fox" (:php:`printf`).
+ * Value of key ``argumentsKey`` in the current website language
+ * with ``%1`` and ``%2`` are replaced by "dog" and "fox" (:php:`printf()`).
  * If the key is not found, the output is "default value".
  *
  * Inline notation with extension name
@@ -77,7 +77,7 @@ use TYPO3Fluid\Fluid\Core\ViewHelper\Traits\CompileWithRenderStatic;
  *
  *    {f:translate(key: 'someKey', extensionName: 'SomeExtensionName')}
  *
- * Value of key "someKey" in the current website language.
+ * Value of key ``someKey`` in the current website language.
  * The locallang file of extension "some_extension_name" will be used.
  */
 class TranslateViewHelper extends AbstractViewHelper