xicrow / php-debug

src/Debugger.php

<?php
namespace Xicrow\PhpDebug;

/**
 * Class Debugger
 *
 * @package Xicrow\PhpDebug
 */
class Debugger
{
    /**
     * @var string|null
     */
    public static $documentRoot = null;

    /**
     * @var bool
     */
    public static $showCalledFrom = true;

    /**
     * @var bool
     */
    public static $output = true;

    /**
     * @var array
     */
    public static $style = [
        'output_format'        => '<pre style="margin-top: 0; padding: 5px; font-family: Menlo, Monaco, Consolas, monospace; font-weight: bold; font-size: 12px; background-color: #18171B; border: none; border-radius: 0; color: #FF8400; display: block; z-index: 1000; overflow: auto;">%s</pre>',
        'called_from_format'   => '<pre style="margin-bottom: 0; padding: 5px; font-family: Menlo, Monaco, Consolas, monospace; font-weight: normal; font-size: 12px; background-color: #18171B; border: none; border-radius: 0; color: #AAAAAA; display: block; z-index: 1000;  overflow: auto;">%s</pre>',
        'debug_null_format'    => '<span style="color: #B729D9;">%s</span>',
        'debug_boolean_format' => '<span style="color: #B729D9;">%s</span>',
        'debug_integer_format' => '<span style="color: #1299DA;">%s</span>',
        'debug_double_format'  => '<span style="color: #1299DA;">%s</span>',
        'debug_string_format'  => '<span style="color: #1299DA;">"</span>%s<span style="color: #1299DA;">"</span>',
    ];

    /**
     * @param string $data
     * @param array  $options
     *
     * @codeCoverageIgnore
     */
    public static function output($data, array $options = [])
    {
        $options = array_merge([
            'trace_offset' => 0,
        ], $options);

        if (!self::$output || !is_string($data)) {
            return;
        }

        if (php_sapi_name() == 'cli') {
            echo str_pad(' DEBUG ', 100, '-', STR_PAD_BOTH);
            echo "\n";
            if (self::$showCalledFrom) {
                echo self::getCalledFrom($options['trace_offset'] + 2);
                echo "\n";
            }
            echo $data;
            echo "\n";
        } else {
            if (self::$showCalledFrom) {
                echo sprintf(self::$style['called_from_format'], self::getCalledFrom($options['trace_offset'] + 2));
            }
            echo sprintf(self::$style['output_format'], $data);
        }
    }

    /**
     * @param mixed $data
     * @param array $options
     *
     * @codeCoverageIgnore
     */
    public static function debug($data, array $options = [])
    {
        $options = array_merge([
            'trace_offset' => 0,
        ], $options);

        self::output(self::getDebugInformation($data), $options);
    }

    /**
     * @param array $options
     *
     * @codeCoverageIgnore
     */
    public static function showTrace(array $options = [])
    {
        $options = array_merge([
            'trace_offset' => 0,
            'reverse'      => false,
        ], $options);

        $backtrace = ($options['reverse'] ? array_reverse(debug_backtrace()) : debug_backtrace());

        $output     = '';
        $traceIndex = ($options['reverse'] ? 1 : count($backtrace));
        foreach ($backtrace as $trace) {
            $output .= $traceIndex . ': ';
            $output .= self::getCalledFromTrace($trace);
            $output .= "\n";

            $traceIndex += ($options['reverse'] ? 1 : -1);
        }

        self::output($output, $options);
    }

    /**
     * @param string $class
     * @param bool   $output
     *
     * @return string
     */
    public static function reflectClass($class, $output = true)
    {
        $data = '';

        $reflectionClass = new \ReflectionClass($class);

        $comment = $reflectionClass->getDocComment();
        if (!empty($comment)) {
            $data .= $comment;
            $data .= "\n";
        }

        $data         .= 'class ' . $reflectionClass->name . '{';
        $firstElement = true;
        foreach ($reflectionClass->getProperties() as $reflectionProperty) {
            if (!$firstElement) {
                $data .= "\n";
            }
            $firstElement = false;

            $data .= self::reflectClassProperty($class, $reflectionProperty->name, false);
        }

        foreach ($reflectionClass->getMethods() as $reflectionMethod) {
            if (!$firstElement) {
                $data .= "\n";
            }
            $firstElement = false;

            $data .= self::reflectClassMethod($class, $reflectionMethod->name, false);
        }
        $data .= "\n";
        $data .= '}';

        if ($output) {
            self::output($data);
        }

        return $data;
    }

