Completed
Push — 6.0 ( 2a00ae...39e6cf )
by yun
04:09
created

Db::setEvent()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 3
Code Lines 1

Duplication

Lines 0
Ratio 0 %

Code Coverage

Tests 0
CRAP Score 2

Importance

Changes 0
Metric Value
cc 1
eloc 1
nc 1
nop 1
dl 0
loc 3
ccs 0
cts 2
cp 0
crap 2
rs 10
c 0
b 0
f 0
1
<?php
2
// +----------------------------------------------------------------------
1 ignored issue
show
Coding Style introduced by
You must use "/**" style comments for a file comment
Loading history...
3
// | ThinkPHP [ WE CAN DO IT JUST THINK ]
4
// +----------------------------------------------------------------------
5
// | Copyright (c) 2006~2019 http://thinkphp.cn All rights reserved.
6
// +----------------------------------------------------------------------
7
// | Licensed ( http://www.apache.org/licenses/LICENSE-2.0 )
8
// +----------------------------------------------------------------------
9
// | Author: liu21st <[email protected]>
10
// +----------------------------------------------------------------------
11
declare (strict_types = 1);
12
13
namespace think;
14
15
use InvalidArgumentException;
16
use think\db\Connection;
17
use think\db\Query;
18
use think\db\Raw;
19
use think\exception\DbException;
20
21
/**
22
 * Class Db
23
 * @package think
0 ignored issues
show
Coding Style introduced by
Package name "think" is not valid; consider "Think" instead
Loading history...
24
 * @mixin Query
1 ignored issue
show
Coding Style introduced by
Tag value for @mixin tag indented incorrectly; expected 3 spaces but found 1
Loading history...
25
 */
