Config::__get() - Code Metrics - Inspection of "注释完善" - top-think/framework - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — 6.0 ( c334b1...1a5a40 )

by liu

created 2019-04-19 04:33 UTC

Config::__get() A

↳ Parent: Config

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

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

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

// | 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 <[email protected]>
// +----------------------------------------------------------------------
declare (strict_types = 1);

namespace think;

use Yaconf;
filter:
    dependency_paths: ["lib/*"]

/**
 * 配置管理类
 */

class Config
{
    /**
     * 配置参数
     * @var array
     */
    protected $config = [];

    /**
     * 配置文件目录
     * @var string
     */
    protected $path;

    /**
     * 配置文件后缀
     * @var string
     */
    protected $ext;

    /**
     * 是否支持Yaconf
     * @var bool|string
     */
    protected $yaconf;

    /**

     * 构造方法
     * @access public
     */
    public function __construct(string $path = null, string $ext = '.php')
    {
        $this->path   = $path ?: '';
        $this->ext    = $ext;
        $this->yaconf = class_exists('Yaconf');
    }

    public static function __make(App $app)

    {
        $path = $app->getConfigPath();
        $ext  = $app->getConfigExt();

        return new static($path, $ext);
    }

    /**
     * 设置开启Yaconf 或者指定配置文件名
     * @access public
     * @param  bool|string $yaconf 是否使用Yaconf
     * @return void
     */
    public function setYaconf($yaconf): void
    {
        $this->yaconf = $yaconf;
    }

    /**
     * 获取实际的yaconf配置参数名
     * @access protected
     * @param  string $name 配置参数名
     * @return string
     */
    protected function getYaconfName(string $name)
    {
        if ($this->yaconf && is_string($this->yaconf)) {
            return $this->yaconf . '.' . $name;
        }

        return $name;
    }

    /**
     * 获取yaconf配置
     * @access public
     * @param  string $name 配置参数名

     * @param  mixed  $default   默认值

     * @return mixed
     */
    public function yaconf(string $name, $default = null)
    {
        if ($this->yaconf) {
            $yaconfName = $this->getYaconfName($name);

            if (Yaconf::has($yaconfName)) {
                return Yaconf::get($yaconfName);
            }
        }

        return $default;
    }

    /**
     * 加载配置文件（多种格式）
     * @access public
     * @param  string $file 配置文件名
     * @param  string $name 一级配置名
     * @return array
     */
    public function load(string $file, string $name = ''): array
    {
        if (is_file($file)) {
            $filename = $file;
        } elseif (is_file($this->path . $file . $this->ext)) {
            $filename = $this->path . $file . $this->ext;
        }

        if (isset($filename)) {
            return $this->parse($filename, $name);
        }

        if ($this->yaconf && Yaconf::has($file)) {
            return $this->set(Yaconf::get($file), $name);
        }

        return $this->config;
    }

    /**
     * 解析配置文件
     * @access public
     * @param  string $file 配置文件名
     * @param  string $name 一级配置名
     * @return array
     */
    protected function parse(string $file, string $name): array
    {
        $type = pathinfo($file, PATHINFO_EXTENSION);

        switch ($type) {
            case 'php':

                $config = include $file;
                break;
            case 'yaml':

                if (function_exists('yaml_parse_file')) {

                    $config = yaml_parse_file($file);
                }

                break;
            case 'ini':

                $config = parse_ini_file($file, true) ?: [];
                break;
            case 'json':

                $config = json_decode(file_get_contents($file), true);
                break;
        }

        return isset($config) && is_array($config) ? $this->set($config, strtolower($name)) : [];
    }

    /**
     * 检测配置是否存在
     * @access public
     * @param  string $name 配置参数名（支持多级配置 .号分割）
     * @return bool
     */
    public function has(string $name): bool
    {
        return !is_null($this->get($name));
    }

