FlattenException::flattenArgs() - Code Metrics - Inspection of "Update dev dependencies, pipelines and README.md...." - yiisoft/yii-debug - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( a996f8...998e87 )

by Wilmer

created 2020-11-18 18:16 UTC

FlattenException::flattenArgs() C

↳ Parent: FlattenException

Complexity

Conditions	12
Paths	12

Size

Total Lines	34
Code Lines	26

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	20
CRAP Score	13.152

Importance

Changes

Metric	Value
cc	12
eloc	26
nc	12
nop	3
dl	0
loc	34
ccs	20
cts	25
cp	0.8
crap	13.152
rs	6.9666
c	0
b	0
f	0

How to fix Complexity

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Debug;

/**
 * FlattenException wraps a PHP Exception to be able to serialize it.
 * Implements the Throwable interface
 * Basically, this class removes all objects from the trace.
 * Ported from Symfony components @link https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Debug/Exception/FlattenException.php
 */
class FlattenException
{
    /**
     * @var string
     */
    protected string $message;
    /**
     * @var mixed|int
     */
    protected $code;
    /**
     * @var string
     */
    protected string $file;
    /**
     * @var int
     */
    protected int $line;

    /**
     * @var FlattenException|null
     */
    private ?FlattenException $_previous;
    /**
     * @var array
     */
    private array $_trace;
    /**
     * @var string
     */
    private string $_toString;
    /**
     * @var string
     */
    private string $_class;

    /**
     * FlattenException constructor.
     * @param \Throwable $exception
     */
    public function __construct(\Throwable $exception)
    {
        $this->setMessage($exception->getMessage());
        $this->setCode($exception->getCode());
        $this->setFile($exception->getFile());
        $this->setLine($exception->getLine());
        $this->setTrace($exception->getTrace());
        $this->setToString($exception->__toString());
        $this->setClass(get_class($exception));

        $previous = $exception->getPrevious();
        if ($previous instanceof \Exception) {
            $this->setPrevious(new self($previous));
        }
    }

    /**
     * Gets the Exception message
     * @return string the Exception message as a string.
     */
    public function getMessage(): string
    {
        return $this->message;
    }

    /**
     * Gets the Exception code
     * @return mixed|int the exception code as integer.
     */
    public function getCode()
    {
        return $this->code;
    }

    /**
     * Gets the file in which the exception occurred
     * @return string the filename in which the exception was created.
     */
    public function getFile(): string
    {
        return $this->file;
    }

    /**
     * Gets the line in which the exception occurred
     * @return int the line number where the exception was created.
     */
    public function getLine(): int
    {
        return $this->line;
    }

    /**
     * Gets the stack trace
     * @return array the Exception stack trace as an array.
     */
    public function getTrace(): array
    {
        return $this->_trace;
    }

    /**
     * Returns previous Exception
     * @return FlattenException|null the previous `FlattenException` if available or null otherwise.
     */
    public function getPrevious(): ?FlattenException
    {
        return $this->_previous;
    }

    /**
     * Gets the stack trace as a string
     * @return string the Exception stack trace as a string.
     */
    public function getTraceAsString(): string
    {
        $remove = "Stack trace:\n";
        $len = strpos($this->_toString, $remove);
        if ($len === false) {
            return '';
        }
        return substr($this->_toString, $len + strlen($remove));
    }

    /**
     * String representation of the exception
     * @return string the string representation of the exception.
     */
    public function __toString()
    {
        return $this->_toString;
    }

    /**
     * @return string the name of the class in which the exception was created.
     */
    public function getClass(): string
    {
        return $this->_class;
    }

    /**
     * @param string $message the Exception message as a string.
     */
    protected function setMessage($message): void
    {
        $this->message = $message;
    }

    /**
     * @param mixed|int $code the exception code as integer.
     */
    protected function setCode($code): void
    {
        $this->code = $code;
    }