4 ignored issues
show
Coding Style introduced by
Missing @category tag in class comment
Loading history...
Coding Style introduced by
Missing @author tag in class comment
Loading history...
Coding Style introduced by
Missing @license tag in class comment
Loading history...
Coding Style introduced by
Missing @link tag in class comment
Loading history...
26
class Db
27
{
28
    /**
29
     * 当前数据库连接对象
30
     * @var Connection
31
     */
32
    protected $connection;
33
34
    /**
35
     * 数据库连接实例
36
     * @var array
37
     */
38
    protected $instance = [];
39
40
    /**
41
     * Event对象
42
     * @var Event
43
     */
44
    protected $event;
45
46
    /**
47
     * 数据库配置
48
     * @var array
49
     */
50
    protected $option = [];
51
52
    /**
53
     * SQL监听
54
     * @var array
55
     */
56
    protected $listen = [];
57
58
    /**
59
     * 查询次数
60
     * @var int
61
     */
62
    protected $queryTimes = 0;
63
64
    /**
65
     * 架构函数
66
     * @param array $config 连接配置
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
67
     * @access public
68
     */
69 1
    public function __construct(array $config = [])
70
    {
71 1
        $this->option = $config;
72
73 1
        $this->connect($config);
74 1
    }
75
76
    /**
0 ignored issues
show
Coding Style introduced by
Missing short description in doc comment
Loading history...
77
     * @param Event  $event
1 ignored issue
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 14 spaces but found 1
Loading history...
78
     * @param Config $config
1 ignored issue
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 14 spaces but found 1
Loading history...
79
     * @return Db
1 ignored issue
show
Coding Style introduced by
Tag value for @return tag indented incorrectly; expected 13 spaces but found 1
Loading history...
80
     * @codeCoverageIgnore
81
     */
82
    public static function __make(Event $event, Config $config)
2 ignored issues
show
Coding Style introduced by
Method name "Db::__make" is invalid; only PHP magic methods should be prefixed with a double underscore
Loading history...
Coding Style introduced by
Public method name "Db::__make" must not be prefixed with an underscore
Loading history...
83
    {
84
        $db = new static($config->get('database'));
0 ignored issues
show
Bug introduced by
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? ( Ignorable by Annotation )

If this is a false-positive, you can also ignore this issue in your code via the ignore-type  annotation

84
        $db = new static(/** @scrutinizer ignore-type */ $config->get('database'));
Loading history...
85
86
        $db->setEvent($event);
87
88
        return $db;
89
    }
90
91
    /**
92
     * 切换数据库连接
93
     * @access public
94
     * @param mixed       $config 连接配置
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
95
     * @param bool|string $name   连接标识 true 强制重新连接
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
96
     * @return $this
97
     */
98 1
    public function connect($config = [], $name = false)
99
    {
100 1
        $this->connection = $this->instance($this->parseConfig($config), $name);
101 1
        return $this;
102
    }
103
104
    /**
105
     * 取得数据库连接类实例
106
     * @access public
107
     * @param array       $config 连接配置
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
108
     * @param bool|string $name   连接标识 true 强制重新连接
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
109
     * @return Connection
110
     */
111 1
    public function instance(array $config = [], $name = false)
112
    {
113 1
        if (false === $name) {
114 1
            $name = md5(serialize($config));
115
        }
116
117 1
        if (true === $name || !isset($this->instance[$name])) {
118
119 1
            if (empty($config['type'])) {
120
                throw new InvalidArgumentException('Undefined db type');
121
            }
122
123 1
            if (true === $name) {
124
                $name = md5(serialize($config));
125
            }
126
127 1
            $this->instance[$name] = App::factory($config['type'], '\\think\\db\\connector\\', $config);
128
        }
129
130 1
        return $this->instance[$name];
131
    }
132
133
    /**
134
     * 使用表达式设置数据
135
     * @access public
136
     * @param string $value 表达式
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
137
     * @return Raw
138
     */
139
    public function raw(string $value): Raw
140
    {
141
        return new Raw($value);
142
    }
143
144
    /**
145
     * 更新查询次数
146
     * @access public
147
     * @return void
148
     */
149
    public function updateQueryTimes(): void
150
    {
151
        $this->queryTimes++;
152
    }
153
154
    /**
155
     * 获得查询次数
156
     * @access public
157
     * @return integer
158
     */
159
    public function getQueryTimes(): int
160
    {
161
        return $this->queryTimes;
162
    }
163
164
    /**
165
     * 数据库连接参数解析
166
     * @access private
167
     * @param mixed $config
1 ignored issue
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
168
     * @return array
169
     */
170 1
    private function parseConfig($config): array
0 ignored issues
show
Coding Style introduced by
Private method name "Db::parseConfig" must be prefixed with an underscore
Loading history...
171
    {
172 1
        if (empty($config)) {
173
            $config = $this->option;
174 1
        } elseif (is_string($config) && isset($this->option[$config])) {
175
            // 支持读取配置参数
176
            $config = $this->option[$config];
177
        }
178
179 1
        if (!is_array($config)) {
180
            throw new DbException('database config error:' . $config);
181
        }
182
183 1
        return $config;
184
    }
185
186
    /**
187
     * 获取数据库的配置参数
188
     * @access public
189
     * @param string $name 参数名称
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
190
     * @return mixed
191
     */
192
    public function getConfig(string $name = '')
193
    {
194
        return $name ? ($this->option[$name] ?? null) : $this->option;
195
    }
196
197
    /**
198
     * 创建一个新的查询对象
199
     * @access public
200
     * @param string|array $connection 连接配置信息
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
201
     * @return mixed
202
     */
203
    public function buildQuery($connection = [])
204
    {
205
        return $this->connect($connection)->newQuery();
206
    }
207
208
    /**
209
     * 监听SQL执行
210
     * @access public
211
     * @param callable $callback 回调方法
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
212
     * @return void
213
     */
214
    public function listen(callable $callback): void
215
    {
216
        $this->listen[] = $callback;
217
    }
218
219
    /**
220
     * 获取监听SQL执行
221
     * @access public
222
     * @return array
223
     */
224
    public function getListen(): array
225
    {
226
        return $this->listen;
227
    }
228
229
    /**
230
     * 设置Event对象
231
     * @param Event $event
0 ignored issues
show
Coding Style introduced by
Missing parameter comment
Loading history...
232
     */
0 ignored issues
show
Coding Style introduced by
Missing @return tag in function comment
Loading history...
233
    public function setEvent(Event $event)
234
    {
235
        $this->event = $event;
236
    }
237
238
    /**
239
     * 注册回调方法
240
     * @access public
241
     * @param string   $event    事件名
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
242
     * @param callable $callback 回调方法
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
243
     * @return void
244
     */
245
    public function event(string $event, callable $callback): void
246
    {
247
        if ($this->event) {
248
            $this->event->listen('db.' . $event, $callback);
249
        }
250
    }
251
252
    /**
253
     * 触发事件
254
     * @access public
255
     * @param string $event  事件名
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
256
     * @param mixed  $params 传入参数
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
257
     * @param bool   $once
1 ignored issue
show
Coding Style introduced by
Missing parameter comment
Loading history...
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
258
     * @return mixed
259
     */
260
    public function trigger(string $event, $params = null, bool $once = false)
261
    {
262
        if ($this->event) {
263
            return $this->event->trigger('db.' . $event, $params, $once);
264
        }
265
    }
266
267
    /**
268
     * 创建一个新的查询对象
269
     * @access protected
270
     * @param Connection $connection 连接对象
1 ignored issue
show
Coding Style introduced by
Tag value for @param tag indented incorrectly; expected 2 spaces but found 1
Loading history...
271
     * @return mixed
272
     */
273
    protected function newQuery($connection = null)
274
    {
275
        /** @var Query $query */
0 ignored issues
show
Coding Style introduced by
The open comment tag must be the only content on the line
Loading history...
Coding Style introduced by
Missing short description in doc comment
Loading history...
Coding Style introduced by
The close comment tag must be the only content on the line
Loading history...
276
        $connection = $connection ?: $this->connection;
277
        $class      = $connection->getQueryClass();
278
        $query      = new $class($connection);
279
280
        $query->setDb($this);
281
282
        return $query;
283
    }
284
285
    public function __call($method, $args)
0 ignored issues
show
Coding Style introduced by
Missing doc comment for function __call()
Loading history...
286
    {
287
        $query = $this->newQuery($this->connection);
288
289
        return call_user_func_array([$query, $method], $args);
290
    }
291
}
292