[TASK] Deprecate some methods in `DebugUtility`

This commit deprecates some methods in `DebugUtility`. `debugRows()`
and :php:`printArray()` both have a duplicated method and
`debugInPopUpWindow()` is discouraged with the same reasonings as with
the removed of the Debug Console in #98069.

Resolves: #100653
Releases: main
Change-Id: I3bd986901435f4aa7a4e33fea5a614fe7a238264
Reviewed-on: https://review.typo3.org/c/Packages/TYPO3.CMS/+/78719


Tested-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Tested-by: Oliver Bartsch <bo@cedev.de>
Reviewed-by: Andreas Fernandez <a.fernandez@scripting-base.de>
Reviewed-by: Georg Ringer <georg.ringer@gmail.com>
Tested-by: core-ci <typo3@b13.com>
Tested-by: Georg Ringer <georg.ringer@gmail.com>
Reviewed-by: Oliver Bartsch <bo@cedev.de>

typo3/sysext/core/Classes/Utility/DebugUtility.php

@@ -58,9 +58,11 @@ class DebugUtility
 
     /**
      * Opens a debug message inside a popup window
+     * @deprecated since v12, will be removed in v13.
      */
     public static function debugInPopUpWindow(mixed $debugVariable, string $header = 'Debug', string $group = 'Debug'): void
     {
+        trigger_error('Method ' . __METHOD__ . ' has been deprecated in v12 and will be removed with v13.', E_USER_DEPRECATED);
         $debugString = self::renderDump($debugVariable, sprintf('%s (%s)', $header, $group));
         $script = '
 			(function debug() {
@@ -131,9 +133,11 @@ class DebugUtility
      *
      * @param array $rows Array of arrays with similar keys
      * @param string $header Table header
+     * @deprecated since v12, will be removed in v13.
      */
     public static function debugRows(array $rows, string $header = ''): void
     {
+        trigger_error('Method ' . __METHOD__ . ' has been deprecated in v12 in favor of ' . __CLASS__ . '::debug and will be removed with v13.', E_USER_DEPRECATED);
         self::debug($rows, $header);
     }
 
@@ -174,9 +178,11 @@ class DebugUtility
      *
      * @param mixed $array_in Array to print visually (in a table).
      * @see viewArray()
+     * @deprecated since v12, will be removed in v13.
      */
     public static function printArray(mixed $array_in): void
     {
+        trigger_error('Method ' . __METHOD__ . ' has been deprecated in v12 in favor of ' . __CLASS__ . '::viewArray and will be removed with v13.', E_USER_DEPRECATED);
         echo self::renderDump($array_in);
     }
 

typo3/sysext/core/Documentation/Changelog/12.4/Deprecation-100653-DeprecatedSomeMethodsInDebugUtility.rst

+.. include:: /Includes.rst.txt
+
+.. _deprecation-100653-1681805677:
+
+==============================================================
+Deprecation: #100653 - Deprecated some methods in DebugUtility
+==============================================================
+
+See :issue:`100653`
+
+Description
+===========
+
+The following methods in :php:`TYPO3\CMS\Core\Utility\DebugUtility` have been
+marked as deprecated:
+
+* :php:`debugInPopUpWindow()`
+* :php:`debugRows()`
+* :php:`printArray()`
+
+While :php:`debugRows()` and :php:`printArray()` duplicate already existing
+methods, :php:`debugInPopUpWindow()` is discouraged to use as either external
+debuggers, e.g. xdebug or :php:`TYPO3\CMS\Extbase\Utility\DebuggerUtility` may
+be used instead.
+
+
+Impact
+======
+
+Calling any of the aforementioned methods will trigger deprecation log entries.
+
+
+Affected installations
+======================
+
+Instances using any of the aforementioned methods are affected.
+
+The extension scanner will find and report usages.
+
+
+Migration
+=========
+
+In case of :php:`debugRows()`, the identical method :php:`debug()` can be used.
+The method :php:`printArray()` can be replaced with :php:`viewArray()`. However,
+the former method directly outputs the contents, which is not the case with
+:php:`viewArray()`.
+
+The method :php:`debugInPopUpWindow()` is deprecated without a direct
+replacement, consider using an external debugger or
+:php:`TYPO3\CMS\Extbase\Utility\DebuggerUtility::var_dump()` instead.
+
+.. index:: PHP-API, FullyScanned, ext:core

typo3/sysext/install/Configuration/ExtensionScanner/Php/MethodCallStaticMatcher.php

@@ -1506,4 +1506,25 @@ return [
             'Deprecation-100596-GeneralUtility_GET.rst',
         ],
     ],
+    'TYPO3\CMS\Core\Utility\DebugUtility::debugRows' => [
+        'numberOfMandatoryArguments' => 1,
+        'maximumNumberOfArguments' => 2,
+        'restFiles' => [
+            'Deprecation-100653-DeprecatedSomeMethodsInDebugUtility.rst',
+        ],
+    ],
+    'TYPO3\CMS\Core\Utility\DebugUtility::printArray' => [
+        'numberOfMandatoryArguments' => 1,
+        'maximumNumberOfArguments' => 1,
+        'restFiles' => [
+            'Deprecation-100653-DeprecatedSomeMethodsInDebugUtility.rst',
+        ],
+    ],
+    'TYPO3\CMS\Core\Utility\DebugUtility::debugInPopUpWindow' => [
+        'numberOfMandatoryArguments' => 1,
+        'maximumNumberOfArguments' => 3,
+        'restFiles' => [
+            'Deprecation-100653-DeprecatedSomeMethodsInDebugUtility.rst',
+        ],
+    ],
 ];