annotate vendor/symfony/debug/Exception/FlattenException.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 /*
Chris@0 4 * This file is part of the Symfony package.
Chris@0 5 *
Chris@0 6 * (c) Fabien Potencier <fabien@symfony.com>
Chris@0 7 *
Chris@0 8 * For the full copyright and license information, please view the LICENSE
Chris@0 9 * file that was distributed with this source code.
Chris@0 10 */
Chris@0 11
Chris@0 12 namespace Symfony\Component\Debug\Exception;
Chris@0 13
Chris@12 14 use Symfony\Component\HttpFoundation\Exception\RequestExceptionInterface;
Chris@0 15 use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
Chris@0 16
Chris@0 17 /**
Chris@0 18 * FlattenException wraps a PHP Exception to be able to serialize it.
Chris@0 19 *
Chris@0 20 * Basically, this class removes all objects from the trace.
Chris@0 21 *
Chris@0 22 * @author Fabien Potencier <fabien@symfony.com>
Chris@0 23 */
Chris@0 24 class FlattenException
Chris@0 25 {
Chris@0 26 private $message;
Chris@0 27 private $code;
Chris@0 28 private $previous;
Chris@0 29 private $trace;
Chris@0 30 private $class;
Chris@0 31 private $statusCode;
Chris@0 32 private $headers;
Chris@0 33 private $file;
Chris@0 34 private $line;
Chris@0 35
Chris@17 36 public static function create(\Exception $exception, $statusCode = null, array $headers = [])
Chris@0 37 {
Chris@0 38 $e = new static();
Chris@0 39 $e->setMessage($exception->getMessage());
Chris@0 40 $e->setCode($exception->getCode());
Chris@0 41
Chris@0 42 if ($exception instanceof HttpExceptionInterface) {
Chris@0 43 $statusCode = $exception->getStatusCode();
Chris@0 44 $headers = array_merge($headers, $exception->getHeaders());
Chris@12 45 } elseif ($exception instanceof RequestExceptionInterface) {
Chris@12 46 $statusCode = 400;
Chris@0 47 }
Chris@0 48
Chris@0 49 if (null === $statusCode) {
Chris@0 50 $statusCode = 500;
Chris@0 51 }
Chris@0 52
Chris@0 53 $e->setStatusCode($statusCode);
Chris@0 54 $e->setHeaders($headers);
Chris@0 55 $e->setTraceFromException($exception);
Chris@17 56 $e->setClass(\get_class($exception));
Chris@0 57 $e->setFile($exception->getFile());
Chris@0 58 $e->setLine($exception->getLine());
Chris@0 59
Chris@0 60 $previous = $exception->getPrevious();
Chris@0 61
Chris@0 62 if ($previous instanceof \Exception) {
Chris@0 63 $e->setPrevious(static::create($previous));
Chris@0 64 } elseif ($previous instanceof \Throwable) {
Chris@0 65 $e->setPrevious(static::create(new FatalThrowableError($previous)));
Chris@0 66 }
Chris@0 67
Chris@0 68 return $e;
Chris@0 69 }
Chris@0 70
Chris@0 71 public function toArray()
Chris@0 72 {
Chris@17 73 $exceptions = [];
Chris@17 74 foreach (array_merge([$this], $this->getAllPrevious()) as $exception) {
Chris@17 75 $exceptions[] = [
Chris@0 76 'message' => $exception->getMessage(),
Chris@0 77 'class' => $exception->getClass(),
Chris@0 78 'trace' => $exception->getTrace(),
Chris@17 79 ];
Chris@0 80 }
Chris@0 81
Chris@0 82 return $exceptions;
Chris@0 83 }
Chris@0 84
Chris@0 85 public function getStatusCode()
Chris@0 86 {
Chris@0 87 return $this->statusCode;
Chris@0 88 }
Chris@0 89
Chris@0 90 public function setStatusCode($code)
Chris@0 91 {
Chris@0 92 $this->statusCode = $code;
Chris@0 93 }
Chris@0 94
Chris@0 95 public function getHeaders()
Chris@0 96 {
Chris@0 97 return $this->headers;
Chris@0 98 }
Chris@0 99
Chris@0 100 public function setHeaders(array $headers)
Chris@0 101 {
Chris@0 102 $this->headers = $headers;
Chris@0 103 }
Chris@0 104
Chris@0 105 public function getClass()
Chris@0 106 {
Chris@0 107 return $this->class;
Chris@0 108 }
Chris@0 109
Chris@0 110 public function setClass($class)
Chris@0 111 {
Chris@0 112 $this->class = $class;
Chris@0 113 }
Chris@0 114
Chris@0 115 public function getFile()
Chris@0 116 {
Chris@0 117 return $this->file;
Chris@0 118 }
Chris@0 119
Chris@0 120 public function setFile($file)
Chris@0 121 {
Chris@0 122 $this->file = $file;
Chris@0 123 }
Chris@0 124
Chris@0 125 public function getLine()
Chris@0 126 {
Chris@0 127 return $this->line;
Chris@0 128 }
Chris@0 129
Chris@0 130 public function setLine($line)
Chris@0 131 {
Chris@0 132 $this->line = $line;
Chris@0 133 }
Chris@0 134
Chris@0 135 public function getMessage()
Chris@0 136 {
Chris@0 137 return $this->message;
Chris@0 138 }
Chris@0 139
Chris@0 140 public function setMessage($message)
Chris@0 141 {
Chris@0 142 $this->message = $message;
Chris@0 143 }
Chris@0 144
Chris@0 145 public function getCode()
Chris@0 146 {
Chris@0 147 return $this->code;
Chris@0 148 }
Chris@0 149
Chris@0 150 public function setCode($code)
Chris@0 151 {
Chris@0 152 $this->code = $code;
Chris@0 153 }
Chris@0 154
Chris@0 155 public function getPrevious()
Chris@0 156 {
Chris@0 157 return $this->previous;
Chris@0 158 }
Chris@0 159
Chris@16 160 public function setPrevious(self $previous)
Chris@0 161 {
Chris@0 162 $this->previous = $previous;
Chris@0 163 }
Chris@0 164
Chris@0 165 public function getAllPrevious()
Chris@0 166 {
Chris@17 167 $exceptions = [];
Chris@0 168 $e = $this;
Chris@0 169 while ($e = $e->getPrevious()) {
Chris@0 170 $exceptions[] = $e;
Chris@0 171 }
Chris@0 172
Chris@0 173 return $exceptions;
Chris@0 174 }
Chris@0 175
Chris@0 176 public function getTrace()
Chris@0 177 {
Chris@0 178 return $this->trace;
Chris@0 179 }
Chris@0 180
Chris@0 181 public function setTraceFromException(\Exception $exception)
Chris@0 182 {
Chris@0 183 $this->setTrace($exception->getTrace(), $exception->getFile(), $exception->getLine());
Chris@0 184 }
Chris@0 185
Chris@0 186 public function setTrace($trace, $file, $line)
Chris@0 187 {
Chris@17 188 $this->trace = [];
Chris@17 189 $this->trace[] = [
Chris@0 190 'namespace' => '',
Chris@0 191 'short_class' => '',
Chris@0 192 'class' => '',
Chris@0 193 'type' => '',
Chris@0 194 'function' => '',
Chris@0 195 'file' => $file,
Chris@0 196 'line' => $line,
Chris@17 197 'args' => [],
Chris@17 198 ];
Chris@0 199 foreach ($trace as $entry) {
Chris@0 200 $class = '';
Chris@0 201 $namespace = '';
Chris@0 202 if (isset($entry['class'])) {
Chris@0 203 $parts = explode('\\', $entry['class']);
Chris@0 204 $class = array_pop($parts);
Chris@0 205 $namespace = implode('\\', $parts);
Chris@0 206 }
Chris@0 207
Chris@17 208 $this->trace[] = [
Chris@0 209 'namespace' => $namespace,
Chris@0 210 'short_class' => $class,
Chris@0 211 'class' => isset($entry['class']) ? $entry['class'] : '',
Chris@0 212 'type' => isset($entry['type']) ? $entry['type'] : '',
Chris@0 213 'function' => isset($entry['function']) ? $entry['function'] : null,
Chris@0 214 'file' => isset($entry['file']) ? $entry['file'] : null,
Chris@0 215 'line' => isset($entry['line']) ? $entry['line'] : null,
Chris@17 216 'args' => isset($entry['args']) ? $this->flattenArgs($entry['args']) : [],
Chris@17 217 ];
Chris@0 218 }
Chris@0 219 }
Chris@0 220
Chris@0 221 private function flattenArgs($args, $level = 0, &$count = 0)
Chris@0 222 {
Chris@17 223 $result = [];
Chris@0 224 foreach ($args as $key => $value) {
Chris@0 225 if (++$count > 1e4) {
Chris@17 226 return ['array', '*SKIPPED over 10000 entries*'];
Chris@0 227 }
Chris@0 228 if ($value instanceof \__PHP_Incomplete_Class) {
Chris@0 229 // is_object() returns false on PHP<=7.1
Chris@17 230 $result[$key] = ['incomplete-object', $this->getClassNameFromIncomplete($value)];
Chris@17 231 } elseif (\is_object($value)) {
Chris@17 232 $result[$key] = ['object', \get_class($value)];
Chris@17 233 } elseif (\is_array($value)) {
Chris@0 234 if ($level > 10) {
Chris@17 235 $result[$key] = ['array', '*DEEP NESTED ARRAY*'];
Chris@0 236 } else {
Chris@17 237 $result[$key] = ['array', $this->flattenArgs($value, $level + 1, $count)];
Chris@0 238 }
Chris@0 239 } elseif (null === $value) {
Chris@17 240 $result[$key] = ['null', null];
Chris@17 241 } elseif (\is_bool($value)) {
Chris@17 242 $result[$key] = ['boolean', $value];
Chris@17 243 } elseif (\is_int($value)) {
Chris@17 244 $result[$key] = ['integer', $value];
Chris@17 245 } elseif (\is_float($value)) {
Chris@17 246 $result[$key] = ['float', $value];
Chris@17 247 } elseif (\is_resource($value)) {
Chris@17 248 $result[$key] = ['resource', get_resource_type($value)];
Chris@0 249 } else {
Chris@17 250 $result[$key] = ['string', (string) $value];
Chris@0 251 }
Chris@0 252 }
Chris@0 253
Chris@0 254 return $result;
Chris@0 255 }
Chris@0 256
Chris@0 257 private function getClassNameFromIncomplete(\__PHP_Incomplete_Class $value)
Chris@0 258 {
Chris@0 259 $array = new \ArrayObject($value);
Chris@0 260
Chris@0 261 return $array['__PHP_Incomplete_Class_Name'];
Chris@0 262 }
Chris@0 263 }