Dumper::dump() - Code Metrics - evolution-cms/evolution - Measure and Improve Code Quality continuously with Scrutinizer

Dumper::dump() A
last analyzed 2018-11-09 17:26 UTC

↳ Parent: Dumper

Complexity

Conditions	3
Paths	8

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	3
nc	8
nop	2
dl	0
loc	23
rs	9.552
c	0
b	0
f	0

<?php

namespace Doctrine\DBAL\Tools;

use ArrayIterator;
use ArrayObject;
use DateTimeInterface;
use Doctrine\Common\Collections\Collection;
use Doctrine\Common\Persistence\Proxy;
use stdClass;
use function array_keys;
use function class_exists;
use function count;
use function end;
use function explode;
use function extension_loaded;
use function get_class;
use function html_entity_decode;
use function ini_get;
use function ini_set;
use function is_array;
use function is_object;
use function ob_get_clean;
use function ob_start;
use function strip_tags;
use function strrpos;
use function substr;
use function var_dump;

/**
 * Static class used to dump the variable to be used on output.
 * Simplified port of Util\Debug from doctrine/common.
 *
 * @internal
 */
final class Dumper
{
    /**
     * Private constructor (prevents instantiation).
     */
    private function __construct()
    {
    }

    /**
     * Returns a dump of the public, protected and private properties of $var.
     *
     * @link https://xdebug.org/
     *
     * @param mixed $var      The variable to dump.
     * @param int   $maxDepth The maximum nesting level for object properties.
     */
    public static function dump($var, int $maxDepth = 2) : string
    {
        $html = ini_get('html_errors');

        if ($html !== true) {
            ini_set('html_errors', true);
        }

        if (extension_loaded('xdebug')) {
            ini_set('xdebug.var_display_max_depth', $maxDepth);
        }

        $var = self::export($var, $maxDepth);

        ob_start();
        var_dump($var);


        try {
            return strip_tags(html_entity_decode(ob_get_clean()));
        } finally {
            ini_set('html_errors', $html);
        }
    }

    /**
     * @param mixed $var
     *
     * @return mixed

     */
    public static function export($var, int $maxDepth)
    {
        $return = null;
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
        $isObj  = is_object($var);

        if ($var instanceof Collection) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $var = $var->toArray();
        }

        if ($maxDepth === 0) {
            return is_object($var) ? get_class($var)
                : (is_array($var) ? 'Array(' . count($var) . ')' : $var);
        }

        if (is_array($var)) {
            $return = [];

            foreach ($var as $k => $v) {
                $return[$k] = self::export($v, $maxDepth - 1);
            }

            return $return;
        }

        if (! $isObj) {
            return $var;
        }

        $return = new stdClass();
        if ($var instanceof DateTimeInterface) {
            $return->__CLASS__ = get_class($var);
            $return->date      = $var->format('c');
            $return->timezone  = $var->getTimezone()->getName();

            return $return;
        }

        $return->__CLASS__ = self::getClass($var);

        if ($var instanceof Proxy) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            $return->__IS_PROXY__          = true;
            $return->__PROXY_INITIALIZED__ = $var->__isInitialized();
        }

        if ($var instanceof ArrayObject || $var instanceof ArrayIterator) {
            $return->__STORAGE__ = self::export($var->getArrayCopy(), $maxDepth - 1);
        }

        return self::fillReturnWithClassAttributes($var, $return, $maxDepth);
    }

    /**
     * Fill the $return variable with class attributes
     * Based on obj2array function from {@see https://secure.php.net/manual/en/function.get-object-vars.php#47075}
     *
     * @param object $var
     *
     * @return mixed

     */
    private static function fillReturnWithClassAttributes($var, stdClass $return, int $maxDepth)
    {
        $clone = (array) $var;

        foreach (array_keys($clone) as $key) {
            $aux  = explode("\0", $key);
            $name = end($aux);
            if ($aux[0] === '') {
                $name .= ':' . ($aux[1] === '*' ? 'protected' : $aux[1] . ':private');
            }
            $return->$name = self::export($clone[$key], $maxDepth - 1);
        }

        return $return;
    }

    /**
     * @param object $object
     */
    private static function getClass($object) : string
    {
        $class = get_class($object);

        if (! class_exists(Proxy::class)) {
            return $class;
        }

        $pos = strrpos($class, '\\' . Proxy::MARKER . '\\');

        if ($pos === false) {
            return $class;
        }

        return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
    }
}