    /**
     * @param string $class
     * @param string $property
     *
     * @return string
     */
    public static function reflectClassProperty($class, $property, $output = true)
    {
        $data = '';

        $reflectionClass    = new \ReflectionClass($class);
        $reflectionProperty = new \ReflectionProperty($class, $property);

        $defaultPropertyValues = $reflectionClass->getDefaultProperties();

        $comment = $reflectionProperty->getDocComment();
        if (!empty($comment)) {
            $data .= "\n";
            $data .= "\t";
            $data .= $comment;
        }

        $data .= "\n";
        $data .= "\t";
        $data .= ($reflectionProperty->isPublic() ? 'public ' : '');
        $data .= ($reflectionProperty->isPrivate() ? 'private ' : '');
        $data .= ($reflectionProperty->isProtected() ? 'protected ' : '');
        $data .= ($reflectionProperty->isStatic() ? 'static ' : '');
        $data .= '$' . $reflectionProperty->name;
        if (isset($defaultPropertyValues[$property])) {
            $data .= ' = ' . self::getDebugInformation($defaultPropertyValues[$property]);
        }
        $data .= ';';

        if ($output) {
            self::output($data);
        }

        return $data;
    }

    /**
     * @param string $class
     * @param string $method
     * @param bool   $output
     *
     * @return string
     */
    public static function reflectClassMethod($class, $method, $output = true)
    {
        $data = '';

        $reflectionMethod = new \ReflectionMethod($class, $method);

        $comment = $reflectionMethod->getDocComment();
        if (!empty($comment)) {
            $data .= "\n";
            $data .= "\t";
            $data .= $comment;
        }

        $data .= "\n";
        $data .= "\t";
        $data .= ($reflectionMethod->isPublic() ? 'public ' : '');
        $data .= ($reflectionMethod->isPrivate() ? 'private ' : '');
        $data .= ($reflectionMethod->isProtected() ? 'protected ' : '');
        $data .= ($reflectionMethod->isStatic() ? 'static ' : '');
        $data .= 'function ' . $reflectionMethod->name . '(';
        if ($reflectionMethod->getNumberOfParameters()) {
            foreach ($reflectionMethod->getParameters() as $reflectionMethodParameterIndex => $reflectionMethodParameter) {
                $data .= ($reflectionMethodParameterIndex > 0 ? ', ' : '');
                $data .= '$' . $reflectionMethodParameter->name;
                if ($reflectionMethodParameter->isDefaultValueAvailable()) {
                    $defaultValue = self::getDebugInformation($reflectionMethodParameter->getDefaultValue());
                    $defaultValue = str_replace(["\n", "\t"], '', $defaultValue);
                    $data         .= ' = ' . $defaultValue;
                }
            }
        }
        $data .= ') {}';

        if ($output) {
            self::output($data);
        }

        return $data;
    }

    /**
     * @param int $index
     *
     * @return string
     */
    public static function getCalledFrom($index = 0)
    {
        $backtrace = debug_backtrace();

        if (!isset($backtrace[$index])) {
            return 'Unknown trace with index: ' . $index;
        }

        return self::getCalledFromTrace($backtrace[$index]);
    }

    /**
     * @param array $trace
     *
     * @return string
     */
    public static function getCalledFromTrace($trace)
    {
        // Get file and line number
        $calledFromFile = '';
        if (isset($trace['file'])) {
            $calledFromFile .= $trace['file'] . ' line ' . $trace['line'];
            $calledFromFile = str_replace('\\', '/', $calledFromFile);
            $calledFromFile = (!empty(self::$documentRoot) ? substr($calledFromFile, strlen(self::$documentRoot)) : $calledFromFile);
            $calledFromFile = trim($calledFromFile, '/');
        }

        // Get function call
        $calledFromFunction = '';
        if (isset($trace['function'])) {
            $calledFromFunction .= (isset($trace['class']) ? $trace['class'] : '');
            $calledFromFunction .= (isset($trace['type']) ? $trace['type'] : '');
            $calledFromFunction .= $trace['function'] . '()';
        }

        // Return called from
        if ($calledFromFile) {
            return $calledFromFile;
        } elseif ($calledFromFunction) {
            return $calledFromFunction;
        } else {
            return 'Unable to get called from trace';
        }
    }

    /**
     * @param mixed $data
     *
     * @return string
     */
    public static function getDebugInformation($data, array $options = [])
    {
        // Merge options with default options
        $options = array_merge([
            'depth'  => 25,
            'indent' => 0,
        ], $options);

        // Get data type
        $dataType = gettype($data);

        // Set name of method to get debug information for data
        $methodName = 'getDebugInformation' . ucfirst(strtolower($dataType));

        // Get result from debug information method
        $result = 'No method found supporting data type: ' . $dataType;
        if (method_exists('\Xicrow\PhpDebug\Debugger', $methodName)) {
            $result = (string)self::$methodName($data, [
                'depth'  => ($options['depth'] - 1),
                'indent' => ($options['indent'] + 1),
            ]);
        }

        // Format the result
        if (php_sapi_name() != 'cli' && !empty(self::$style['debug_' . strtolower($dataType) . '_format'])) {
            $result = sprintf(self::$style['debug_' . strtolower($dataType) . '_format'], $result);
        }

        // Return result
        return $result;
    }

