HtmlRenderer::__construct() - Code Metrics - Inspection of "Error handler fixes (#303)" - yiisoft/yii-web - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 8508e9...885421 )

by Alexander

created 2020-08-17 09:37 UTC

HtmlRenderer::__construct() A

↳ Parent: HtmlRenderer

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

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

<?php

declare(strict_types=1);

namespace Yiisoft\Yii\Web\ErrorHandler;

use Alexkart\CurlBuilder\Command;
use Yiisoft\Yii\Web\Info;

final class HtmlRenderer extends ThrowableRenderer
{
    private int $maxSourceLines = 19;
    private int $maxTraceLines = 13;

    private string $traceLine = '{html}';

    private string $defaultTemplatePath;

    private string $errorTemplate;
    private string $exceptionTemplate;

    public function __construct(array $templates = [])
    {
        $this->defaultTemplatePath = $templates['path'];
        $this->errorTemplate = $templates['error'] ?? $this->defaultTemplatePath . '/error.php';
        $this->exceptionTemplate = $templates['exception'] ?? $this->defaultTemplatePath . '/exception.php';
    }

    public function withMaxSourceLines(int $maxSourceLines): self
    {
        $new = clone $this;
        $new->maxSourceLines = $maxSourceLines;
        return $new;
    }

    public function withMaxTraceLines(int $maxTraceLines): self
    {
        $new = clone $this;
        $new->maxTraceLines = $maxTraceLines;
        return $new;
    }

    public function withTraceLine(string $traceLine): self
    {
        $new = clone $this;
        $new->traceLine = $traceLine;
        return $new;
    }

    public function render(\Throwable $t): string
    {
        return $this->renderTemplate($this->errorTemplate, [
            'throwable' => $t,
        ]);
    }

    public function renderVerbose(\Throwable $t): string
    {
        return $this->renderTemplate($this->exceptionTemplate, [
            'throwable' => $t,
        ]);
    }

    private function htmlEncode(string $text): string
    {
        return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
    }

    private function renderTemplate(string $path, array $params): string
    {
        if (!file_exists($path)) {
            throw new \RuntimeException("Template not found at $path");
        }

        $renderer = function (): void {
            extract(func_get_arg(1), EXTR_OVERWRITE);
            require func_get_arg(0);
        };

        $obInitialLevel = ob_get_level();
        ob_start();
        ob_implicit_flush(0);
        try {
            $renderer->bindTo($this)($path, $params);
            return ob_get_clean();
        } catch (\Throwable $e) {
            while (ob_get_level() > $obInitialLevel) {
                if (!@ob_end_clean()) {
                    ob_clean();
                }
            }
            throw $e;
        }
    }

    /**
     * Renders the previous exception stack for a given Exception.
     * @param \Throwable $t the exception whose precursors should be rendered.
     * @return string HTML content of the rendered previous exceptions.
     * Empty string if there are none.
     * @throws \Throwable
     */
    private function renderPreviousExceptions(\Throwable $t): string

