9.5/_debug_utility_8php_source.html

<?php

namespace ‪TYPO3\CMS\Core\Utility;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Core\Environment;

use ‪TYPO3\CMS\Extbase\Utility\DebuggerUtility;


class ‪DebugUtility

{

    protected static ‪$plainTextOutput = true;


    protected static ‪$ansiColorUsage = true;


    public static function ‪debug($var = '', $header = 'Debug', $group = 'Debug')

    {

        // buffer the output of debug if no buffering started before

        if (ob_get_level() === 0) {

            ob_start();

        }


        if (TYPO3_MODE === 'BE' && !‪Environment::isCli()) {

            $debug = ‪self::renderDump($var);

            $debugPlain = PHP_EOL . ‪self::renderDump($var, '', true, false);

            $script = '

                (function debug() {

                    var message = ' . GeneralUtility::quoteJSvalue($debug) . ',

                        messagePlain = ' . GeneralUtility::quoteJSvalue($debugPlain) . ',

                        header = ' . GeneralUtility::quoteJSvalue($header) . ',

                        group = ' . GeneralUtility::quoteJSvalue($group) . ';

                    if (top.TYPO3 && top.TYPO3.DebugConsole) {

                        top.TYPO3.DebugConsole.add(message, header, group);

                    } else {

                        var consoleMessage = [group, header, messagePlain].join(" | ");

                        if (typeof console === "object" && typeof console.log === "function") {

                            console.log(consoleMessage);

                        }

                    };

                })();

            ';

            echo GeneralUtility::wrapJS($script);

        } else {

            echo ‪self::renderDump($var, $header);

        }

    }


    public static function ‪convertVariableToString($variable)

    {

        $string = ‪self::renderDump($variable, '', true, false);

        return $string === '' ? '| debug |' : $string;

    }


    public static function ‪debugInPopUpWindow($debugVariable, $header = 'Debug', $group = 'Debug')

    {

        $debugString = ‪self::renderDump($debugVariable, sprintf('%s (%s)', $header, $group));

        $script = '

            (function debug() {

                var debugMessage = ' . GeneralUtility::quoteJSvalue($debugString) . ',

                    header = ' . GeneralUtility::quoteJSvalue($header) . ',

                    group = ' . GeneralUtility::quoteJSvalue($group) . ',


                    browserWindow = function(debug, header, group) {

                        var newWindow = window.open("", "TYPO3DebugWindow_" + group,

                            "width=600,height=400,menubar=0,toolbar=1,status=0,scrollbars=1,resizable=1"

                        );

                        if (newWindow.document.body.innerHTML) {

                            newWindow.document.body.innerHTML = newWindow.document.body.innerHTML +

                                "<hr />" + debugMessage;

                        } else {

                            newWindow.document.writeln(

                                "<html><head><title>Debug: " + header + "(" + group + ")</title></head>"

                                + "<body onload=\\"self.focus()\\">"

                                + debugMessage

                                + "</body></html>"

                            );

                        }

                    };


                if (top && typeof top.TYPO3 !== "undefined" && typeof top.TYPO3.Modal !== "undefined") {

                    top.TYPO3.Modal.show(

                        "Debug: " + header + " (" + group + ")",

                        debugMessage,

                        top.TYPO3.Severity.notice

                    );

                } else {

                    browserWindow(debugMessage, header, group);

                }

            })();

        ';

        echo GeneralUtility::wrapJS($script);

    }


    public static function ‪debugTrail($prependFileNames = false)

    {

        $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']);

            }

            $path[] = $pathFragment . '#' . $dat['line'];

        }

        return implode(' // ', $path);

    }


    public static function ‪debugRows($rows, $header = '')

    {

        ‪self::debug($rows, $header);

    }


    public static function ‪ordinalValue($string, $characters = 100)

    {

        if (strlen($string) < $characters) {

            $characters = strlen($string);

        }

        $valuestring = '';

        for ($i = 0; $i < $characters; $i++) {

            $valuestring .= ' ' . ord(substr($string, $i, 1));

        }

        return trim($valuestring);

    }


    public static function ‪viewArray($array_in)

    {

        return ‪self::renderDump($array_in);

    }


    public static function ‪printArray($array_in)

    {

        echo ‪self::renderDump($array_in);

    }


    protected static function ‪renderDump($variable, $title = '', $plainText = null, $ansiColors = null)

    {

        $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(‪$plainTextOutput)

    {

        static::$plainTextOutput = ‪$plainTextOutput;

    }


    public static function ‪useAnsiColor(‪$ansiColorUsage)

    {

        static::$ansiColorUsage = ‪$ansiColorUsage;

    }

}