think\Db

Complexity

Total Complexity

30

Size/Duplication

Total Lines	264
Duplicated Lines	0 %

Test Coverage

Coverage

32.79%

Importance

Changes

0

17 Methods

Rating	Name	Duplication	Size	Complexity
A	connect()	0	4	1
A	__make()	0	7	1
A	getListen()	0	3	1
A	updateQueryTimes()	0	3	1
A	getQueryTimes()	0	3	1
A	__call()	0	5	1
A	instance()	0	20	6
A	getConfig()	0	3	2
A	listen()	0	3	1
A	buildQuery()	0	3	1
A	setEvent()	0	3	1
A	event()	0	4	2
A	raw()	0	3	1
A	trigger()	0	4	2
A	parseConfig()	0	14	5
A	newQuery()	0	10	2
A	__construct()	0	5	1

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

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

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

namespace think;

use InvalidArgumentException;
use think\db\Connection;
use think\db\Query;
use think\db\Raw;
use think\exception\DbException;

/**
 * Class Db
 * @package think

Package name "think" is not valid; consider "Think" instead

 * @mixin Query

Tag value for @mixin tag indented incorrectly; expected 3 spaces but found 1

 */

Missing @category tag in class comment

Missing @author tag in class comment

Missing @license tag in class comment

Missing @link tag in class comment

class Db
{
    /**
     * 当前数据库连接对象
     * @var Connection
     */
    protected $connection;

    /**
     * 数据库连接实例
     * @var array
     */
    protected $instance = [];

    /**
     * Event对象
     * @var Event
     */
    protected $event;

    /**
     * 数据库配置
     * @var array
     */
    protected $option = [];

    /**
     * SQL监听
     * @var array
     */
    protected $listen = [];

    /**
     * 查询次数
     * @var int
     */
    protected $queryTimes = 0;

    /**
     * 架构函数
     * @param array $config 连接配置

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @access public
     */
    public function __construct(array $config = [])
    {
        $this->option = $config;

        $this->connect($config);
    }

    /**

Missing short description in doc comment

     * @param Event  $event

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 14 spaces but found 1

     * @param Config $config

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 14 spaces but found 1

     * @return Db

Tag value for @return tag indented incorrectly; expected 13 spaces but found 1

     * @codeCoverageIgnore
     */
    public static function __make(Event $event, Config $config)

Method name "Db::__make" is invalid; only PHP magic methods should be prefixed with a double underscore

Public method name "Db::__make" must not be prefixed with an underscore

    {
        $db = new static($config->get('database'));

It seems like $config->get('database') can also be of type null; however, parameter $config of think\Db::__construct() does only seem to accept array, maybe add an additional type check?

        $db->setEvent($event);

        return $db;
    }

    /**
     * 切换数据库连接
     * @access public
     * @param mixed       $config 连接配置

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool|string $name   连接标识 true 强制重新连接

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return $this
     */
    public function connect($config = [], $name = false)
    {
        $this->connection = $this->instance($this->parseConfig($config), $name);
        return $this;
    }

    /**
     * 取得数据库连接类实例
     * @access public
     * @param array       $config 连接配置

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool|string $name   连接标识 true 强制重新连接

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Connection
     */
    public function instance(array $config = [], $name = false)
    {
        if (false === $name) {
            $name = md5(serialize($config));
        }

        if (true === $name || !isset($this->instance[$name])) {

            if (empty($config['type'])) {
                throw new InvalidArgumentException('Undefined db type');
            }

            if (true === $name) {
                $name = md5(serialize($config));
            }

            $this->instance[$name] = App::factory($config['type'], '\\think\\db\\connector\\', $config);
        }

        return $this->instance[$name];
    }

    /**
     * 使用表达式设置数据
     * @access public
     * @param string $value 表达式

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return Raw
     */
    public function raw(string $value): Raw
    {
        return new Raw($value);
    }

    /**
     * 更新查询次数
     * @access public
     * @return void
     */
    public function updateQueryTimes(): void
    {
        $this->queryTimes++;
    }

    /**
     * 获得查询次数
     * @access public
     * @return integer
     */
    public function getQueryTimes(): int
    {
        return $this->queryTimes;
    }

    /**
     * 数据库连接参数解析
     * @access private
     * @param mixed $config

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return array
     */
    private function parseConfig($config): array

Private method name "Db::parseConfig" must be prefixed with an underscore

    {
        if (empty($config)) {
            $config = $this->option;
        } elseif (is_string($config) && isset($this->option[$config])) {
            // 支持读取配置参数
            $config = $this->option[$config];
        }

        if (!is_array($config)) {
            throw new DbException('database config error:' . $config);
        }

        return $config;
    }

    /**
     * 获取数据库的配置参数
     * @access public
     * @param string $name 参数名称

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed
     */
    public function getConfig(string $name = '')
    {
        return $name ? ($this->option[$name] ?? null) : $this->option;
    }

    /**
     * 创建一个新的查询对象
     * @access public
     * @param string|array $connection 连接配置信息

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed
     */
    public function buildQuery($connection = [])
    {
        return $this->connect($connection)->newQuery();
    }

    /**
     * 监听SQL执行
     * @access public
     * @param callable $callback 回调方法

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return void
     */
    public function listen(callable $callback): void
    {
        $this->listen[] = $callback;
    }

    /**
     * 获取监听SQL执行
     * @access public
     * @return array
     */
    public function getListen(): array
    {
        return $this->listen;
    }

    /**
     * 设置Event对象
     * @param Event $event

Missing parameter comment

     */

Missing @return tag in function comment

    public function setEvent(Event $event)
    {
        $this->event = $event;
    }

    /**
     * 注册回调方法
     * @access public
     * @param string   $event    事件名

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param callable $callback 回调方法

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return void
     */
    public function event(string $event, callable $callback): void
    {
        if ($this->event) {
            $this->event->listen('db.' . $event, $callback);
        }
    }

    /**
     * 触发事件
     * @access public
     * @param string $event  事件名

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param mixed  $params 传入参数

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @param bool   $once

Missing parameter comment

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed
     */
    public function trigger(string $event, $params = null, bool $once = false)
    {
        if ($this->event) {
            return $this->event->trigger('db.' . $event, $params, $once);
        }
    }

    /**
     * 创建一个新的查询对象
     * @access protected
     * @param Connection $connection 连接对象

Tag value for @param tag indented incorrectly; expected 2 spaces but found 1

     * @return mixed
     */
    protected function newQuery($connection = null)
    {
        /** @var Query $query */

The open comment tag must be the only content on the line

Missing short description in doc comment

The close comment tag must be the only content on the line

        $connection = $connection ?: $this->connection;
        $class      = $connection->getQueryClass();
        $query      = new $class($connection);

        $query->setDb($this);

        return $query;
    }

    public function __call($method, $args)

Missing doc comment for function __call()

    {
        $query = $this->newQuery($this->connection);

        return call_user_func_array([$query, $method], $args);
    }
}