1			<?php
2
3			namespace Doctrine\DBAL\Tools;
4
5			use ArrayIterator;
6			use ArrayObject;
7			use DateTimeInterface;
8			use Doctrine\Common\Collections\Collection;
9			use Doctrine\Common\Persistence\Proxy;
10			use stdClass;
11			use function array_keys;
12			use function class_exists;
13			use function count;
14			use function end;
15			use function explode;
16			use function extension_loaded;
17			use function get_class;
18			use function html_entity_decode;
19			use function ini_get;
20			use function ini_set;
21			use function is_array;
22			use function is_object;
23			use function ob_get_clean;
24			use function ob_start;
25			use function strip_tags;
26			use function strrpos;
27			use function substr;
28			use function var_dump;
29
30			/**
31			* Static class used to dump the variable to be used on output.
32			* Simplified port of Util\Debug from doctrine/common.
33			*
34			* @internal
35			*/
36			final class Dumper
37			{
38			/**
39			* Private constructor (prevents instantiation).
40			*/
41			private function __construct()
42			{
43			}
44
45			/**
46			* Returns a dump of the public, protected and private properties of $var.
47			*
48			* @link https://xdebug.org/
49			*
50			* @param mixed $var The variable to dump.
51			* @param int $maxDepth The maximum nesting level for object properties.
52			*/
53			public static function dump($var, int $maxDepth = 2) : string
54			{
55			$html = ini_get('html_errors');
56
57			if ($html !== true) {
58			ini_set('html_errors', true);
59			}
60
61			if (extension_loaded('xdebug')) {
62			ini_set('xdebug.var_display_max_depth', $maxDepth);
63			}
64
65			$var = self::export($var, $maxDepth);
66
67			ob_start();
68			var_dump($var);
			0 ignored issues – show Security Debugging Code introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report `\var_dump($var);` looks like debug code. Are you sure you do not want to remove it? This might expose sensitive data. Loading history...
69
70			try {
71			return strip_tags(html_entity_decode(ob_get_clean()));
72			} finally {
73			ini_set('html_errors', $html);
74			}
75			}
76
77			/**
78			* @param mixed $var
79			*
80			* @return mixed
			0 ignored issues – show Documentation introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `integer\|double\|string\|nu...n\|resource\|array\|object`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
81			*/
82			public static function export($var, int $maxDepth)
83			{
84			$return = null;
			0 ignored issues – show Unused Code introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report `$return` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
85			$isObj = is_object($var);
86
87			if ($var instanceof Collection) {
			0 ignored issues – show Bug introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report The class `Doctrine\Common\Collections\Collection` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
88			$var = $var->toArray();
89			}
90
91			if ($maxDepth === 0) {
92			return is_object($var) ? get_class($var)
93			: (is_array($var) ? 'Array(' . count($var) . ')' : $var);
94			}
95
96			if (is_array($var)) {
97			$return = [];
98
99			foreach ($var as $k => $v) {
100			$return[$k] = self::export($v, $maxDepth - 1);
101			}
102
103			return $return;
104			}
105
106			if (! $isObj) {
107			return $var;
108			}
109
110			$return = new stdClass();
111			if ($var instanceof DateTimeInterface) {
112			$return->__CLASS__ = get_class($var);
113			$return->date = $var->format('c');
114			$return->timezone = $var->getTimezone()->getName();
115
116			return $return;
117			}
118
119			$return->__CLASS__ = self::getClass($var);
120
121			if ($var instanceof Proxy) {
			0 ignored issues – show Bug introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report The class `Doctrine\Common\Persistence\Proxy` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
122			$return->__IS_PROXY__ = true;
123			$return->__PROXY_INITIALIZED__ = $var->__isInitialized();
124			}
125
126			if ($var instanceof ArrayObject \|\| $var instanceof ArrayIterator) {
127			$return->__STORAGE__ = self::export($var->getArrayCopy(), $maxDepth - 1);
128			}
129
130			return self::fillReturnWithClassAttributes($var, $return, $maxDepth);
131			}
132
133			/**
134			* Fill the $return variable with class attributes
135			* Based on obj2array function from {@see https://secure.php.net/manual/en/function.get-object-vars.php#47075}
136			*
137			* @param object $var
138			*
139			* @return mixed
			0 ignored issues – show Documentation introduced 2018-11-09 14:25 UTC by Report Bug Copy Issue Report Consider making the return type a bit more specific; maybe use `stdClass`. This check looks for the generic type `array` as a return type and suggests a more specific type. This type is inferred from the actual code. Loading history...
140			*/
141			private static function fillReturnWithClassAttributes($var, stdClass $return, int $maxDepth)
142			{
143			$clone = (array) $var;
144
145			foreach (array_keys($clone) as $key) {
146			$aux = explode("\0", $key);
147			$name = end($aux);
148			if ($aux[0] === '') {
149			$name .= ':' . ($aux[1] === '*' ? 'protected' : $aux[1] . ':private');
150			}
151			$return->$name = self::export($clone[$key], $maxDepth - 1);
152			}
153
154			return $return;
155			}
156
157			/**
158			* @param object $object
159			*/
160			private static function getClass($object) : string
161			{
162			$class = get_class($object);
163
164			if (! class_exists(Proxy::class)) {
165			return $class;
166			}
167
168			$pos = strrpos($class, '\\' . Proxy::MARKER . '\\');
169
170			if ($pos === false) {
171			return $class;
172			}
173
174			return substr($class, $pos + Proxy::MARKER_LENGTH + 2);
175			}
176			}
177

evolution-cms / evolution

Dumper::dump() A last analyzed 2018-11-09 17:26 UTC

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like

Dumper::dump() A
last analyzed 2018-11-09 17:26 UTC