    /**
     * @param string $file the filename in which the exception was created.
     */
    protected function setFile($file): void
    {
        $this->file = $file;
    }

    /**
     * @param int $line the line number where the exception was created.
     */
    protected function setLine($line): void
    {
        $this->line = $line;
    }

    /**
     * @param array $trace the Exception stack trace as an array.
     */
    protected function setTrace($trace): void
    {
        $this->_trace = [];
        foreach ($trace as $entry) {
            $class = '';
            $namespace = '';
            if (isset($entry['class'])) {
                $parts = explode('\\', $entry['class']);
                $class = array_pop($parts);
                $namespace = implode('\\', $parts);
            }

            $this->_trace[] = [
                'namespace' => $namespace,
                'short_class' => $class,
                'class' => isset($entry['class']) ? $entry['class'] : '',
                'type' => isset($entry['type']) ? $entry['type'] : '',
                'function' => isset($entry['function']) ? $entry['function'] : null,
                'file' => isset($entry['file']) ? $entry['file'] : null,
                'line' => isset($entry['line']) ? $entry['line'] : null,
                'args' => isset($entry['args']) ? $this->flattenArgs($entry['args']) : [],
            ];
        }
    }

    /**
     * @param string $string the string representation of the thrown object.
     */
    protected function setToString($string): void
    {
        $this->_toString = $string;
    }

    /**
     * @param FlattenException $previous previous Exception.
     */
    protected function setPrevious(FlattenException $previous): void
    {
        $this->_previous = $previous;
    }

    /**
     * @param string $class the name of the class in which the exception was created.
     */
    protected function setClass($class): void
    {
        $this->_class = $class;
    }

    /**
     * Allows you to sterilize the Exception trace arguments
     * @param array $args
     * @param int $level recursion level
     * @param int $count number of records counter
     * @return array arguments tracing.
     */
    private function flattenArgs($args, $level = 0, &$count = 0): array
    {
        $result = [];
        foreach ($args as $key => $value) {
            if (++$count > 10000) {
                return ['array', '*SKIPPED over 10000 entries*'];
            }
            if ($value instanceof \__PHP_Incomplete_Class) {
                // is_object() returns false on PHP<=7.1
                $result[$key] = ['incomplete-object', $this->getClassNameFromIncomplete($value)];
            } elseif (is_object($value)) {
                $result[$key] = ['object', get_class($value)];
            } elseif (is_array($value)) {
                if ($level > 10) {
                    $result[$key] = ['array', '*DEEP NESTED ARRAY*'];
                } else {
                    $result[$key] = ['array', $this->flattenArgs($value, $level + 1, $count)];
                }
            } elseif (null === $value) {
                $result[$key] = ['null', null];
            } elseif (is_bool($value)) {
                $result[$key] = ['boolean', $value];
            } elseif (is_int($value)) {
                $result[$key] = ['integer', $value];
            } elseif (is_float($value)) {
                $result[$key] = ['float', $value];
            } elseif (is_resource($value)) {
                $result[$key] = ['resource', get_resource_type($value)];
            } else {
                $result[$key] = ['string', (string)$value];
            }
        }

        return $result;
    }

