DebugUtility.php

Go to the documentation of this file.

<?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\Core\Core\RequestId;
use ‪TYPO3\CMS\Extbase\Utility\DebuggerUtility;
 
class ‪DebugUtility
{
    protected static bool ‪$plainTextOutput = true;
 
    protected static bool ‪$ansiColorUsage = true;
 
    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);
    }
 
    public static function ‪convertVariableToString(mixed $variable): string
    {
        $string = ‪self::renderDump($variable, '', true, false);
        return $string === '' ? '| debug |' : $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);
    }
 
    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);
    }
 
    public static function ‪viewArray(mixed $array_in): string
    {
        return ‪self::renderDump($array_in);
    }
 
    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));
    }
 
    public static function ‪usePlainTextOutput(bool ‪$plainTextOutput): void
    {
        static::$plainTextOutput = ‪$plainTextOutput;
    }
 
    public static function ‪useAnsiColor(bool ‪$ansiColorUsage): void
    {
        static::$ansiColorUsage = ‪$ansiColorUsage;
    }
 
    protected static function ‪resolveNonceValue(): string
    {
        return GeneralUtility::makeInstance(RequestId::class)->nonce->b64;
    }
}