    /**
     * 获取一级配置
     * @access protected
     * @param  string $name 一级配置名
     * @return array
     */
    protected function pull(string $name): array
    {
        $name = strtolower($name);

        if ($this->yaconf) {
            $yaconfName = $this->getYaconfName($name);

            if (Yaconf::has($yaconfName)) {
                $config = Yaconf::get($yaconfName);
                return isset($this->config[$name]) ? array_merge($this->config[$name], $config) : $config;
            }
        }

        return $this->config[$name] ?? [];
    }

    /**
     * 获取配置参数 为空则获取所有配置
     * @access public
     * @param  string $name    配置参数名（支持多级配置 .号分割）
     * @param  mixed  $default 默认值
     * @return mixed
     */
    public function get(string $name = null, $default = null)
    {
        // 无参数时获取所有
        if (empty($name)) {
            return $this->config;
        }

        if (false === strpos($name, '.')) {
            return $this->pull($name);
        }

        if ($this->yaconf) {
            $yaconfName = $this->getYaconfName($name);

            if (Yaconf::has($yaconfName)) {
                return Yaconf::get($yaconfName);
            }
        }

        $name    = explode('.', $name);
        $name[0] = strtolower($name[0]);
        $config  = $this->config;

        // 按.拆分成多维数组进行判断
        foreach ($name as $val) {
            if (isset($config[$val])) {
                $config = $config[$val];
            } else {
                return $default;
            }
        }

        return $config;
    }

    /**
     * 设置配置参数 name为数组则为批量设置
     * @access public
     * @param  array  $config 配置参数
     * @param  string $name 配置名

     * @return array
     */
    public function set(array $config, string $name = null): array
    {
        if (!empty($name)) {
            if (isset($this->config[$name])) {
                $result = array_merge($this->config[$name], $config);
            } else {
                $result = $config;
            }

            $this->config[$name] = $result;
        } else {
            $result = $this->config = array_merge($this->config, array_change_key_case($config));
        }

        return $result;
    }

    /**
     * 移除配置
     * @access public
     * @param  string $name 配置参数名（支持三级配置 .号分割）
     * @return void
     */
    public function remove(string $name): void
    {
        $name = explode('.', $name, 3);

        if (count($name) == 2) {
            unset($this->config[strtolower($name[0])][$name[1]]);
        } else {
            unset($this->config[strtolower($name[0])][$name[1]][$name[2]]);
        }
    }

    /**
     * 重置配置参数
     * @access public
     * @param  string $name 配置名
     * @return void
     */
    public function reset(string $name = ''): void
    {
        if ('' === $name) {
            $this->config = [];
        } else {
            $this->config[$name] = [];
        }
    }

    /**
     * 获取配置参数
     * @access public
     * @param  string $name 参数名
     * @return mixed
     */
    public function __get($name)
    {
        return $this->get($name);
    }

    /**
     * 检测是否存在参数
     * @access public
     * @param  string $name 参数名
     * @return bool
     */
    public function __isset($name)
    {
        return $this->has($name);
    }

}


1		<?php
2		// +----------------------------------------------------------------------
		1 ignored issue – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report 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 Yaconf;
		0 ignored issues – show Bug introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report The type `Yaconf` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
16
17		/**
18		* 配置管理类
19		*/
		5 ignored issues – show Coding Style introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report Missing @category tag in class comment Loading history... Coding Style introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report Missing @package tag in class comment Loading history... Coding Style introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report Missing @author tag in class comment Loading history... Coding Style introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report Missing @license tag in class comment Loading history... Coding Style introduced 2019-04-19 04:35 UTC by Report Bug Copy Issue Report Missing @link tag in class comment Loading history...
