ErrorHandler::addTypeLinks() - Code Metrics - Inspection of "Fixes #13689: Fixed handling of errors in closures" - yiisoft/yii2 - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( db0e7a...679209 )

by Alexander

created 2017-04-26 00:34 UTC

ErrorHandler::addTypeLinks() C

↳ Parent: ErrorHandler

Complexity

Conditions	7
Paths	24

Size

Total Lines	30
Code Lines	19

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	56

Importance

Changes

Metric	Value
dl	0
loc	30
ccs	0
cts	18
cp	0
rs	6.7272
c	0
b	0
f	0
cc	7
eloc	19
nc	24
nop	1
crap	56

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

namespace yii\web;

use Yii;
use yii\base\Exception;
use yii\base\ErrorException;
use yii\base\UserException;
use yii\helpers\VarDumper;

/**
 * ErrorHandler handles uncaught PHP errors and exceptions.
 *
 * ErrorHandler displays these errors using appropriate views based on the
 * nature of the errors and the mode the application runs at.
 *
 * ErrorHandler is configured as an application component in [[\yii\base\Application]] by default.
 * You can access that instance via `Yii::$app->errorHandler`.
 *
 * For more details and usage information on ErrorHandler, see the [guide article on handling errors](guide:runtime-handling-errors).
 *
 * @author Qiang Xue <[email protected]>
 * @author Timur Ruziev <[email protected]>
 * @since 2.0
 */
class ErrorHandler extends \yii\base\ErrorHandler
{
    /**
     * @var int maximum number of source code lines to be displayed. Defaults to 19.
     */
    public $maxSourceLines = 19;
    /**
     * @var int maximum number of trace source code lines to be displayed. Defaults to 13.
     */
    public $maxTraceSourceLines = 13;
    /**
     * @var string the route (e.g. `site/error`) to the controller action that will be used
     * to display external errors. Inside the action, it can retrieve the error information
     * using `Yii::$app->errorHandler->exception`. This property defaults to null, meaning ErrorHandler
     * will handle the error display.
     */
    public $errorAction;
    /**
     * @var string the path of the view file for rendering exceptions without call stack information.
     */
    public $errorView = '@yii/views/errorHandler/error.php';
    /**
     * @var string the path of the view file for rendering exceptions.
     */
    public $exceptionView = '@yii/views/errorHandler/exception.php';
    /**
     * @var string the path of the view file for rendering exceptions and errors call stack element.
     */
    public $callStackItemView = '@yii/views/errorHandler/callStackItem.php';
    /**
     * @var string the path of the view file for rendering previous exceptions.
     */
    public $previousExceptionView = '@yii/views/errorHandler/previousException.php';
    /**
     * @var array list of the PHP predefined variables that should be displayed on the error page.
     * Note that a variable must be accessible via `$GLOBALS`. Otherwise it won't be displayed.
     * Defaults to `['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION']`.
     * @see renderRequest()
     * @since 2.0.7
     */
    public $displayVars = ['_GET', '_POST', '_FILES', '_COOKIE', '_SESSION'];


    /**
     * Renders the exception.
     * @param \Exception|\Error $exception the exception to be rendered.
     */
    protected function renderException($exception)
    {
        if (Yii::$app->has('response')) {
            $response = Yii::$app->getResponse();
            // reset parameters of response to avoid interference with partially created response data
            // in case the error occurred while sending the response.
            $response->isSent = false;
            $response->stream = null;
            $response->data = null;
            $response->content = null;
        } else {
            $response = new Response();
        }

        $response->setStatusCodeByException($exception);

        $useErrorView = $response->format === Response::FORMAT_HTML && (!YII_DEBUG || $exception instanceof UserException);

        if ($useErrorView && $this->errorAction !== null) {
            $result = Yii::$app->runAction($this->errorAction);
            if ($result instanceof Response) {
                $response = $result;
            } else {
                $response->data = $result;
            }
        } elseif ($response->format === Response::FORMAT_HTML) {
            if ($this->shouldRenderSimpleHtml()) {
                // AJAX request
                $response->data = '<pre>' . $this->htmlEncode(static::convertExceptionToString($exception)) . '</pre>';
            } else {
                // if there is an error during error rendering it's useful to
                // display PHP error in debug mode instead of a blank screen
                if (YII_DEBUG) {
                    ini_set('display_errors', 1);
                }
                $file = $useErrorView ? $this->errorView : $this->exceptionView;
                $response->data = $this->renderFile($file, [
                    'exception' => $exception,
                ]);
            }
        } elseif ($response->format === Response::FORMAT_RAW) {
            $response->data = static::convertExceptionToString($exception);
        } else {
            $response->data = $this->convertExceptionToArray($exception);
        }

        $response->send();
    }