    /**
     * @param \__PHP_Incomplete_Class $value
     * @return string the real class name of an incomplete class
     */
    private function getClassNameFromIncomplete(\__PHP_Incomplete_Class $value): string
    {
        $array = new \ArrayObject($value);

        return $array['__PHP_Incomplete_Class_Name'];
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Debug;
6
7		/**
8		* FlattenException wraps a PHP Exception to be able to serialize it.
9		* Implements the Throwable interface
10		* Basically, this class removes all objects from the trace.
11		* Ported from Symfony components @link https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Debug/Exception/FlattenException.php
12		*/
13		class FlattenException
14		{
15		/**
16		* @var string
17		*/
18		protected string $message;
19		/**
20		* @var mixed\|int
21		*/
22		protected $code;
23		/**
24		* @var string
25		*/
26		protected string $file;
27		/**
28		* @var int
29		*/
30		protected int $line;
31
32		/**
33		* @var FlattenException\|null
34		*/
35		private ?FlattenException $_previous;
36		/**
37		* @var array
38		*/
39		private array $_trace;
40		/**
41		* @var string
42		*/
43		private string $_toString;
44		/**
45		* @var string
46		*/
47		private string $_class;
48
49		/**
50		* FlattenException constructor.
51		* @param \Throwable $exception
52		*/
53	10	public function __construct(\Throwable $exception)
54		{
55	10	$this->setMessage($exception->getMessage());
56	10	$this->setCode($exception->getCode());
57	10	$this->setFile($exception->getFile());
58	10	$this->setLine($exception->getLine());
59	10	$this->setTrace($exception->getTrace());
60	10	$this->setToString($exception->__toString());
61	10	$this->setClass(get_class($exception));
62
63	10	$previous = $exception->getPrevious();
64	10	if ($previous instanceof \Exception) {
65	1	$this->setPrevious(new self($previous));
66		}
67	10	}
68
69		/**
70		* Gets the Exception message
71		* @return string the Exception message as a string.
72		*/
73	1	public function getMessage(): string
74		{
75	1	return $this->message;
76		}
77
78		/**
79		* Gets the Exception code
80		* @return mixed\|int the exception code as integer.
81		*/
82	1	public function getCode()
83		{
84	1	return $this->code;
85		}
86
87		/**
88		* Gets the file in which the exception occurred
89		* @return string the filename in which the exception was created.
90		*/
91	1	public function getFile(): string
92		{
93	1	return $this->file;
94		}
95
96		/**
97		* Gets the line in which the exception occurred
98		* @return int the line number where the exception was created.
99		*/
100	1	public function getLine(): int
101		{
102	1	return $this->line;
103		}
104
105		/**
106		* Gets the stack trace
107		* @return array the Exception stack trace as an array.
108		*/
109	2	public function getTrace(): array
110		{
111	2	return $this->_trace;
112		}
113
114		/**
115		* Returns previous Exception
116		* @return FlattenException\|null the previous `FlattenException` if available or null otherwise.
117		*/
118	1	public function getPrevious(): ?FlattenException
119		{
120	1	return $this->_previous;
121		}
122
123		/**
124		* Gets the stack trace as a string
125		* @return string the Exception stack trace as a string.
126		*/
127	1	public function getTraceAsString(): string
128		{
129	1	$remove = "Stack trace:\n";
130	1	$len = strpos($this->_toString, $remove);
131	1	if ($len === false) {
132		return '';
133		}
134	1	return substr($this->_toString, $len + strlen($remove));
135		}
136
137		/**
138		* String representation of the exception
139		* @return string the string representation of the exception.
140		*/
141	1	public function __toString()
142		{
143	1	return $this->_toString;
144		}
145
146		/**
147		* @return string the name of the class in which the exception was created.
148		*/
149	1	public function getClass(): string
150		{
151	1	return $this->_class;
152		}
153
154		/**
155		* @param string $message the Exception message as a string.
156		*/
157	10	protected function setMessage($message): void
158		{
159	10	$this->message = $message;
160	10	}
161
162		/**
163		* @param mixed\|int $code the exception code as integer.
164		*/
165	10	protected function setCode($code): void
166		{
167	10	$this->code = $code;
168	10	}
169
170		/**
171		* @param string $file the filename in which the exception was created.
172		*/
173	10	protected function setFile($file): void
174		{
175	10	$this->file = $file;
176	10	}
177
178		/**
179		* @param int $line the line number where the exception was created.
180		*/
181	10	protected function setLine($line): void
182		{
183	10	$this->line = $line;
184	10	}
185
186		/**
187		* @param array $trace the Exception stack trace as an array.
188		*/
189	10	protected function setTrace($trace): void
190		{
191	10	$this->_trace = [];
192	10	foreach ($trace as $entry) {
193	10	$class = '';
194	10	$namespace = '';
195	10	if (isset($entry['class'])) {
196	10	$parts = explode('\\', $entry['class']);
197	10	$class = array_pop($parts);
198	10	$namespace = implode('\\', $parts);
199		}
200
201	10	$this->_trace[] = [
202	10	'namespace' => $namespace,
203	10	'short_class' => $class,
204	10	'class' => isset($entry['class']) ? $entry['class'] : '',
205	10	'type' => isset($entry['type']) ? $entry['type'] : '',
206	10	'function' => isset($entry['function']) ? $entry['function'] : null,
207	10	'file' => isset($entry['file']) ? $entry['file'] : null,
208	10	'line' => isset($entry['line']) ? $entry['line'] : null,
209	10	'args' => isset($entry['args']) ? $this->flattenArgs($entry['args']) : [],
210		];
211		}
212	10	}
213
214		/**
215		* @param string $string the string representation of the thrown object.
216		*/
217	10	protected function setToString($string): void
218		{
219	10	$this->_toString = $string;
220	10	}
221
222		/**
223		* @param FlattenException $previous previous Exception.
224		*/
225	1	protected function setPrevious(FlattenException $previous): void
226		{
227	1	$this->_previous = $previous;
228	1	}
229
230		/**
231		* @param string $class the name of the class in which the exception was created.
232		*/
233	10	protected function setClass($class): void
234		{
235	10	$this->_class = $class;
236	10	}
237
238		/**
239		* Allows you to sterilize the Exception trace arguments
240		* @param array $args
241		* @param int $level recursion level
242		* @param int $count number of records counter
243		* @return array arguments tracing.
244		*/
245	10	private function flattenArgs($args, $level = 0, &$count = 0): array
246		{
247	10	$result = [];
248	10	foreach ($args as $key => $value) {
249	10	if (++$count > 10000) {
250		return ['array', 'SKIPPED over 10000 entries'];
251		}
252	10	if ($value instanceof \__PHP_Incomplete_Class) {
253		// is_object() returns false on PHP<=7.1
254		$result[$key] = ['incomplete-object', $this->getClassNameFromIncomplete($value)];
255	10	} elseif (is_object($value)) {
256	10	$result[$key] = ['object', get_class($value)];
257	10	} elseif (is_array($value)) {
258	10	if ($level > 10) {
259		$result[$key] = ['array', 'DEEP NESTED ARRAY'];
260		} else {
261	10	$result[$key] = ['array', $this->flattenArgs($value, $level + 1, $count)];
262		}
263	10	} elseif (null === $value) {
264	10	$result[$key] = ['null', null];
265	10	} elseif (is_bool($value)) {
266	10	$result[$key] = ['boolean', $value];
267	10	} elseif (is_int($value)) {
268	10	$result[$key] = ['integer', $value];
269	10	} elseif (is_float($value)) {
270		$result[$key] = ['float', $value];
271	10	} elseif (is_resource($value)) {
272		$result[$key] = ['resource', get_resource_type($value)];
273		} else {
274	10	$result[$key] = ['string', (string)$value];
275		}
276		}
277
278	10	return $result;
279		}
280
281		/**
282		* @param \__PHP_Incomplete_Class $value
283		* @return string the real class name of an incomplete class
284		*/
285		private function getClassNameFromIncomplete(\__PHP_Incomplete_Class $value): string
286		{
287		$array = new \ArrayObject($value);
288
289		return $array['__PHP_Incomplete_Class_Name'];
290		}
291		}
292

yiisoft / yii-debug

Push — master ( a996f8...998e87 )

FlattenException::flattenArgs() C

Complexity

Size

Duplication

Code Coverage

Importance

How to fix Complexity

Long Method

Duplication Side-by-Side

Filter issues like