ErrorHandler::isCoreFile() - Code Metrics - Inspection of "PHPDocs updated. Closes #12927" - rob006/yii2-dev - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 2ab419...940f7c )

by Robert

created 2016-11-06 14:20 UTC

ErrorHandler::isCoreFile() A

↳ Parent: ErrorHandler

Complexity

Conditions	2
Paths	2

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
ccs	0
cts	4
cp	0
cc	2
eloc	2
nc	2
nop	1
crap	6

<?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 integer maximum number of source code lines to be displayed. Defaults to 19.
     */
    public $maxSourceLines = 19;
    /**
     * @var integer 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 $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();
        }

        $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 (YII_ENV_TEST || isset($_SERVER['HTTP_X_REQUESTED_WITH']) && $_SERVER['HTTP_X_REQUESTED_WITH'] === 'XMLHttpRequest') {
                // 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);
        }

        if ($exception instanceof HttpException) {
            $response->setStatusCode($exception->statusCode);
        } else {
            $response->setStatusCode(500);
        }

        $response->send();
    }

    /**
     * Converts an exception into an array.
     * @param \Exception $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) {
            $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 integer|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 integer $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 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>' . rtrim($request, "\n") . '</pre>';
    }

    /**
     * Determines whether given name of the file belongs to the framework.
     * @param string $file name to be checked.
     * @return boolean 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 integer $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;
    }
}


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

rob006 / yii2-dev

GitHub Access Token became invalid

Push — master ( 2ab419...940f7c )

ErrorHandler::isCoreFile() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like