[TASK] Deprecate EXT:lowlevel ArrayBrowser->wrapValue 53/52153/3
authorBenni Mack <benni@typo3.org>
Sat, 25 Mar 2017 17:05:14 +0000 (18:05 +0100)
committerChristian Kuhn <lolli@schwarzbu.ch>
Sat, 25 Mar 2017 22:17:54 +0000 (23:17 +0100)
The method ArrayBrowser->wrapValue() only does a htmlspecialchars()
call nowadays and can be replaced easily by PHP native functions.

Resolves: #80440
Releases: master
Change-Id: I1646adc0c501b386ed289f428420b3e6ec6a5000
Reviewed-on: https://review.typo3.org/52153
Tested-by: TYPO3com <no-reply@typo3.com>
Reviewed-by: Oliver Klee <typo3-coding@oliverklee.de>
Reviewed-by: Christian Kuhn <lolli@schwarzbu.ch>
Tested-by: Christian Kuhn <lolli@schwarzbu.ch>
typo3/sysext/core/Documentation/Changelog/master/Deprecation-80440-EXTlowlevelArrayBrowser-wrapValue.rst [new file with mode: 0644]
typo3/sysext/lowlevel/Classes/Utility/ArrayBrowser.php

diff --git a/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80440-EXTlowlevelArrayBrowser-wrapValue.rst b/typo3/sysext/core/Documentation/Changelog/master/Deprecation-80440-EXTlowlevelArrayBrowser-wrapValue.rst
new file mode 100644 (file)
index 0000000..5d98c5c
--- /dev/null
@@ -0,0 +1,33 @@
+.. include:: ../../Includes.txt
+
+==========================================================
+Deprecation: #80440 - EXT:lowlevel ArrayBrowser->wrapValue
+==========================================================
+
+See :issue:`80440`
+
+Description
+===========
+
+The method ``ArrayBrowser->wrapValue`` in EXT:lowlevel has been marked as deprecated, since the sole
+logic was to wrap the incoming string into htmlspecialchars().
+
+
+Impact
+======
+
+Calling the method will trigger a deprecation warning.
+
+
+Affected Installations
+======================
+
+Any TYPO3 installation using the EXT:lowlevel ArrayBrowser class in a custom extension.
+
+
+Migration
+=========
+
+Remove the call to the method and directly use ``htmlspecialchars()`` instead.
+
+.. index:: PHP-API
\ No newline at end of file
index 198f2c5..b6b7709 100644 (file)
@@ -114,7 +114,7 @@ class ArrayBrowser
             $output .= '<span class="list-tree-group">';
             $output .= $this->wrapArrayKey($key, $depth, !$isArray ? $value : '');
             if (!$isArray) {
-                $output .= ' = <span class="list-tree-value">' . $this->wrapValue($value) . '</span>';
+                $output .= ' = <span class="list-tree-value">' . htmlspecialchars($value) . '</span>';
             }
             $output .= '</span>';
             if ($isExpanded) {
@@ -134,9 +134,11 @@ class ArrayBrowser
      *
      * @param string $theValue The title string
      * @return string Title string, htmlspecialchars()'ed
+     * @deprecated since TYPO3 v8, will be removed in TYPO3 v9
      */
     public function wrapValue($theValue)
     {
+        GeneralUtility::logDeprecatedFunction();
         $wrappedValue = '';
         if ((string)$theValue !== '') {
             $wrappedValue = htmlspecialchars($theValue);