    /**
     * @return string
     */
    private static function getDebugInformationString($data)
    {
        return (string)(php_sapi_name() == 'cli' ? '"' . $data . '"' : htmlentities($data, ENT_SUBSTITUTE));
    }

    /**
     * @return string
     */
    private static function getDebugInformationNull()
    {
        return 'NULL';
    }

    /**
     * @param boolean $data
     *
     * @return string
     */
    private static function getDebugInformationBoolean($data)
    {
        return ($data ? 'TRUE' : 'FALSE');
    }

    /**
     * @param integer $data
     *
     * @return string
     */
    private static function getDebugInformationInteger($data)
    {
        return (string)$data;
    }

    /**
     * @param double $data
     *
     * @return string
     */
    private static function getDebugInformationDouble($data)
    {
        return (string)$data;
    }

    /**
     * @param array $data
     *
     * @return string
     */
    private static function getDebugInformationArray($data, array $options = [])
    {
        $options = array_merge([
            'depth'  => 25,
            'indent' => 0,
        ], $options);

        $debugInfo = "[";

        $break = $end = null;
        if (!empty($data)) {
            $break = "\n" . str_repeat("\t", $options['indent']);
            $end   = "\n" . str_repeat("\t", $options['indent'] - 1);
        }

        $datas = [];
        if ($options['depth'] >= 0) {
            foreach ($data as $key => $val) {
                // Sniff for globals as !== explodes in < 5.4
                if ($key === 'GLOBALS' && is_array($val) && isset($val['GLOBALS'])) {
                    $val = '[recursion]';
                } elseif ($val !== $data) {
                    $val = static::getDebugInformation($val, $options);
                }
                $datas[] = $break . static::getDebugInformation($key) . ' => ' . $val;
            }
        } else {
            $datas[] = $break . '[maximum depth reached]';
        }

        return $debugInfo . implode(',', $datas) . $end . ']';
    }

    /**
     * @param object $data
     *
     * @return string
     */
    private static function getDebugInformationObject($data, array $options = [])
    {
        $options = array_merge([
            'depth'  => 25,
            'indent' => 0,
        ], $options);

        $debugInfo = '';
        $debugInfo .= 'object(' . get_class($data) . ') {';

        $break = "\n" . str_repeat("\t", $options['indent']);
        $end   = "\n" . str_repeat("\t", $options['indent'] - 1);

        if ($options['depth'] > 0 && method_exists($data, '__debugInfo')) {
            try {
                $debugArray = static::getDebugInformationArray($data->__debugInfo(), array_merge($options, [

Since getDebugInformationArray() is declared private, calling it with static will lead to errors in possible sub-classes. You can either use self, or increase the visibility of getDebugInformationArray() to at least protected.

                    'depth' => ($options['depth'] - 1),
                ]));
                $debugInfo  .= substr($debugArray, 1, -1);

                return $debugInfo . $end . '}';
            } catch (\Exception $e) {
                $message = $e->getMessage();

                return $debugInfo . "\n(unable to export object: $message)\n }";
            }
        }

        if ($options['depth'] > 0) {
            $props      = [];
            $objectVars = get_object_vars($data);
            foreach ($objectVars as $key => $value) {
                $value   = static::getDebugInformation($value, array_merge($options, [
                    'depth' => ($options['depth'] - 1),
                ]));
                $props[] = "$key => " . $value;
            }

            $ref     = new \ReflectionObject($data);
            $filters = [
                \ReflectionProperty::IS_PROTECTED => 'protected',
                \ReflectionProperty::IS_PRIVATE   => 'private',
            ];
            foreach ($filters as $filter => $visibility) {
                $reflectionProperties = $ref->getProperties($filter);
                foreach ($reflectionProperties as $reflectionProperty) {
                    $reflectionProperty->setAccessible(true);
                    $property = $reflectionProperty->getValue($data);

                    $value   = static::getDebugInformation($property, array_merge($options, [
                        'depth' => ($options['depth'] - 1),
                    ]));
                    $key     = $reflectionProperty->name;
                    $props[] = sprintf('[%s] %s => %s', $visibility, $key, $value);
                }
            }

            $debugInfo .= $break . implode($break, $props) . $end;
        }
        $debugInfo .= '}';

        return $debugInfo;
    }

    /**
     * @param resource $data
     *
     * @return string
     */
    private static function getDebugInformationResource($data)
    {
        return (string)$data . ' (' . get_resource_type($data) . ')';
    }
}