    /**
     * Converts an exception into an array.
     * @param \Exception|\Error $exception the exception being converted
     * @return array the array representation of the exception.
     */
    protected function convertExceptionToArray($exception)
    {
        if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) {
            $exception = new HttpException(500, Yii::t('yii', 'An internal server error occurred.'));
        }

        $array = [
            'name' => ($exception instanceof Exception || $exception instanceof ErrorException) ? $exception->getName() : 'Exception',
            'message' => $exception->getMessage(),
            'code' => $exception->getCode(),
        ];
        if ($exception instanceof HttpException) {
            $array['status'] = $exception->statusCode;
        }
        if (YII_DEBUG) {
            $array['type'] = get_class($exception);
            if (!$exception instanceof UserException) {
                $array['file'] = $exception->getFile();
                $array['line'] = $exception->getLine();
                $array['stack-trace'] = explode("\n", $exception->getTraceAsString());
                if ($exception instanceof \yii\db\Exception) {
                    $array['error-info'] = $exception->errorInfo;
                }
            }
        }
        if (($prev = $exception->getPrevious()) !== null) {
            $array['previous'] = $this->convertExceptionToArray($prev);
        }

        return $array;
    }

    /**
     * Converts special characters to HTML entities.
     * @param string $text to encode.
     * @return string encoded original text.
     */
    public function htmlEncode($text)
    {
        return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
    }

    /**
     * Adds informational links to the given PHP type/class.
     * @param string $code type/class name to be linkified.
     * @return string linkified with HTML type/class name.
     */
    public function addTypeLinks($code)
    {
        if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) {
            $class = $matches[1];
            $method = $matches[2];
            $text = $this->htmlEncode($class) . '::' . $this->htmlEncode($method);
        } else {
            $class = $code;
            $method = null;
            $text = $this->htmlEncode($class);
        }

        $url = null;

        $shouldGenerateLink = true;
        if ($method !== null  && substr_compare($method, '{closure}', -9) !== 0) {
            $reflection = new \ReflectionMethod($class, $method);
            $shouldGenerateLink = $reflection->isPublic() || $reflection->isProtected();
        }

        if ($shouldGenerateLink) {
            $url = $this->getTypeUrl($class, $method);
        }

        if ($url === null) {
            return $text;
        }

        return '<a href="' . $url . '" target="_blank">' . $text . '</a>';
    }

    /**
     * Returns the informational link URL for a given PHP type/class.
     * @param string $class the type or class name.
     * @param string|null $method the method name.
     * @return string|null the informational link URL.
     * @see addTypeLinks()
     */
    protected function getTypeUrl($class, $method)
    {
        if (strpos($class, 'yii\\') !== 0) {
            return null;
        }

        $page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class)));
        $url = "http://www.yiiframework.com/doc-2.0/$page.html";
        if ($method) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $url .= "#$method()-detail";
        }

        return $url;
    }

    /**
     * Renders a view file as a PHP script.
     * @param string $_file_ the view file.
     * @param array $_params_ the parameters (name-value pairs) that will be extracted and made available in the view file.
     * @return string the rendering result
     */
    public function renderFile($_file_, $_params_)
    {
        $_params_['handler'] = $this;
        if ($this->exception instanceof ErrorException || !Yii::$app->has('view')) {
            ob_start();
            ob_implicit_flush(false);
            extract($_params_, EXTR_OVERWRITE);
            require(Yii::getAlias($_file_));

            return ob_get_clean();
        } else {
            return Yii::$app->getView()->renderFile($_file_, $_params_, $this);
        }
    }

    /**
     * Renders the previous exception stack for a given Exception.
     * @param \Exception $exception the exception whose precursors should be rendered.
     * @return string HTML content of the rendered previous exceptions.
     * Empty string if there are none.
     */
    public function renderPreviousExceptions($exception)
    {
        if (($previous = $exception->getPrevious()) !== null) {
            return $this->renderFile($this->previousExceptionView, ['exception' => $previous]);
        } else {
            return '';
        }
    }

    /**
     * Renders a single call stack element.
     * @param string|null $file name where call has happened.
     * @param int|null $line number on which call has happened.
     * @param string|null $class called class name.
     * @param string|null $method called function/method name.
     * @param array $args array of method arguments.
     * @param int $index number of the call stack element.
     * @return string HTML content of the rendered call stack element.
     */
    public function renderCallStackItem($file, $line, $class, $method, $args, $index)
    {
        $lines = [];
        $begin = $end = 0;
        if ($file !== null && $line !== null) {
            $line--; // adjust line number from one-based to zero-based
            $lines = @file($file);
            if ($line < 0 || $lines === false || ($lineCount = count($lines)) < $line) {
                return '';
            }

            $half = (int) (($index === 1 ? $this->maxSourceLines : $this->maxTraceSourceLines) / 2);
            $begin = $line - $half > 0 ? $line - $half : 0;
            $end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
        }

        return $this->renderFile($this->callStackItemView, [
            'file' => $file,
            'line' => $line,
            'class' => $class,
            'method' => $method,
            'index' => $index,
            'lines' => $lines,
            'begin' => $begin,
            'end' => $end,
            'args' => $args,
        ]);
    }

    /**
     * Renders call stack.
     * @param \Exception $exception exception to get call stack from
     * @return string HTML content of the rendered call stack.
     * @since 2.0.12
     */
    public function renderCallStack(\Exception $exception)
    {
        $out = '<ul>';
        $out .= $this->renderCallStackItem($exception->getFile(), $exception->getLine(), null, null, [], 1);
        for ($i = 0, $trace = $exception->getTrace(), $length = count($trace); $i < $length; ++$i) {
            $file = !empty($trace[$i]['file']) ? $trace[$i]['file'] : null;
            $line = !empty($trace[$i]['line']) ? $trace[$i]['line'] : null;
            $class = !empty($trace[$i]['class']) ? $trace[$i]['class'] : null;
            $function = null;
            if (!empty($trace[$i]['function']) && $trace[$i]['function'] !== 'unknown') {
                $function = $trace[$i]['function'];
            }
            $args = !empty($trace[$i]['args']) ? $trace[$i]['args'] : [];
            $out .= $this->renderCallStackItem($file, $line, $class, $function, $args, $i + 2);
        }
        $out .= '</ul>';
        return $out;
    }

    /**
     * Renders the global variables of the request.
     * List of global variables is defined in [[displayVars]].
     * @return string the rendering result
     * @see displayVars
     */
    public function renderRequest()
    {
        $request = '';
        foreach ($this->displayVars as $name) {
            if (!empty($GLOBALS[$name])) {
                $request .= '$' . $name . ' = ' . VarDumper::export($GLOBALS[$name]) . ";\n\n";
            }
        }

        return '<pre>' . $this->htmlEncode(rtrim($request, "\n")) . '</pre>';
    }

    /**
     * Determines whether given name of the file belongs to the framework.
     * @param string $file name to be checked.
     * @return bool whether given name of the file belongs to the framework.
     */
    public function isCoreFile($file)
    {
        return $file === null || strpos(realpath($file), YII2_PATH . DIRECTORY_SEPARATOR) === 0;
    }

    /**
     * Creates HTML containing link to the page with the information on given HTTP status code.
     * @param int $statusCode to be used to generate information link.
     * @param string $statusDescription Description to display after the the status code.
     * @return string generated HTML with HTTP status code information.
     */
    public function createHttpStatusLink($statusCode, $statusDescription)
    {
        return '<a href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#' . (int) $statusCode . '" target="_blank">HTTP ' . (int) $statusCode . ' &ndash; ' . $statusDescription . '</a>';
    }

    /**
     * Creates string containing HTML link which refers to the home page of determined web-server software
     * and its full name.
     * @return string server software information hyperlink.
     */
    public function createServerInformationLink()
    {
        $serverUrls = [
            'http://httpd.apache.org/' => ['apache'],
            'http://nginx.org/' => ['nginx'],
            'http://lighttpd.net/' => ['lighttpd'],
            'http://gwan.com/' => ['g-wan', 'gwan'],
            'http://iis.net/' => ['iis', 'services'],
            'http://php.net/manual/en/features.commandline.webserver.php' => ['development'],
        ];
        if (isset($_SERVER['SERVER_SOFTWARE'])) {
            foreach ($serverUrls as $url => $keywords) {
                foreach ($keywords as $keyword) {
                    if (stripos($_SERVER['SERVER_SOFTWARE'], $keyword) !== false) {
                        return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($_SERVER['SERVER_SOFTWARE']) . '</a>';
                    }
                }
            }
        }

        return '';
    }

    /**
     * Creates string containing HTML link which refers to the page with the current version
     * of the framework and version number text.
     * @return string framework version information hyperlink.
     */
    public function createFrameworkVersionLink()
    {
        return '<a href="http://github.com/yiisoft/yii2/" target="_blank">' . $this->htmlEncode(Yii::getVersion()) . '</a>';
    }

    /**
     * Converts arguments array to its string representation
     *
     * @param array $args arguments array to be converted
     * @return string string representation of the arguments array
     */
    public function argumentsToString($args)
    {
        $count = 0;
        $isAssoc = $args !== array_values($args);

        foreach ($args as $key => $value) {
            $count++;
            if ($count>=5) {
                if ($count>5) {
                    unset($args[$key]);
                } else {
                    $args[$key] = '...';
                }
                continue;
            }

            if (is_object($value)) {
                $args[$key] = '<span class="title">' . $this->htmlEncode(get_class($value)) . '</span>';
            } elseif (is_bool($value)) {
                $args[$key] = '<span class="keyword">' . ($value ? 'true' : 'false') . '</span>';
            } elseif (is_string($value)) {
                $fullValue = $this->htmlEncode($value);
                if (mb_strlen($value, 'UTF-8') > 32) {
                    $displayValue = $this->htmlEncode(mb_substr($value, 0, 32, 'UTF-8')) . '...';
                    $args[$key] = "<span class=\"string\" title=\"$fullValue\">'$displayValue'</span>";
                } else {
                    $args[$key] = "<span class=\"string\">'$fullValue'</span>";
                }
            } elseif (is_array($value)) {
                $args[$key] = '[' . $this->argumentsToString($value) . ']';
            } elseif ($value === null) {
                $args[$key] = '<span class="keyword">null</span>';
            } elseif (is_resource($value)) {
                $args[$key] = '<span class="keyword">resource</span>';
            } else {
                $args[$key] = '<span class="number">' . $value . '</span>';
            }

            if (is_string($key)) {
                $args[$key] = '<span class="string">\'' . $this->htmlEncode($key) . "'</span> => $args[$key]";
            } elseif ($isAssoc) {
                $args[$key] = "<span class=\"number\">$key</span> => $args[$key]";
            }
        }

        return implode(', ', $args);
    }

    /**
     * Returns human-readable exception name
     * @param \Exception $exception
     * @return string human-readable exception name or null if it cannot be determined
     */
    public function getExceptionName($exception)
    {
        if ($exception instanceof \yii\base\Exception || $exception instanceof \yii\base\InvalidCallException || $exception instanceof \yii\base\InvalidParamException || $exception instanceof \yii\base\UnknownMethodException) {
            return $exception->getName();
        }
        return null;
    }

    /**
     * @return bool if simple HTML should be rendered
     * @since 2.0.12
     */
    protected function shouldRenderSimpleHtml()
    {
        return YII_ENV_TEST || isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
    }
}