    {
        if (($previous = $t->getPrevious()) !== null) {
            $templatePath = $this->defaultTemplatePath . '/previousException.php';
            return $this->renderTemplate($templatePath, ['throwable' => $previous]);
        }
        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.
     * @throws \Throwable
     */
    private function renderCallStackItem(?string $file, ?int $line, ?string $class, ?string $method, array $args, int $index): string
    {
        $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->maxTraceLines) / 2);
            $begin = $line - $half > 0 ? $line - $half : 0;
            $end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
        }
        $templatePath = $this->defaultTemplatePath . '/callStackItem.php';
        return $this->renderTemplate($templatePath, [
            'file' => $file,
            'line' => $line,
            'class' => $class,
            'method' => $method,
            'index' => $index,
            'lines' => $lines,
            'begin' => $begin,
            'end' => $end,
            'args' => $args,
        ]);
    }

    /**
     * Renders call stack.
     * @param \Throwable $t exception to get call stack from
     * @return string HTML content of the rendered call stack.
     * @throws \Throwable
     */
    private function renderCallStack(\Throwable $t): string

    {
        $out = '<ul>';
        $out .= $this->renderCallStackItem($t->getFile(), $t->getLine(), null, null, [], 1);
        for ($i = 0, $trace = $t->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;
    }

    /**
     * Determines whether given name of the file belongs to the framework.
     * @param string|null $file name to be checked.
     * @return bool whether given name of the file belongs to the framework.
     */
    private function isCoreFile(?string $file): bool

    {
        return $file === null || strpos(realpath($file), Info::frameworkPath() . DIRECTORY_SEPARATOR) === 0;
    }

    /**
     * Adds informational links to the given PHP type/class.
     * @param string $code type/class name to be linkified.
     * @param string|null $title custom title to use
     * @return string linkified with HTML type/class name.
     * @throws \ReflectionException
     */
    private function addTypeLinks(string $code, string $title = null): string

    {
        if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) {
            [, $class, $method] = $matches;
            $text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class) . '::' . $this->htmlEncode($method);
        } else {
            $class = $code;
            $method = null;
            $text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class);
        }
        $url = null;
        $shouldGenerateLink = true;
        if ($method !== null && substr_compare($method, '{closure}', -9) !== 0) {
            try {
                $reflection = new \ReflectionClass($class);
                if ($reflection->hasMethod($method)) {
                    $reflectionMethod = $reflection->getMethod($method);
                    $shouldGenerateLink = $reflectionMethod->isPublic() || $reflectionMethod->isProtected();
                } else {
                    $shouldGenerateLink = false;
                }
            } catch (\Throwable $e) {
                $shouldGenerateLink = false;
            }
        }
        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|null $class the type or class name.
     * @param string|null $method the method name.
     * @return string|null the informational link URL.
     * @see addTypeLinks()
     */
    private function getTypeUrl(?string $class, ?string $method): ?string
    {
        if (strncmp($class, 'Yiisoft\\', 8) !== 0) {
            return null;
        }
        $page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class)));
        $url = "http://www.yiiframework.com/doc-3.0/$page.html";
        if ($method) {
            $url .= "#$method()-detail";
        }
        return $url;
    }

    /**
     * Converts arguments array to its string representation.
     *
     * @param array $args arguments array to be converted
     * @return string string representation of the arguments array
     */
    private function argumentsToString(array $args): string
    {
        $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)) {
                unset($args[$key]);
                $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]";
            }
        }

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

    /**
     * Renders the information about request.
     * @return string the rendering result
     */
    private function renderRequest(): string

    {
        if ($this->request === null) {
            return '';
        }

        $request = $this->request;
        $output = $request->getMethod() . ' ' . $request->getUri() . "\n";

        foreach ($request->getHeaders() as $name => $values) {
            if ($name === 'Host') {
                continue;
            }

            foreach ($values as $value) {
                $output .= "$name: $value\n";
            }
        }

        $output .= "\n" . $request->getBody() . "\n\n";

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

    private function renderCurl(): string

    {
        try {
            $output = (new Command())->setRequest($this->request)->build();
        } catch (\Throwable $e) {
            $output = 'Error generating curl command: ' . $e->getMessage();
        }

        return $this->htmlEncode($output);
    }


    /**
     * 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.
     */
    private function createServerInformationLink(): string

    {
        if ($this->request === null) {
            return '';
        }


        $serverSoftware = $this->request->getServerParams()['SERVER_SOFTWARE'] ?? null;
        if ($serverSoftware === null) {
            return '';
        }

        $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'],
            'https://secure.php.net/manual/en/features.commandline.webserver.php' => ['development'],
        ];

        foreach ($serverUrls as $url => $keywords) {
            foreach ($keywords as $keyword) {
                if (stripos($serverSoftware, $keyword) !== false) {
                    return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($serverSoftware) . '</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(): string
    {
        return '<a href="http://github.com/yiisoft/app/" target="_blank">' . $this->htmlEncode(Info::frameworkVersion()) . '</a>';
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Yii\Web\ErrorHandler;
6
7		use Alexkart\CurlBuilder\Command;
8		use Yiisoft\Yii\Web\Info;
9
10		final class HtmlRenderer extends ThrowableRenderer
11		{
12		private int $maxSourceLines = 19;
13		private int $maxTraceLines = 13;
14
15		private string $traceLine = '{html}';
16
17		private string $defaultTemplatePath;
18
19		private string $errorTemplate;
20		private string $exceptionTemplate;
21
22	5	public function __construct(array $templates = [])
23		{
24	5	$this->defaultTemplatePath = $templates['path'];
25	5	$this->errorTemplate = $templates['error'] ?? $this->defaultTemplatePath . '/error.php';
26	5	$this->exceptionTemplate = $templates['exception'] ?? $this->defaultTemplatePath . '/exception.php';
27	5	}
28
29		public function withMaxSourceLines(int $maxSourceLines): self
30		{
31		$new = clone $this;
32		$new->maxSourceLines = $maxSourceLines;
33		return $new;
34		}
35
36		public function withMaxTraceLines(int $maxTraceLines): self
37		{
38		$new = clone $this;
39		$new->maxTraceLines = $maxTraceLines;
40		return $new;
41		}
42
43		public function withTraceLine(string $traceLine): self
44		{
45		$new = clone $this;
46		$new->traceLine = $traceLine;
47		return $new;
48		}
49
50	3	public function render(\Throwable $t): string
51		{
52	3	return $this->renderTemplate($this->errorTemplate, [
53	3	'throwable' => $t,
54		]);
55		}
56
57	2	public function renderVerbose(\Throwable $t): string
58		{
59	2	return $this->renderTemplate($this->exceptionTemplate, [
60	2	'throwable' => $t,
61		]);
62		}
63
64	2	private function htmlEncode(string $text): string
65		{
66	2	return htmlspecialchars($text, ENT_QUOTES, 'UTF-8');
67		}
68
69	5	private function renderTemplate(string $path, array $params): string
70		{
71	5	if (!file_exists($path)) {
72	1	throw new \RuntimeException("Template not found at $path");
73		}
74
75	4	$renderer = function (): void {
76	4	extract(func_get_arg(1), EXTR_OVERWRITE);
77	4	require func_get_arg(0);
78	4	};
79
80	4	$obInitialLevel = ob_get_level();
81	4	ob_start();
82	4	ob_implicit_flush(0);
83		try {
84	4	$renderer->bindTo($this)($path, $params);
85	4	return ob_get_clean();
86		} catch (\Throwable $e) {
87		while (ob_get_level() > $obInitialLevel) {
88		if (!@ob_end_clean()) {
89		ob_clean();
90		}
91		}
92		throw $e;
93		}
94		}
95
96		/**
97		* Renders the previous exception stack for a given Exception.
98		* @param \Throwable $t the exception whose precursors should be rendered.
99		* @return string HTML content of the rendered previous exceptions.
100		* Empty string if there are none.
101		* @throws \Throwable
102		*/
103	1	private function renderPreviousExceptions(\Throwable $t): string
		0 ignored issues – show Unused Code introduced 2019-07-10 19:51 UTC by Report Bug Copy Issue Report The method `renderPreviousExceptions()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
104		{
105	1	if (($previous = $t->getPrevious()) !== null) {
106		$templatePath = $this->defaultTemplatePath . '/previousException.php';
107		return $this->renderTemplate($templatePath, ['throwable' => $previous]);
108		}
109	1	return '';
110		}
111
112		/**
113		* Renders a single call stack element.
114		* @param string\|null $file name where call has happened.
115		* @param int\|null $line number on which call has happened.
116		* @param string\|null $class called class name.
117		* @param string\|null $method called function/method name.
118		* @param array $args array of method arguments.
119		* @param int $index number of the call stack element.
120		* @return string HTML content of the rendered call stack element.
121		* @throws \Throwable
122		*/
123	1	private function renderCallStackItem(?string $file, ?int $line, ?string $class, ?string $method, array $args, int $index): string
124		{
125	1	$lines = [];
126	1	$begin = $end = 0;
127	1	if ($file !== null && $line !== null) {
128	1	$line--; // adjust line number from one-based to zero-based
129	1	$lines = @file($file);
130	1	if ($line < 0 \|\| $lines === false \|\| ($lineCount = count($lines)) < $line) {
131		return '';
132		}
133	1	$half = (int)(($index === 1 ? $this->maxSourceLines : $this->maxTraceLines) / 2);
134	1	$begin = $line - $half > 0 ? $line - $half : 0;
135	1	$end = $line + $half < $lineCount ? $line + $half : $lineCount - 1;
136		}
137	1	$templatePath = $this->defaultTemplatePath . '/callStackItem.php';
138	1	return $this->renderTemplate($templatePath, [
139	1	'file' => $file,
140	1	'line' => $line,
141	1	'class' => $class,
142	1	'method' => $method,
143	1	'index' => $index,
144	1	'lines' => $lines,
145	1	'begin' => $begin,
146	1	'end' => $end,
147	1	'args' => $args,
148		]);
149		}
150
151		/**
152		* Renders call stack.
153		* @param \Throwable $t exception to get call stack from
154		* @return string HTML content of the rendered call stack.
155		* @throws \Throwable
156		*/
157	1	private function renderCallStack(\Throwable $t): string
		0 ignored issues – show Unused Code introduced 2019-07-10 19:51 UTC by Report Bug Copy Issue Report The method `renderCallStack()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
158		{
159	1	$out = '<ul>';
160	1	$out .= $this->renderCallStackItem($t->getFile(), $t->getLine(), null, null, [], 1);
161	1	for ($i = 0, $trace = $t->getTrace(), $length = count($trace); $i < $length; ++$i) {
162	1	$file = !empty($trace[$i]['file']) ? $trace[$i]['file'] : null;
163	1	$line = !empty($trace[$i]['line']) ? $trace[$i]['line'] : null;
164	1	$class = !empty($trace[$i]['class']) ? $trace[$i]['class'] : null;
165	1	$function = null;
166	1	if (!empty($trace[$i]['function']) && $trace[$i]['function'] !== 'unknown') {
167	1	$function = $trace[$i]['function'];
168		}
169	1	$args = !empty($trace[$i]['args']) ? $trace[$i]['args'] : [];
170	1	$out .= $this->renderCallStackItem($file, $line, $class, $function, $args, $i + 2);
171		}
172	1	$out .= '</ul>';
173	1	return $out;
174		}
175
176		/**
177		* Determines whether given name of the file belongs to the framework.
178		* @param string\|null $file name to be checked.
179		* @return bool whether given name of the file belongs to the framework.
180		*/
181	1	private function isCoreFile(?string $file): bool
		0 ignored issues – show Unused Code introduced 2019-07-09 11:37 UTC by Report Bug Copy Issue Report The method `isCoreFile()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
182		{
183	1	return $file === null \|\| strpos(realpath($file), Info::frameworkPath() . DIRECTORY_SEPARATOR) === 0;
184		}
185
186		/**
187		* Adds informational links to the given PHP type/class.
188		* @param string $code type/class name to be linkified.
189		* @param string\|null $title custom title to use
190		* @return string linkified with HTML type/class name.
191		* @throws \ReflectionException
192		*/
193	1	private function addTypeLinks(string $code, string $title = null): string
		0 ignored issues – show Unused Code introduced 2019-07-10 10:15 UTC by Report Bug Copy Issue Report The method `addTypeLinks()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
194		{
195	1	if (preg_match('/(.*?)::([^(]+)/', $code, $matches)) {
196	1	[, $class, $method] = $matches;
197	1	$text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class) . '::' . $this->htmlEncode($method);
198		} else {
199	1	$class = $code;
200	1	$method = null;
201	1	$text = $title ? $this->htmlEncode($title) : $this->htmlEncode($class);
202		}
203	1	$url = null;
204	1	$shouldGenerateLink = true;
205	1	if ($method !== null && substr_compare($method, '{closure}', -9) !== 0) {
206		try {
207	1	$reflection = new \ReflectionClass($class);
208	1	if ($reflection->hasMethod($method)) {
209	1	$reflectionMethod = $reflection->getMethod($method);
210	1	$shouldGenerateLink = $reflectionMethod->isPublic() \|\| $reflectionMethod->isProtected();
211		} else {
212	1	$shouldGenerateLink = false;
213		}
214		} catch (\Throwable $e) {
215		$shouldGenerateLink = false;
216		}
217		}
218	1	if ($shouldGenerateLink) {
219	1	$url = $this->getTypeUrl($class, $method);
220		}
221	1	if ($url === null) {
222	1	return $text;
223		}
224	1	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\|null $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	1	private function getTypeUrl(?string $class, ?string $method): ?string
235		{
236	1	if (strncmp($class, 'Yiisoft\\', 8) !== 0) {
237	1	return null;
238		}
239	1	$page = $this->htmlEncode(strtolower(str_replace('\\', '-', $class)));
240	1	$url = "http://www.yiiframework.com/doc-3.0/$page.html";
241	1	if ($method) {
242	1	$url .= "#$method()-detail";
243		}
244	1	return $url;
245		}
246
247		/**
248		* Converts arguments array to its string representation.
249		*
250		* @param array $args arguments array to be converted
251		* @return string string representation of the arguments array
252		*/
253	1	private function argumentsToString(array $args): string
254		{
255	1	$count = 0;
256	1	$isAssoc = $args !== array_values($args);
257	1	foreach ($args as $key => $value) {
258		$count++;
259		if ($count >= 5) {
260		if ($count > 5) {
261		unset($args[$key]);
262		} else {
263		$args[$key] = '...';
264		}
265		continue;
266		}
267		if (is_object($value)) {
268		$args[$key] = '<span class="title">' . $this->htmlEncode(get_class($value)) . '</span>';
269		} elseif (is_bool($value)) {
270		$args[$key] = '<span class="keyword">' . ($value ? 'true' : 'false') . '</span>';
271		} elseif (is_string($value)) {
272		$fullValue = $this->htmlEncode($value);
273		if (mb_strlen($value, 'UTF-8') > 32) {
274		$displayValue = $this->htmlEncode(mb_substr($value, 0, 32, 'UTF-8')) . '...';
275		$args[$key] = "<span class=\"string\" title=\"$fullValue\">'$displayValue'</span>";
276		} else {
277		$args[$key] = "<span class=\"string\">'$fullValue'</span>";
278		}
279		} elseif (is_array($value)) {
280		unset($args[$key]);
281		$args[$key] = '[' . $this->argumentsToString($value) . ']';
282		} elseif ($value === null) {
283		$args[$key] = '<span class="keyword">null</span>';
284		} elseif (is_resource($value)) {
285		$args[$key] = '<span class="keyword">resource</span>';
286		} else {
287		$args[$key] = '<span class="number">' . $value . '</span>';
288		}
289		if (is_string($key)) {
290		$args[$key] = '<span class="string">\'' . $this->htmlEncode($key) . "'</span> => $args[$key]";
291		} elseif ($isAssoc) {
292		$args[$key] = "<span class=\"number\">$key</span> => $args[$key]";
293		}
294		}
295
296	1	ksort($args);
297	1	return implode(', ', $args);
298		}
299
300		/**
301		* Renders the information about request.
302		* @return string the rendering result
303		*/
304	1	private function renderRequest(): string
		0 ignored issues – show Unused Code introduced 2019-07-09 23:03 UTC by Report Bug Copy Issue Report The method `renderRequest()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
305		{
306	1	if ($this->request === null) {
307		return '';
308		}
309
310	1	$request = $this->request;
311	1	$output = $request->getMethod() . ' ' . $request->getUri() . "\n";
312
313	1	foreach ($request->getHeaders() as $name => $values) {
314	1	if ($name === 'Host') {
315		continue;
316		}
317
318	1	foreach ($values as $value) {
319	1	$output .= "$name: $value\n";
320		}
321		}
322
323	1	$output .= "\n" . $request->getBody() . "\n\n";
324
325	1	return '<pre>' . $this->htmlEncode(rtrim($output, "\n")) . '</pre>';
326		}
327
328	1	private function renderCurl(): string
		0 ignored issues – show Unused Code introduced 2019-08-25 22:08 UTC by Report Bug Copy Issue Report The method `renderCurl()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
329		{
330		try {
331	1	$output = (new Command())->setRequest($this->request)->build();
332		} catch (\Throwable $e) {
333		$output = 'Error generating curl command: ' . $e->getMessage();
334		}
335
336	1	return $this->htmlEncode($output);
337		}
338
339
340		/**
341		* Creates string containing HTML link which refers to the home page of determined web-server software
342		* and its full name.
343		* @return string server software information hyperlink.
344		*/
345	1	private function createServerInformationLink(): string
		0 ignored issues – show Unused Code introduced 2019-07-09 11:37 UTC by Report Bug Copy Issue Report The method `createServerInformationLink()` is not used, and could be removed. This check looks for private methods that have been defined, but are not used inside the class. Loading history...
346		{
347	1	if ($this->request === null) {
348		return '';
349		}
350
351
352	1	$serverSoftware = $this->request->getServerParams()['SERVER_SOFTWARE'] ?? null;
353	1	if ($serverSoftware === null) {
354	1	return '';
355		}
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		'https://secure.php.net/manual/en/features.commandline.webserver.php' => ['development'],
364		];
365
366		foreach ($serverUrls as $url => $keywords) {
367		foreach ($keywords as $keyword) {
368		if (stripos($serverSoftware, $keyword) !== false) {
369		return '<a href="' . $url . '" target="_blank">' . $this->htmlEncode($serverSoftware) . '</a>';
370		}
371		}
372		}
373		return '';
374		}
375
376		/**
377		* Creates string containing HTML link which refers to the page with the current version
378		* of the framework and version number text.
379		* @return string framework version information hyperlink.
380		*/
381	1	public function createFrameworkVersionLink(): string
382		{
383	1	return '<a href="http://github.com/yiisoft/app/" target="_blank">' . $this->htmlEncode(Info::frameworkVersion()) . '</a>';
384		}
385		}
386

yiisoft / yii-web

Push — master ( 8508e9...885421 )

HtmlRenderer::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like