TYPO3 v15 dev-main snapshot ()

2026-08-10 22:31:09 +02:00
commit af8cc155b5
6818 changed files with 642608 additions and 0 deletions
@@ -0,0 +1,158 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the TYPO3 CMS project.
+ *
+ * It is free software; you can redistribute it and/or modify it under
+ * the terms of the GNU General Public License, either version 2
+ * of the License, or any later version.
+ *
+ * For the full copyright and license information, please read the
+ * LICENSE.txt file that was distributed with this source code.
+ *
+ * The TYPO3 project - inspiring people to share!
+ */
+
+namespace TYPO3\CMS\Core\Utility;
+
+use TYPO3\CMS\Core\Core\Environment;
+use TYPO3\CMS\Extbase\Utility\DebuggerUtility;
+
+/**
+ * Class to handle debug
+ */
+class DebugUtility
+{
+    protected static bool $plainTextOutput = true;
+
+    protected static bool $ansiColorUsage = true;
+
+    /**
+     * Debug
+     *
+     * Directly echos out debug information as HTML (or plain in CLI context)
+     */
+    public static function debug(mixed $var = '', string $header = 'Debug'): void
+    {
+        // buffer the output of debug if no buffering started before
+        if (ob_get_level() === 0) {
+            ob_start();
+        }
+
+        echo self::renderDump($var, $header);
+    }
+
+    /**
+     * Converts a variable to a string
+     *
+     * @return string Plain, not HTML encoded string
+     */
+    public static function convertVariableToString(mixed $variable): string
+    {
+        $string = self::renderDump($variable, '', true, false);
+        return $string === '' ? '| debug |' : $string;
+    }
+
+    /**
+     * Displays the "path" of the function call stack in a string, using debug_backtrace
+     *
+     * @param bool $prependFileNames If set to true file names are added to the output
+     * @return string Plain, not HTML encoded string
+     */
+    public static function debugTrail(bool $prependFileNames = false): string
+    {
+        $trail = debug_backtrace(0);
+        $trail = array_reverse($trail);
+        array_pop($trail);
+        $path = [];
+        foreach ($trail as $dat) {
+            $fileInformation = $prependFileNames && !empty($dat['file']) ? $dat['file'] . ':' : '';
+            $pathFragment = $fileInformation . ($dat['class'] ?? '') . ($dat['type'] ?? '') . $dat['function'];
+            // add the path of the included file
+            if (in_array($dat['function'], ['require', 'include', 'require_once', 'include_once'])) {
+                $pathFragment .= '(' . PathUtility::stripPathSitePrefix($dat['args'][0]) . '),' . PathUtility::stripPathSitePrefix($dat['file']);
+            }
+            if (array_key_exists('line', $dat)) {
+                $path[] = $pathFragment . '#' . $dat['line'];
+            } else {
+                $path[] = $pathFragment;
+            }
+        }
+        return implode(' // ', $path);
+    }
+
+    /**
+     * Returns a string with a list of ascii-values for the first $characters characters in $string
+     *
+     * @param string $string String to show ASCII value for
+     * @param int $characters Number of characters to show
+     * @return string The string with ASCII values in separated by a space char.
+     */
+    public static function ordinalValue(string $string, int $characters = 100): string
+    {
+        if (strlen($string) < $characters) {
+            $characters = strlen($string);
+        }
+        $valuestring = '';
+        for ($i = 0; $i < $characters; $i++) {
+            $valuestring .= ' ' . ord($string[$i]);
+        }
+        return trim($valuestring);
+    }
+
+    /**
+     * Returns HTML-code, which is a visual representation of a multidimensional array
+     * use \TYPO3\CMS\Core\Utility\GeneralUtility::print_array() in order to print an array
+     * Returns FALSE if $array_in is not an array
+     *
+     * @param mixed $array_in Array to view
+     * @return string HTML output
+     */
+    public static function viewArray(mixed $array_in): string
+    {
+        return self::renderDump($array_in);
+    }
+
+    /**
+     * Renders the dump according to the context, either for command line or as HTML output
+     *
+     * @param bool|null $plainText Omit or pass null to use the current default.
+     * @param bool|null $ansiColors Omit or pass null to use the current default.
+     */
+    protected static function renderDump(mixed $variable, string $title = '', ?bool $plainText = null, ?bool $ansiColors = null): string
+    {
+        $plainText = $plainText ?? Environment::isCli() && self::$plainTextOutput;
+        $ansiColors = $ansiColors ?? Environment::isCli() && self::$ansiColorUsage;
+        return trim(DebuggerUtility::var_dump($variable, $title, 8, $plainText, $ansiColors, true));
+    }
+
+    /**
+     * Preset plaintext output
+     *
+     * Warning:
+     * This is NOT a public API method and must not be used in own extensions!
+     * This method is usually only used in tests to preset the output behaviour
+     *
+     * @internal
+     */
+    public static function usePlainTextOutput(bool $plainTextOutput): void
+    {
+        static::$plainTextOutput = $plainTextOutput;
+    }
+
+    /**
+     * Preset ansi color usage
+     *
+     * Warning:
+     * This is NOT a public API method and must not be used in own extensions!
+     * This method is usually only used in tests to preset the ansi color usage
+     *
+     * @internal
+     */
+    public static function useAnsiColor(bool $ansiColorUsage): void
+    {
+        static::$ansiColorUsage = $ansiColorUsage;
+    }
+}