think\debug\Console

Complexity

Total Complexity

28

Size/Duplication

Total Lines	149
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	3	1
B	console()	0	38	11
C	output()	0	73	14
A	getFileInfo()	0	10	2

<?php
// +----------------------------------------------------------------------

You must use "/**" style comments for a file comment

// | ThinkPHP [ WE CAN DO IT JUST THINK IT ]
// +----------------------------------------------------------------------
// | Copyright (c) 2006-2016 http://thinkphp.cn All rights reserved.
// +----------------------------------------------------------------------
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
// +----------------------------------------------------------------------
// | Author: yangweijie <yangweijiester@gmail.com>
// +----------------------------------------------------------------------
declare (strict_types = 1);
namespace think\debug;

use think\App;
use think\Response;

/**
 * 浏览器调试输出
 */

Missing @category tag in class comment

Missing @package tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Console
{
    protected $config = [
        'tabs' => ['base' => '基本', 'file' => '文件', 'info' => '流程', 'notice|error' => '错误', 'sql' => 'SQL', 'debug|log' => '调试'],
    ];

    // 实例化并传入参数
    public function __construct(array $config = [])

You must use "/**" style comments for a function comment

    {
        $this->config = array_merge($this->config, $config);
    }

    /**

Parameter $app should have a doc-comment as per coding-style.

     * 调试输出接口
     * @access public
     * @param  Response  $response Response对象

Doc comment for parameter $response does not match actual variable name $app

     * @param  array     $log 日志信息

Expected 6 spaces after parameter name; 1 found

Doc comment for parameter $log does not match actual variable name $response

     * @return string|bool
     */
    public function output(App $app, Response $response, array $log = [])
    {
        $request     = $app->request;
        $contentType = $response->getHeader('Content-Type');
        $accept      = $request->header('accept');
        if (strpos($accept, 'application/json') === 0 || $request->isAjax()) {

It seems like $accept can also be of type array; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

            return false;
        } elseif (!empty($contentType) && strpos($contentType, 'html') === false) {
            return false;
        }
        // 获取基本信息
        $runtime = number_format(microtime(true) - $app->getBeginTime(), 10);
        $reqs    = $runtime > 0 ? number_format(1 / $runtime, 2) : '∞';
        $mem     = number_format((memory_get_usage() - $app->getBeginMem()) / 1024, 2);

        if ($request->host()) {
            $uri = $request->protocol() . ' ' . $request->method() . ' : ' . $request->url(true);
        } else {
            $uri = 'cmd:' . implode(' ', $_SERVER['argv']);
        }

        // 页面Trace信息
        $base = [
            '请求信息' => date('Y-m-d H:i:s', $request->time()) . ' ' . $uri,

It seems like $request->time() can also be of type double; however, parameter $timestamp of date() does only seem to accept integer, maybe add an additional type check?

            '运行时间' => number_format((float) $runtime, 6) . 's [ 吞吐率：' . $reqs . 'req/s ] 内存消耗：' . $mem . 'kb 文件加载：' . count(get_included_files()),
            '查询信息' => $app->db->getQueryTimes() . ' queries',
            '缓存信息' => $app->cache->getReadTimes() . ' reads,' . $app->cache->getWriteTimes() . ' writes',

The method getWriteTimes() does not exist on think\Cache. Since you implemented __call, consider adding a @method annotation.

The method getReadTimes() does not exist on think\Cache. Since you implemented __call, consider adding a @method annotation.

        ];

        if ($app->session->getId(false)) {
            $base['会话信息'] = 'SESSION_ID=' . $app->session->getId();
        }

        $info = $this->getFileInfo();

        // 页面Trace信息
        $trace = [];
        foreach ($this->config['tabs'] as $name => $title) {
            $name = strtolower($name);
            switch ($name) {
                case 'base': // 基本信息

Line indented incorrectly; expected 12 spaces, found 16

                    $trace[$title] = $base;
                    break;
                case 'file': // 文件信息

Line indented incorrectly; expected 12 spaces, found 16

                    $trace[$title] = $info;
                    break;
                default: // 调试信息

Line indented incorrectly; expected 12 spaces, found 16

                    if (strpos($name, '|')) {

Line indented incorrectly; expected 16 spaces, found 20

                        // 多组信息
                        $names  = explode('|', $name);
                        $result = [];
                        foreach ($names as $item) {

Line indented incorrectly; expected 20 spaces, found 24

                            $result = array_merge($result, $log[$item] ?? []);
                        }

Line indented incorrectly; expected 20 spaces, found 24

                        $trace[$title] = $result;
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $trace[$title] = $log[$name] ?? '';
                    }

Line indented incorrectly; expected 16 spaces, found 20

            }
        }

        //输出到控制台
        $lines = '';
        foreach ($trace as $type => $msg) {
            $lines .= $this->console($type, $msg);
        }
        $js = <<<JS

<script type='text/javascript'>
{$lines}
</script>
JS;
        return $js;
    }

    protected function console(string $type, $msg)

Missing doc comment for function console()

    {
        $type       = strtolower($type);
        $trace_tabs = array_values($this->config['tabs']);
        $line       = [];
        $line[]     = ($type == $trace_tabs[0] || '调试' == $type || '错误' == $type)
        ? "console.group('{$type}');"
        : "console.groupCollapsed('{$type}');";

        foreach ((array) $msg as $key => $m) {
            switch ($type) {
                case '调试':

Line indented incorrectly; expected 12 spaces, found 16

                    $var_type = gettype($m);
                    if (in_array($var_type, ['array', 'string'])) {

Line indented incorrectly; expected 16 spaces, found 20

                        $line[] = "console.log(" . json_encode($m) . ");";
                    } else {

Line indented incorrectly; expected 16 spaces, found 20

                        $line[] = "console.log(" . json_encode(var_export($m, true)) . ");";
                    }

Line indented incorrectly; expected 16 spaces, found 20

                    break;
                case '错误':

Line indented incorrectly; expected 12 spaces, found 16

                    $msg    = str_replace("\n", '\n', addslashes(is_scalar($m) ? $m : json_encode($m)));
                    $style  = 'color:#F4006B;font-size:14px;';
                    $line[] = "console.error(\"%c{$msg}\", \"{$style}\");";
                    break;
                case 'sql':

Line indented incorrectly; expected 12 spaces, found 16

                    $msg    = str_replace("\n", '\n', addslashes($m));
                    $style  = "color:#009bb4;";
                    $line[] = "console.log(\"%c{$msg}\", \"{$style}\");";
                    break;
                default:

Line indented incorrectly; expected 12 spaces, found 16

                    $m      = is_string($key) ? $key . ' ' . $m : $key + 1 . ' ' . $m;
                    $msg    = json_encode($m);
                    $line[] = "console.log({$msg});";
                    break;
            }
        }
        $line[] = "console.groupEnd();";
        return implode(PHP_EOL, $line);
    }

    /**
     * 获取文件加载信息
     * @access protected
     * @return integer|array
     */
    protected function getFileInfo()
    {
        $files = get_included_files();
        $info  = [];

        foreach ($files as $key => $file) {
            $info[] = $file . ' ( ' . number_format(filesize($file) / 1024, 2) . ' KB )';
        }

        return $info;
    }
}