20		class Config
21		{
22		/**
23		* 配置参数
24		* @var array
25		*/
26		protected $config = [];
27
28		/**
29		* 配置文件目录
30		* @var string
31		*/
32		protected $path;
33
34		/**
35		* 配置文件后缀
36		* @var string
37		*/
38		protected $ext;
39
40		/**
41		* 是否支持Yaconf
42		* @var bool\|string
43		*/
44		protected $yaconf;
45
46		/**
		0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$path` should have a doc-comment as per coding-style. Loading history... Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Parameter `$ext` should have a doc-comment as per coding-style. Loading history...
47		* 构造方法
48		* @access public
49		*/
50	9	public function __construct(string $path = null, string $ext = '.php')
51		{
52	9	$this->path = $path ?: '';
53	9	$this->ext = $ext;
54	9	$this->yaconf = class_exists('Yaconf');
55	9	}
56
57	9	public static function __make(App $app)
		2 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Method name "Config::__make" is invalid; only PHP magic methods should be prefixed with a double underscore Loading history... Coding Style introduced 2019-03-30 12:16 UTC by Report Bug Copy Issue Report Public method name "Config::__make" must not be prefixed with an underscore Loading history... Coding Style introduced 2019-03-30 12:16 UTC by Report Bug Copy Issue Report Missing doc comment for function __make() Loading history...
58		{
59	9	$path = $app->getConfigPath();
60	9	$ext = $app->getConfigExt();
61
62	9	return new static($path, $ext);
63		}
64
65		/**
66		* 设置开启Yaconf 或者指定配置文件名
67		* @access public
68		* @param bool\|string $yaconf 是否使用Yaconf
69		* @return void
70		*/
71		public function setYaconf($yaconf): void
72		{
73		$this->yaconf = $yaconf;
74		}
75
76		/**
77		* 获取实际的yaconf配置参数名
78		* @access protected
79		* @param string $name 配置参数名
80		* @return string
81		*/
82		protected function getYaconfName(string $name)
83		{
84		if ($this->yaconf && is_string($this->yaconf)) {
85		return $this->yaconf . '.' . $name;
86		}
87
88		return $name;
89		}
90
91		/**
92		* 获取yaconf配置
93		* @access public
94		* @param string $name 配置参数名
		0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Expected 4 spaces after parameter name; 1 found Loading history...
95		* @param mixed $default 默认值
		0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Expected 1 spaces after parameter name; 3 found Loading history...
96		* @return mixed
97		*/
98		public function yaconf(string $name, $default = null)
99		{
100		if ($this->yaconf) {
101		$yaconfName = $this->getYaconfName($name);
102
103		if (Yaconf::has($yaconfName)) {
104		return Yaconf::get($yaconfName);
105		}
106		}
107
108		return $default;
109		}
110
111		/**
112		* 加载配置文件（多种格式）
113		* @access public
114		* @param string $file 配置文件名
115		* @param string $name 一级配置名
116		* @return array
117		*/
118		public function load(string $file, string $name = ''): array
119		{
120		if (is_file($file)) {
121		$filename = $file;
122		} elseif (is_file($this->path . $file . $this->ext)) {
123		$filename = $this->path . $file . $this->ext;
124		}
125
126		if (isset($filename)) {
127		return $this->parse($filename, $name);
128		}
129
130		if ($this->yaconf && Yaconf::has($file)) {
131		return $this->set(Yaconf::get($file), $name);
132		}
133
134		return $this->config;
135		}
136
137		/**
138		* 解析配置文件
139		* @access public
140		* @param string $file 配置文件名
141		* @param string $name 一级配置名
142		* @return array
143		*/
144		protected function parse(string $file, string $name): array
145		{
146		$type = pathinfo($file, PATHINFO_EXTENSION);
147
148		switch ($type) {
149		case 'php':
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
150		$config = include $file;
151		break;
152		case 'yaml':
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
153		if (function_exists('yaml_parse_file')) {
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 12 spaces, found 16 Loading history...
154		$config = yaml_parse_file($file);
155		}
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 12 spaces, found 16 Loading history...
156		break;
157		case 'ini':
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
158		$config = parse_ini_file($file, true) ?: [];
159		break;
160		case 'json':
		1 ignored issue – show Coding Style introduced 2019-04-18 10:58 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 8 spaces, found 12 Loading history...
161		$config = json_decode(file_get_contents($file), true);
162		break;
163		}
164
165		return isset($config) && is_array($config) ? $this->set($config, strtolower($name)) : [];
166		}
167
168		/**
169		* 检测配置是否存在
170		* @access public
171		* @param string $name 配置参数名（支持多级配置 .号分割）
172		* @return bool
173		*/
174		public function has(string $name): bool
175		{
176		return !is_null($this->get($name));
177		}
178
179		/**
180		* 获取一级配置
181		* @access protected
182		* @param string $name 一级配置名
183		* @return array
184		*/
185	8	protected function pull(string $name): array
186		{
187	8	$name = strtolower($name);
188
189	8	if ($this->yaconf) {
190		$yaconfName = $this->getYaconfName($name);
191
192		if (Yaconf::has($yaconfName)) {
193		$config = Yaconf::get($yaconfName);
194		return isset($this->config[$name]) ? array_merge($this->config[$name], $config) : $config;
195		}
196		}
197
198	8	return $this->config[$name] ?? [];
199		}
200
201		/**
202		* 获取配置参数为空则获取所有配置
203		* @access public
204		* @param string $name 配置参数名（支持多级配置 .号分割）
205		* @param mixed $default 默认值
206		* @return mixed
207		*/
208	9	public function get(string $name = null, $default = null)
209		{
210		// 无参数时获取所有
211	9	if (empty($name)) {
212		return $this->config;
213		}
214
215	9	if (false === strpos($name, '.')) {
216	8	return $this->pull($name);
217		}
218
219	7	if ($this->yaconf) {
220		$yaconfName = $this->getYaconfName($name);
221
222		if (Yaconf::has($yaconfName)) {
223		return Yaconf::get($yaconfName);
224		}
225		}
226
227	7	$name = explode('.', $name);
228	7	$name[0] = strtolower($name[0]);
229	7	$config = $this->config;
230
231		// 按.拆分成多维数组进行判断
232	7	foreach ($name as $val) {
233	7	if (isset($config[$val])) {
234		$config = $config[$val];
235		} else {
236	7	return $default;
237		}
238		}
239
240		return $config;
241		}
242
243		/**
244		* 设置配置参数 name为数组则为批量设置
245		* @access public
246		* @param array $config 配置参数
247		* @param string $name 配置名
		0 ignored issues – show Coding Style introduced 2019-02-27 06:16 UTC by Report Bug Copy Issue Report Expected 3 spaces after parameter name; 1 found Loading history...
248		* @return array
249		*/
250		public function set(array $config, string $name = null): array
251		{
252		if (!empty($name)) {
253		if (isset($this->config[$name])) {
254		$result = array_merge($this->config[$name], $config);
255		} else {
256		$result = $config;
257		}
258
259		$this->config[$name] = $result;
260		} else {
261		$result = $this->config = array_merge($this->config, array_change_key_case($config));
262		}
263
264		return $result;
265		}
266
267		/**
268		* 移除配置
269		* @access public
270		* @param string $name 配置参数名（支持三级配置 .号分割）
271		* @return void
272		*/
273		public function remove(string $name): void
274		{
275		$name = explode('.', $name, 3);
276
277		if (count($name) == 2) {
278		unset($this->config[strtolower($name[0])][$name[1]]);
279		} else {
280		unset($this->config[strtolower($name[0])][$name[1]][$name[2]]);
281		}
282		}
283
284		/**
285		* 重置配置参数
286		* @access public
287		* @param string $name 配置名
288		* @return void
289		*/
290		public function reset(string $name = ''): void
291		{
292		if ('' === $name) {
293		$this->config = [];
294		} else {
295		$this->config[$name] = [];
296		}
297		}
298
299		/**
300		* 获取配置参数
301		* @access public
302		* @param string $name 参数名
303		* @return mixed
304		*/
305		public function __get($name)
306		{
307		return $this->get($name);
308		}
309
310		/**
311		* 检测是否存在参数
312		* @access public
313		* @param string $name 参数名
314		* @return bool
315		*/
316		public function __isset($name)
317		{
318		return $this->has($name);
319		}
320
321		}
322

top-think / framework

Push — 6.0 ( c334b1...1a5a40 )

Config::__get() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like