yiisoft /
yii2
| Total Complexity | 90 |
| Total Lines | 473 |
| Duplicated Lines | 0 % |
| Coverage | 39.09% |
| Changes | 0 | ||
Complex classes like ErrorHandler often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use ErrorHandler, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 31 | class ErrorHandler extends \yii\base\ErrorHandler |
||
| 32 | { |
||
| 33 | /** |
||
| 34 | * @var int maximum number of source code lines to be displayed. Defaults to 19. |
||
| 35 | */ |
||
| 36 | public $maxSourceLines = 19; |
||
| 37 | /** |
||
| 38 | * @var int maximum number of trace source code lines to be displayed. Defaults to 13. |
||
| 39 | */ |
||
| 40 | public $maxTraceSourceLines = 13; |
||
| 41 | /** |
||
| 42 | * @var string|null the route (e.g. `site/error`) to the controller action that will be used |
||
| 43 | * to display external errors. Inside the action, it can retrieve the error information |
||
| 44 | * using `Yii::$app->errorHandler->exception`. This property defaults to null, meaning ErrorHandler |
||
| 45 | * will handle the error display. |
||
| 46 | */ |
||
| 47 | public $errorAction; |
||
| 48 | /** |
||
| 49 | * @var string the path of the view file for rendering exceptions without call stack information. |
||
| 50 | */ |
||
| 51 | public $errorView = '@yii/views/errorHandler/error.php'; |
||
| 52 | /** |
||
| 53 | * @var string the path of the view file for rendering exceptions. |
||
| 54 | */ |
||
| 55 | public $exceptionView = '@yii/views/errorHandler/exception.php'; |
||
| 56 | /** |
||
| 57 | * @var string the path of the view file for rendering exceptions and errors call stack element. |
||
| 58 | */ |
||
| 59 | public $callStackItemView = '@yii/views/errorHandler/callStackItem.php'; |
||
| 60 | /** |
||
| 61 | * @var string the path of the view file for rendering previous exceptions. |
||
| 62 | */ |
||
| 63 | public $previousExceptionView = '@yii/views/errorHandler/previousException.php'; |
||
| 64 | /** |
||
| 65 | * @var array list of the PHP predefined variables that should be displayed on the error page. |
||
| 66 | * Note that a variable must be accessible via `$GLOBALS`. Otherwise it won't be displayed. |
||
| 67 | * Defaults to `['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']`. |
||
| 68 | * @see renderRequest() |
||
| 69 | * @since 2.0.7 |
||
| 70 | */ |
||
| 71 | public $displayVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']; |
||
| 72 | /** |
||
| 73 | * @var string trace line with placeholders to be be substituted. |
||
| 74 | * The placeholders are {file}, {line} and {text} and the string should be as follows. |
||
| 75 | * |
||
| 76 | * `File: {file} - Line: {line} - Text: {text}` |
||
| 77 | * |
||
| 78 | * @example <a href="ide://open?file={file}&line={line}">{html}</a> |
||
| 79 | * @see https://github.com/yiisoft/yii2-debug#open-files-in-ide |
||
| 80 | * @since 2.0.14 |
||
| 81 | */ |
||
| 82 | public $traceLine = '{html}'; |
||
| 83 | |||
| 84 | |||
| 85 | /** |
||
| 86 | * Renders the exception. |
||
| 87 | * @param \Throwable $exception the exception to be rendered. |
||
| 88 | */ |
||
| 89 | 5 | protected function renderException($exception) |
|
| 90 | { |
||
| 91 | 5 | if (Yii::$app->has('response')) { |
|
| 92 | 5 | $response = Yii::$app->getResponse(); |
|
| 93 | // reset parameters of response to avoid interference with partially created response data |
||
| 94 | // in case the error occurred while sending the response. |
||
| 95 | 5 | $response->isSent = false; |
|
|
Bug
Best Practice
introduced
by
|
|||
| 96 | 5 | $response->stream = null; |
|
| 97 | 5 | $response->data = null; |
|
| 98 | 5 | $response->content = null; |
|
| 99 | } else { |
||
| 100 | $response = new Response(); |
||
| 101 | } |
||
| 102 | |||
| 103 | 5 | $response->setStatusCodeByException($exception); |
|
| 104 | |||
| 105 | 5 | $useErrorView = $response->format === Response::FORMAT_HTML && (!YII_DEBUG || $exception instanceof UserException); |
|
| 106 | |||
| 107 | 5 | if ($useErrorView && $this->errorAction !== null) { |
|
| 108 | 1 | Yii::$app->view->clear(); |
|
| 109 | 1 | $result = Yii::$app->runAction($this->errorAction); |
|
| 110 | 1 | if ($result instanceof Response) { |
|
| 111 | $response = $result; |
||
| 112 | } else { |
||
| 113 | 1 | $response->data = $result; |
|
| 114 | } |
||
| 115 | 4 | } elseif ($response->format === Response::FORMAT_HTML) { |
|
| 116 | 2 | if ($this->shouldRenderSimpleHtml()) { |
|
| 117 | // AJAX request |
||
| 118 | $response->data = '<pre>' . $this->htmlEncode(static::convertExceptionToString($exception)) . '</pre>'; |
||
| 119 | } else { |
||
| 120 | // if there is an error during error rendering it's useful to |
||
| 121 | // display PHP error in debug mode instead of a blank screen |
||
| 122 | 2 | if (YII_DEBUG) { |
|
| 123 | 2 | ini_set('display_errors', 1); |
|
| 124 | } |
||
| 125 | 2 | $file = $useErrorView ? $this->errorView : $this->exceptionView; |
|
| 126 | 2 | $response->data = $this->renderFile($file, [ |
|
| 127 | 2 | 'exception' => $exception, |
|
| 128 | 2 | ]); |
|
| 129 | } |
||
| 130 | 2 | } elseif ($response->format === Response::FORMAT_RAW) { |
|
| 131 | 1 | $response->data = static::convertExceptionToString($exception); |
|
| 132 | } else { |
||
| 133 | 1 | $response->data = $this->convertExceptionToArray($exception); |
|
| 134 | } |
||
| 135 | |||
| 136 | 5 | $response->send(); |
|
| 137 | } |
||
| 138 | |||
| 139 | /** |
||
| 140 | * Converts an exception into an array. |
||
| 141 | * @param \Throwable $exception the exception being converted |
||
| 142 | * @return array the array representation of the exception. |
||
| 143 | */ |
||
| 144 | 1 | protected function convertExceptionToArray($exception) |
|
| 145 | { |
||
| 146 | 1 | if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) { |
|
| 147 | $exception = new HttpException(500, Yii::t('yii', 'An internal server error occurred.')); |
||
| 148 | } |
||
| 149 | |||
| 150 | 1 | $array = [ |
|
| 151 | 1 | 'name' => ($exception instanceof Exception || $exception instanceof ErrorException) ? $exception->getName() : 'Exception', |
|
| 152 | 1 | 'message' => $exception->getMessage(), |
|
| 153 | 1 | 'code' => $exception->getCode(), |
|
| 154 | 1 | ]; |
|
| 155 | 1 | if ($exception instanceof HttpException) { |
|
| 156 | $array['status'] = $exception->statusCode; |
||
| 157 | } |
||
| 158 | 1 | if (YII_DEBUG) { |
|
| 159 | 1 | $array['type'] = get_class($exception); |
|
| 160 | 1 | if (!$exception instanceof UserException) { |
|
| 161 | 1 | $array['file'] = $exception->getFile(); |
|
| 162 | 1 | $array['line'] = $exception->getLine(); |
|
| 163 | 1 | $array['stack-trace'] = explode("\n", $exception->getTraceAsString()); |
|
| 164 | 1 | if ($exception instanceof \yii\db\Exception) { |
|
| 165 | $array['error-info'] = $exception->errorInfo; |
||
| 166 | } |
||
| 167 | } |
||
| 168 | } |
||
| 169 | 1 | if (($prev = $exception->getPrevious()) !== null) { |
|
| 170 | $array['previous'] = $this->convertExceptionToArray($prev); |
||
| 171 | } |
||
| 172 | |||
| 173 | 1 | return $array; |
|
| 174 | } |
||
| 175 | |||
| 176 | /** |
||
| 177 | * Converts special characters to HTML entities. |
||
| 178 | * @param string $text to encode. |
||
| 179 | * @return string encoded original text. |
||
| 180 | */ |
||
| 181 | 11 | public function htmlEncode($text) |
|
| 182 | { |
||
| 183 | 11 | return htmlspecialchars($text, ENT_QUOTES | ENT_SUBSTITUTE | ENT_HTML5, 'UTF-8'); |
|
| 184 | } |
||
| 185 | |||
| 186 | /** |
||
| 187 | * Adds informational links to the given PHP type/class. |
||
| 188 | * @param string $code type/class name to be linkified. |
||
| 189 | * @return string linkified with HTML type/class name. |
||
| 190 | */ |
||
| 191 | public function addTypeLinks($code) |
||
| 192 | { |
||
| 193 | if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) { |
||
| 194 | $class = $matches[1]; |
||
| 195 | $method = $matches[2]; |
||
| 196 | $text = $this->htmlEncode($class) . '::' . $this->htmlEncode($method); |
||
| 197 | } else { |
||
| 198 | $class = $code; |
||
| 199 | $method = null; |
||
| 200 | $text = $this->htmlEncode($class); |
||
| 201 | } |
||
| 202 | |||
| 203 | $url = null; |
||
| 204 | |||
| 205 | $shouldGenerateLink = true; |
||
| 206 | if ($method !== null && strpos($method, '{closure') === false) { |
||
| 207 | $reflection = new \ReflectionClass($class); |
||
| 208 | if ($reflection->hasMethod($method)) { |
||
| 209 | $reflectionMethod = $reflection->getMethod($method); |
||
| 210 | $shouldGenerateLink = $reflectionMethod->isPublic() || $reflectionMethod->isProtected(); |
||
| 211 | } else { |
||
| 212 | $shouldGenerateLink = false; |
||
| 213 | } |
||
| 214 | } |
||
| 215 | |||
| 216 | if ($shouldGenerateLink) { |
||
| 217 | $url = $this->getTypeUrl($class, $method); |
||
| 218 | } |
||
| 219 | |||
| 220 | if ($url === null) { |
||
| 221 | return $text; |
||
| 222 | } |
||
| 223 | |||
| 224 | return '<a href="' . $url . '" target="_blank">' . $text . '</a>'; |
||
| 225 | } |
||
| 226 | |||
| 227 | /** |
||
| 228 | * Returns the informational link URL for a given PHP type/class. |
||
| 229 | * @param string $class the type or class name. |
||
| 230 | * @param string|null $method the method name. |
||
| 231 | * @return string|null the informational link URL. |
||
| 232 | * @see addTypeLinks() |
||
| 233 | */ |
||
| 234 | protected function getTypeUrl($class, $method) |
||
| 235 | { |
||
| 236 | if (strncmp($class, 'yii\\', 4) !== 0) { |
||
| 237 | return null; |
||
| 238 | } |
||
| 239 | |||
| 240 | $page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class))); |
||
| 241 | $url = "https://www.yiiframework.com/doc-2.0/$page.html"; |
||
| 242 | if ($method) { |
||
| 243 | $url .= "#$method()-detail"; |
||
| 244 | } |
||
| 245 | |||
| 246 | return $url; |
||
| 247 | } |
||
| 248 | |||
| 249 | /** |
||
| 250 | * Renders a view file as a PHP script. |
||
| 251 | * @param string $_file_ the view file. |
||
| 252 | * @param array $_params_ the parameters (name-value pairs) that will be extracted and made available in the view file. |
||
| 253 | * @return string the rendering result |
||
| 254 | */ |
||
| 255 | 6 | public function renderFile($_file_, $_params_) |
|
| 256 | { |
||
| 257 | 6 | $_params_['handler'] = $this; |
|
| 258 | 6 | if ($this->exception instanceof ErrorException || !Yii::$app->has('view')) { |
|
| 259 | ob_start(); |
||
| 260 | ob_implicit_flush(false); |
||
| 261 | extract($_params_, EXTR_OVERWRITE); |
||
| 262 | require Yii::getAlias($_file_); |
||
| 263 | |||
| 264 | return ob_get_clean(); |
||
| 265 | } |
||
| 266 | |||
| 267 | 6 | $view = Yii::$app->getView(); |
|
| 268 | 6 | $view->clear(); |
|
| 269 | |||
| 270 | 6 | return $view->renderFile($_file_, $_params_, $this); |
|
| 271 | } |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Renders the previous exception stack for a given Exception. |
||
| 275 | * @param \Throwable $exception the exception whose precursors should be rendered. |
||
| 276 | * @return string HTML content of the rendered previous exceptions. |
||
| 277 | * Empty string if there are none. |
||
| 278 | */ |
||
| 279 | public function renderPreviousExceptions($exception) |
||
| 280 | { |
||
| 281 | if (($previous = $exception->getPrevious()) !== null) { |
||
| 282 | return $this->renderFile($this->previousExceptionView, ['exception' => $previous]); |
||
| 283 | } |
||
| 284 | |||
| 285 | return ''; |
||
| 286 | } |
||
| 287 | |||
| 288 | /** |
||
| 289 | * Renders a single call stack element. |
||
| 290 | * @param string|null $file name where call has happened. |
||
| 291 | * @param int|null $line number on which call has happened. |
||
| 292 | * @param string|null $class called class name. |
||
| 293 | * @param string|null $method called function/method name. |
||
| 294 | * @param array $args array of method arguments. |
||
| 295 | * @param int $index number of the call stack element. |
||
| 296 | * @return string HTML content of the rendered call stack element. |
||
| 297 | */ |
||
| 298 | 1 | public function renderCallStackItem($file, $line, $class, $method, $args, $index) |
|
| 299 | { |
||
| 300 | 1 | $lines = []; |
|
| 301 | 1 | $begin = $end = 0; |
|
| 302 | 1 | if ($file !== null && $line !== null) { |
|
| 303 | 1 | $line--; // adjust line number from one-based to zero-based |
|
| 304 | 1 | $lines = @file($file); |
|
| 305 | 1 | if ($line < 0 || $lines === false || ($lineCount = count($lines)) < $line) { |
|
| 306 | return ''; |
||
| 307 | } |
||
| 308 | |||
| 309 | 1 | $half = (int) (($index === 1 ? $this->maxSourceLines : $this->maxTraceSourceLines) / 2); |
|
| 310 | 1 | $begin = $line - $half > 0 ? $line - $half : 0; |
|
| 311 | 1 | $end = $line + $half < $lineCount ? $line + $half : $lineCount - 1; |
|
| 312 | } |
||
| 313 | |||
| 314 | 1 | return $this->renderFile($this->callStackItemView, [ |
|
| 315 | 1 | 'file' => $file, |
|
| 316 | 1 | 'line' => $line, |
|
| 317 | 1 | 'class' => $class, |
|
| 318 | 1 | 'method' => $method, |
|
| 319 | 1 | 'index' => $index, |
|
| 320 | 1 | 'lines' => $lines, |
|
| 321 | 1 | 'begin' => $begin, |
|
| 322 | 1 | 'end' => $end, |
|
| 323 | 1 | 'args' => $args, |
|
| 324 | 1 | ]); |
|
| 325 | } |
||
| 326 | |||
| 327 | /** |
||
| 328 | * Renders call stack. |
||
| 329 | * @param \Throwable $exception exception to get call stack from |
||
| 330 | * @return string HTML content of the rendered call stack. |
||
| 331 | * @since 2.0.12 |
||
| 332 | */ |
||
| 333 | public function renderCallStack($exception) |
||
| 350 | } |
||
| 351 | |||
| 352 | /** |
||
| 353 | * Renders the global variables of the request. |
||
| 354 | * List of global variables is defined in [[displayVars]]. |
||
| 355 | * @return string the rendering result |
||
| 356 | * @see displayVars |
||
| 357 | */ |
||
| 358 | public function renderRequest() |
||
| 368 | } |
||
| 369 | |||
| 370 | /** |
||
| 371 | * Determines whether given name of the file belongs to the framework. |
||
| 372 | * @param string $file name to be checked. |
||
| 373 | * @return bool whether given name of the file belongs to the framework. |
||
| 374 | */ |
||
| 375 | 1 | public function isCoreFile($file) |
|
| 378 | } |
||
| 379 | |||
| 380 | /** |
||
| 381 | * Creates HTML containing link to the page with the information on given HTTP status code. |
||
| 382 | * @param int $statusCode to be used to generate information link. |
||
| 383 | * @param string $statusDescription Description to display after the the status code. |
||
| 384 | * @return string generated HTML with HTTP status code information. |
||
| 385 | */ |
||
| 386 | public function createHttpStatusLink($statusCode, $statusDescription) |
||
| 387 | { |
||
| 388 | return '<a href="https://en.wikipedia.org/wiki/List_of_HTTP_status_codes#' . (int) $statusCode . '" target="_blank">HTTP ' . (int) $statusCode . ' – ' . $statusDescription . '</a>'; |
||
| 389 | } |
||
| 390 | |||
| 391 | /** |
||
| 392 | * Creates string containing HTML link which refers to the home page of determined web-server software |
||
| 393 | * and its full name. |
||
| 394 | * @return string server software information hyperlink. |
||
| 395 | */ |
||
| 396 | public function createServerInformationLink() |
||
| 397 | { |
||
| 398 | $serverUrls = [ |
||
| 399 | 'https://httpd.apache.org/' => ['apache'], |
||
| 400 | 'https://nginx.org/' => ['nginx'], |
||
| 401 | 'https://www.lighttpd.net/' => ['lighttpd'], |
||
| 402 | 'http://gwan.com/' => ['g-wan', 'gwan'], |
||
| 403 | 'https://www.iis.net/' => ['iis', 'services'], |
||
| 404 | 'https://www.php.net/manual/en/features.commandline.webserver.php' => ['development'], |
||
| 405 | ]; |
||
| 406 | if (isset($_SERVER['SERVER_SOFTWARE'])) { |
||
| 407 | foreach ($serverUrls as $url => $keywords) { |
||
| 408 | foreach ($keywords as $keyword) { |
||
| 409 | if (stripos($_SERVER['SERVER_SOFTWARE'], $keyword) !== false) { |
||
| 410 | return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($_SERVER['SERVER_SOFTWARE']) . '</a>'; |
||
| 411 | } |
||
| 412 | } |
||
| 413 | } |
||
| 414 | } |
||
| 415 | |||
| 416 | return ''; |
||
| 417 | } |
||
| 418 | |||
| 419 | /** |
||
| 420 | * Creates string containing HTML link which refers to the page with the current version |
||
| 421 | * of the framework and version number text. |
||
| 422 | * @return string framework version information hyperlink. |
||
| 423 | */ |
||
| 424 | public function createFrameworkVersionLink() |
||
| 427 | } |
||
| 428 | |||
| 429 | /** |
||
| 430 | * Converts arguments array to its string representation. |
||
| 431 | * |
||
| 432 | * @param array $args arguments array to be converted |
||
| 433 | * @return string string representation of the arguments array |
||
| 434 | */ |
||
| 435 | public function argumentsToString($args) |
||
| 481 | } |
||
| 482 | |||
| 483 | /** |
||
| 484 | * Returns human-readable exception name. |
||
| 485 | * @param \Throwable $exception |
||
| 486 | * @return string|null human-readable exception name or null if it cannot be determined |
||
| 487 | */ |
||
| 488 | 3 | public function getExceptionName($exception) |
|
| 489 | { |
||
| 490 | 3 | if ($exception instanceof \yii\base\Exception || $exception instanceof \yii\base\InvalidCallException || $exception instanceof \yii\base\InvalidParamException || $exception instanceof \yii\base\UnknownMethodException) { |
|
| 491 | 3 | return $exception->getName(); |
|
| 492 | } |
||
| 493 | |||
| 494 | return null; |
||
| 495 | } |
||
| 496 | |||
| 497 | /** |
||
| 498 | * @return bool if simple HTML should be rendered |
||
| 499 | * @since 2.0.12 |
||
| 500 | */ |
||
| 501 | protected function shouldRenderSimpleHtml() |
||
| 504 | } |
||
| 505 | } |
||
| 506 |
Loading history...