1		<?php
2		/**
3		* @link http://www.yiiframework.com/
4		* @copyright Copyright (c) 2008 Yii Software LLC
5		* @license http://www.yiiframework.com/license/
6		*/
7
8		namespace yii\web;
9
10		use Yii;
11		use yii\base\Exception;
12		use yii\base\ErrorException;
13		use yii\base\UserException;
14		use yii\helpers\VarDumper;
15
16		/**
17		* ErrorHandler handles uncaught PHP errors and exceptions.
18		*
19		* ErrorHandler displays these errors using appropriate views based on the
20		* nature of the errors and the mode the application runs at.
21		*
22		* ErrorHandler is configured as an application component in [[\yii\base\Application]] by default.
23		* You can access that instance via `Yii::$app->errorHandler`.
24		*
25		* For more details and usage information on ErrorHandler, see the [guide article on handling errors](guide:runtime-handling-errors).
26		*
27		* @author Qiang Xue <[email protected]>
28		* @author Timur Ruziev <[email protected]>
29		* @since 2.0
30		*/
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 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
74		/**
75		* Renders the exception.
76		* @param \Exception\|\Error $exception the exception to be rendered.
77		*/
78	1	protected function renderException($exception)
79		{
80	1	if (Yii::$app->has('response')) {
81	1	$response = Yii::$app->getResponse();
82		// reset parameters of response to avoid interference with partially created response data
83		// in case the error occurred while sending the response.
84	1	$response->isSent = false;
85	1	$response->stream = null;
86	1	$response->data = null;
87	1	$response->content = null;
88		} else {
89		$response = new Response();
90		}
91
92	1	$response->setStatusCodeByException($exception);
93
94	1	$useErrorView = $response->format === Response::FORMAT_HTML && (!YII_DEBUG \|\| $exception instanceof UserException);
95
96	1	if ($useErrorView && $this->errorAction !== null) {
97		$result = Yii::$app->runAction($this->errorAction);
98		if ($result instanceof Response) {
99		$response = $result;
100		} else {
101		$response->data = $result;
102		}
103	1	} elseif ($response->format === Response::FORMAT_HTML) {
104	1	if ($this->shouldRenderSimpleHtml()) {
105		// AJAX request
106		$response->data = '<pre>' . $this->htmlEncode(static::convertExceptionToString($exception)) . '</pre>';
107		} else {
108		// if there is an error during error rendering it's useful to
109		// display PHP error in debug mode instead of a blank screen
110	1	if (YII_DEBUG) {
111	1	ini_set('display_errors', 1);
112		}
113	1	$file = $useErrorView ? $this->errorView : $this->exceptionView;
114	1	$response->data = $this->renderFile($file, [
115	1	'exception' => $exception,
116		]);
117		}
118		} elseif ($response->format === Response::FORMAT_RAW) {
119		$response->data = static::convertExceptionToString($exception);
120		} else {
121		$response->data = $this->convertExceptionToArray($exception);
122		}
123
124	1	$response->send();
125	1	}
126
127		/**
128		* Converts an exception into an array.
129		* @param \Exception\|\Error $exception the exception being converted
130		* @return array the array representation of the exception.
131		*/
132		protected function convertExceptionToArray($exception)
133		{
134		if (!YII_DEBUG && !$exception instanceof UserException && !$exception instanceof HttpException) {
135		$exception = new HttpException(500, Yii::t('yii', 'An internal server error occurred.'));
136		}
137
138		$array = [
139		'name' => ($exception instanceof Exception \|\| $exception instanceof ErrorException) ? $exception->getName() : 'Exception',
140		'message' => $exception->getMessage(),
141		'code' => $exception->getCode(),
142		];
143		if ($exception instanceof HttpException) {
144		$array['status'] = $exception->statusCode;
145		}
146		if (YII_DEBUG) {
147		$array['type'] = get_class($exception);
148		if (!$exception instanceof UserException) {
149		$array['file'] = $exception->getFile();
150		$array['line'] = $exception->getLine();
151		$array['stack-trace'] = explode("\n", $exception->getTraceAsString());
152		if ($exception instanceof \yii\db\Exception) {
153		$array['error-info'] = $exception->errorInfo;
154		}
155		}
156		}
157		if (($prev = $exception->getPrevious()) !== null) {
158		$array['previous'] = $this->convertExceptionToArray($prev);
159		}
160
161		return $array;
162		}
163
164		/**
165		* Converts special characters to HTML entities.
166		* @param string $text to encode.
167		* @return string encoded original text.
168		*/
169	3	public function htmlEncode($text)
170		{
171	3	return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
172		}
173
174		/**
175		* Adds informational links to the given PHP type/class.
176		* @param string $code type/class name to be linkified.
177		* @return string linkified with HTML type/class name.
178		*/
179		public function addTypeLinks($code)
180		{
181		if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) {
182		$class = $matches[1];
183		$method = $matches[2];
184		$text = $this->htmlEncode($class) . '::' . $this->htmlEncode($method);
185		} else {
186		$class = $code;
187		$method = null;
188		$text = $this->htmlEncode($class);
189		}
190
191		$url = null;
192
193		$shouldGenerateLink = true;
194		if ($method !== null && substr_compare($method, '{closure}', -9) !== 0) {
195		$reflection = new \ReflectionMethod($class, $method);
196		$shouldGenerateLink = $reflection->isPublic() \|\| $reflection->isProtected();
197		}
198
199		if ($shouldGenerateLink) {
200		$url = $this->getTypeUrl($class, $method);
201		}
202
203		if ($url === null) {
204		return $text;
205		}
206
207		return '<a href="' . $url . '" target="_blank">' . $text . '</a>';
208		}
209
210		/**
211		* Returns the informational link URL for a given PHP type/class.
212		* @param string $class the type or class name.
213		* @param string\|null $method the method name.
214		* @return string\|null the informational link URL.
215		* @see addTypeLinks()
216		*/
217		protected function getTypeUrl($class, $method)
218		{
219		if (strpos($class, 'yii\\') !== 0) {
220		return null;
221		}
222
223		$page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class)));
224		$url = "http://www.yiiframework.com/doc-2.0/$page.html";
225		if ($method) {
		0 ignored issues – show Bug Best Practice introduced 2015-11-20 21:52 UTC by Report Bug Copy Issue Report The expression `$method` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
226		$url .= "#$method()-detail";
227		}
228
229		return $url;
230		}
231
232		/**
233		* Renders a view file as a PHP script.
234		* @param string $_file_ the view file.
235		* @param array $_params_ the parameters (name-value pairs) that will be extracted and made available in the view file.
236		* @return string the rendering result
237		*/
238	4	public function renderFile($_file_, $_params_)
239		{
240	4	$_params_['handler'] = $this;
241	4	if ($this->exception instanceof ErrorException \|\| !Yii::$app->has('view')) {
242		ob_start();
243		ob_implicit_flush(false);
244		extract($_params_, EXTR_OVERWRITE);
245		require(Yii::getAlias($_file_));
246
247		return ob_get_clean();
248		} else {
249	4	return Yii::$app->getView()->renderFile($_file_, $_params_, $this);
250		}
251		}
252
253		/**
254		* Renders the previous exception stack for a given Exception.
255		* @param \Exception $exception the exception whose precursors should be rendered.
256		* @return string HTML content of the rendered previous exceptions.
257		* Empty string if there are none.
258		*/
259		public function renderPreviousExceptions($exception)
260		{
261		if (($previous = $exception->getPrevious()) !== null) {
262		return $this->renderFile($this->previousExceptionView, ['exception' => $previous]);
263		} else {
264		return '';
265		}
266		}
267
268		/**
269		* Renders a single call stack element.
270		* @param string\|null $file name where call has happened.
271		* @param int\|null $line number on which call has happened.
272		* @param string\|null $class called class name.
273		* @param string\|null $method called function/method name.
274		* @param array $args array of method arguments.
275		* @param int $index number of the call stack element.
276		* @return string HTML content of the rendered call stack element.
277		*/
278		public function renderCallStackItem($file, $line, $class, $method, $args, $index)
279		{
280		$lines = [];
281		$begin = $end = 0;
282		if ($file !== null && $line !== null) {
283		$line--; // adjust line number from one-based to zero-based
284		$lines = @file($file);
285		if ($line < 0 \|\| $lines === false \|\| ($lineCount = count($lines)) < $line) {
286		return '';
287		}
288
289		$half = (int) (($index === 1 ? $this->maxSourceLines : $this->maxTraceSourceLines) / 2);
290		$begin = $line - $half > 0 ? $line - $half : 0;
291		$end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
292		}
293
294		return $this->renderFile($this->callStackItemView, [
295		'file' => $file,
296		'line' => $line,
297		'class' => $class,
298		'method' => $method,
299		'index' => $index,
300		'lines' => $lines,
301		'begin' => $begin,
302		'end' => $end,
303		'args' => $args,
304		]);
305		}
306
307		/**
308		* Renders call stack.
309		* @param \Exception $exception exception to get call stack from
310		* @return string HTML content of the rendered call stack.
311		* @since 2.0.12
312		*/
313		public function renderCallStack(\Exception $exception)
314		{
315		$out = '<ul>';
316		$out .= $this->renderCallStackItem($exception->getFile(), $exception->getLine(), null, null, [], 1);
317		for ($i = 0, $trace = $exception->getTrace(), $length = count($trace); $i < $length; ++$i) {
318		$file = !empty($trace[$i]['file']) ? $trace[$i]['file'] : null;
319		$line = !empty($trace[$i]['line']) ? $trace[$i]['line'] : null;
320		$class = !empty($trace[$i]['class']) ? $trace[$i]['class'] : null;
321		$function = null;
322		if (!empty($trace[$i]['function']) && $trace[$i]['function'] !== 'unknown') {
323		$function = $trace[$i]['function'];
324		}
325		$args = !empty($trace[$i]['args']) ? $trace[$i]['args'] : [];
326		$out .= $this->renderCallStackItem($file, $line, $class, $function, $args, $i + 2);
327		}
328		$out .= '</ul>';
329		return $out;
330		}
331
332		/**
333		* Renders the global variables of the request.
334		* List of global variables is defined in [[displayVars]].
335		* @return string the rendering result
336		* @see displayVars
337		*/
338		public function renderRequest()
339		{
340		$request = '';
341		foreach ($this->displayVars as $name) {
342		if (!empty($GLOBALS[$name])) {
343		$request .= '$' . $name . ' = ' . VarDumper::export($GLOBALS[$name]) . ";\n\n";
344		}
345		}
346
347		return '<pre>' . $this->htmlEncode(rtrim($request, "\n")) . '</pre>';
348		}
349
350		/**
351		* Determines whether given name of the file belongs to the framework.
352		* @param string $file name to be checked.
353		* @return bool whether given name of the file belongs to the framework.
354		*/
355		public function isCoreFile($file)
356		{
357		return $file === null \|\| strpos(realpath($file), YII2_PATH . DIRECTORY_SEPARATOR) === 0;
358		}
359
360		/**
361		* Creates HTML containing link to the page with the information on given HTTP status code.
362		* @param int $statusCode to be used to generate information link.
363		* @param string $statusDescription Description to display after the the status code.
364		* @return string generated HTML with HTTP status code information.
365		*/
366		public function createHttpStatusLink($statusCode, $statusDescription)
367		{
368		return '<a href="http://en.wikipedia.org/wiki/List_of_HTTP_status_codes#' . (int) $statusCode . '" target="_blank">HTTP ' . (int) $statusCode . ' – ' . $statusDescription . '</a>';
369		}
370
371		/**
372		* Creates string containing HTML link which refers to the home page of determined web-server software
373		* and its full name.
374		* @return string server software information hyperlink.
375		*/
376		public function createServerInformationLink()
377		{
378		$serverUrls = [
379		'http://httpd.apache.org/' => ['apache'],
380		'http://nginx.org/' => ['nginx'],
381		'http://lighttpd.net/' => ['lighttpd'],
382		'http://gwan.com/' => ['g-wan', 'gwan'],
383		'http://iis.net/' => ['iis', 'services'],
384		'http://php.net/manual/en/features.commandline.webserver.php' => ['development'],
385		];
386		if (isset($_SERVER['SERVER_SOFTWARE'])) {
387		foreach ($serverUrls as $url => $keywords) {
388		foreach ($keywords as $keyword) {
389		if (stripos($_SERVER['SERVER_SOFTWARE'], $keyword) !== false) {
390		return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($_SERVER['SERVER_SOFTWARE']) . '</a>';
391		}
392		}
393		}
394		}
395
396		return '';
397		}
398
399		/**
400		* Creates string containing HTML link which refers to the page with the current version
401		* of the framework and version number text.
402		* @return string framework version information hyperlink.
403		*/
404		public function createFrameworkVersionLink()
405		{
406		return '<a href="http://github.com/yiisoft/yii2/" target="_blank">' . $this->htmlEncode(Yii::getVersion()) . '</a>';
407		}
408
409		/**
410		* Converts arguments array to its string representation
411		*
412		* @param array $args arguments array to be converted
413		* @return string string representation of the arguments array
414		*/
415		public function argumentsToString($args)
416		{
417		$count = 0;
418		$isAssoc = $args !== array_values($args);
419
420		foreach ($args as $key => $value) {
421		$count++;
422		if ($count>=5) {
423		if ($count>5) {
424		unset($args[$key]);
425		} else {
426		$args[$key] = '...';
427		}
428		continue;
429		}
430
431		if (is_object($value)) {
432		$args[$key] = '<span class="title">' . $this->htmlEncode(get_class($value)) . '</span>';
433		} elseif (is_bool($value)) {
434		$args[$key] = '<span class="keyword">' . ($value ? 'true' : 'false') . '</span>';
435		} elseif (is_string($value)) {
436		$fullValue = $this->htmlEncode($value);
437		if (mb_strlen($value, 'UTF-8') > 32) {
438		$displayValue = $this->htmlEncode(mb_substr($value, 0, 32, 'UTF-8')) . '...';
439		$args[$key] = "<span class=\"string\" title=\"$fullValue\">'$displayValue'</span>";
440		} else {
441		$args[$key] = "<span class=\"string\">'$fullValue'</span>";
442		}
443		} elseif (is_array($value)) {
444		$args[$key] = '[' . $this->argumentsToString($value) . ']';
445		} elseif ($value === null) {
446		$args[$key] = '<span class="keyword">null</span>';
447		} elseif (is_resource($value)) {
448		$args[$key] = '<span class="keyword">resource</span>';
449		} else {
450		$args[$key] = '<span class="number">' . $value . '</span>';
451		}
452
453		if (is_string($key)) {
454		$args[$key] = '<span class="string">\'' . $this->htmlEncode($key) . "'</span> => $args[$key]";
455		} elseif ($isAssoc) {
456		$args[$key] = "<span class=\"number\">$key</span> => $args[$key]";
457		}
458		}
459
460		return implode(', ', $args);
461		}
462
463		/**
464		* Returns human-readable exception name
465		* @param \Exception $exception
466		* @return string human-readable exception name or null if it cannot be determined
467		*/
468	3	public function getExceptionName($exception)
469		{
470	3	if ($exception instanceof \yii\base\Exception \|\| $exception instanceof \yii\base\InvalidCallException \|\| $exception instanceof \yii\base\InvalidParamException \|\| $exception instanceof \yii\base\UnknownMethodException) {
471	3	return $exception->getName();
472		}
473		return null;
474		}
475
476		/**
477		* @return bool if simple HTML should be rendered
478		* @since 2.0.12
479		*/
480		protected function shouldRenderSimpleHtml()
481		{
482		return YII_ENV_TEST \|\| isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest';
483		}
484		}
485

yiisoft / yii2

Push — master ( db0e7a...679209 )

ErrorHandler::addTypeLinks() C

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like