Properties::updateConfig() - Code Metrics - Inspection of "Refactoring, fixing, new unit tests [3/10]" - phpffcms/ffcms-core - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 0df9f7...8b132e )

by Mihail

created 2016-12-18 08:00 UTC

Properties::updateConfig() A

↳ Parent: Properties

Complexity

Conditions	2
Paths	2

Size

Total Lines	10
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	10
rs	9.4285
cc	2
eloc	6
nc	2
nop	2

<?php

namespace Ffcms\Core;


use Ffcms\Core\Exception\NativeException;
use Ffcms\Core\Helper\FileSystem\File;
use Ffcms\Core\Helper\Type\Arr;
use Ffcms\Core\Helper\Type\Obj;
use Ffcms\Core\Helper\Type\Str;

/**
 * Class Properties. Provide methods to work with ffcms configs.
 * @package Ffcms\Core
 */
class Properties
{
    protected $data;

    /**
     * Load default configuration
     * @throws NativeException
     */
    public function __construct()
    {
        if ($this->load('default') === false) {
            throw new NativeException('Default configurations is not founded: /Private/Config/Default.php');
        }
    }

    /**
     * Load configurations from file in /Private/Config/
     * @param string $configName
     * @param bool $overload
     * @return bool
     */
    private function load($configName, $overload = false)
    {
        // check if always loaded
        if (Obj::isArray($this->data) && array_key_exists($configName, $this->data) && $overload === false) {
            return true;
        }

        // try to load from file
        $configFile = ucfirst(Str::lowerCase($configName)) . '.php';
        if (File::exist('/Private/Config/' . $configFile)) {
            $this->data[$configName] = File::inc('/Private/Config/' . $configFile, true);
            return true;
        }

        return false;
    }

    /**
     * Get config value by config key from configuration file
     * @param string $configKey
     * @param string $configFile
     * @param bool|false $parseType
     * @return mixed
     */
    public function get($configKey, $configFile = 'default', $parseType = false)
    {
        $this->load($configFile);
        // check if configs for this file is loaded
        if (!isset($this->data[$configFile])) {
            return false;
        }

        // check if config key is exist
        if (!isset($this->data[$configFile][$configKey])) {
            return false;
        }

        $response = $this->data[$configFile][$configKey];

        // try to convert config value by defined parse type
        $parseType = Str::lowerCase($parseType);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        switch ($parseType) {
            case 'int':
            case 'integer':
                $response = (int)$response;
                break;
            case 'bool':
            case 'boolean':
                $response = (bool)$response;
                break;
            case 'float':
                $response = (float)$response;
                break;
            case 'double':
                $response = (double)$response;
                break;
        }

        return $response;
    }

    /**
     * Get all configuration data of selected file
     * @param string $configFile
     * @return bool|array
     */
    public function getAll($configFile = 'default')
    {
        $this->load($configFile);
        if (!Obj::isArray($this->data) || !array_key_exists($configFile, $this->data)) {
            return false;
        }

        return $this->data[$configFile];
    }

    /**
     * Update configuration data based on key-value array of new data. Do not pass multi-level array on new position without existing keys
     * @param string $configFile
     * @param array $newData
     * @return bool
     */
    public function updateConfig($configFile, array $newData)
    {
        $this->load($configFile);
        if (!isset($this->data[$configFile])) {
            return false;
        }

        $saveData = Arr::merge($this->data[$configFile], $newData);
        return $this->writeConfig($configFile, $saveData);
    }

    /**
     * Write configurations data from array to cfg file
     * @param string $configFile
     * @param array $data
     * @return bool
     */
    public function writeConfig($configFile, array $data)
    {
        $path = '/Private/Config/' . ucfirst(Str::lowerCase($configFile)) . '.php';
        if (!File::exist($path) || !File::writable($path)) {
            return false;
        }
        $saveData = '<?php return ' . Arr::exportVar($data) . ';';
        File::write($path, $saveData);
        // overload config values if changed
        $this->load($configFile, true);
        return true;
    }
}

1			<?php
2
3			namespace Ffcms\Core;
4
5
6			use Ffcms\Core\Exception\NativeException;
7			use Ffcms\Core\Helper\FileSystem\File;
8			use Ffcms\Core\Helper\Type\Arr;
9			use Ffcms\Core\Helper\Type\Obj;
10			use Ffcms\Core\Helper\Type\Str;
11
12			/**
13			* Class Properties. Provide methods to work with ffcms configs.
14			* @package Ffcms\Core
15			*/
16			class Properties
17			{
18			protected $data;
19
20			/**
21			* Load default configuration
22			* @throws NativeException
23			*/
24			public function __construct()
25			{
26			if ($this->load('default') === false) {
27			throw new NativeException('Default configurations is not founded: /Private/Config/Default.php');
28			}
29			}
30
31			/**
32			* Load configurations from file in /Private/Config/
33			* @param string $configName
34			* @param bool $overload
35			* @return bool
36			*/
37			private function load($configName, $overload = false)
38			{
39			// check if always loaded
40			if (Obj::isArray($this->data) && array_key_exists($configName, $this->data) && $overload === false) {
41			return true;
42			}
43
44			// try to load from file
45			$configFile = ucfirst(Str::lowerCase($configName)) . '.php';
46			if (File::exist('/Private/Config/' . $configFile)) {
47			$this->data[$configName] = File::inc('/Private/Config/' . $configFile, true);
48			return true;
49			}
50
51			return false;
52			}
53
54			/**
55			* Get config value by config key from configuration file
56			* @param string $configKey
57			* @param string $configFile
58			* @param bool\|false $parseType
59			* @return mixed
60			*/
61			public function get($configKey, $configFile = 'default', $parseType = false)
62			{
63			$this->load($configFile);
64			// check if configs for this file is loaded
65			if (!isset($this->data[$configFile])) {
66			return false;
67			}
68
69			// check if config key is exist
70			if (!isset($this->data[$configFile][$configKey])) {
71			return false;
72			}
73
74			$response = $this->data[$configFile][$configKey];
75
76			// try to convert config value by defined parse type
77			$parseType = Str::lowerCase($parseType);
			0 ignored issues – show Documentation introduced 2015-11-21 16:41 UTC by Report Bug Copy Issue Report `$parseType` is of type `boolean`, but the function expects a `string`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
78			switch ($parseType) {
79			case 'int':
80			case 'integer':
81			$response = (int)$response;
82			break;
83			case 'bool':
84			case 'boolean':
85			$response = (bool)$response;
86			break;
87			case 'float':
88			$response = (float)$response;
89			break;
90			case 'double':
91			$response = (double)$response;
92			break;
93			}
94
95			return $response;
96			}
97
98			/**
99			* Get all configuration data of selected file
100			* @param string $configFile
101			* @return bool\|array
102			*/
103			public function getAll($configFile = 'default')
104			{
105			$this->load($configFile);
106			if (!Obj::isArray($this->data) \|\| !array_key_exists($configFile, $this->data)) {
107			return false;
108			}
109
110			return $this->data[$configFile];
111			}
112
113			/**
114			* Update configuration data based on key-value array of new data. Do not pass multi-level array on new position without existing keys
115			* @param string $configFile
116			* @param array $newData
117			* @return bool
118			*/
119			public function updateConfig($configFile, array $newData)
120			{
121			$this->load($configFile);
122			if (!isset($this->data[$configFile])) {
123			return false;
124			}
125
126			$saveData = Arr::merge($this->data[$configFile], $newData);
127			return $this->writeConfig($configFile, $saveData);
128			}
129
130			/**
131			* Write configurations data from array to cfg file
132			* @param string $configFile
133			* @param array $data
134			* @return bool
135			*/
136			public function writeConfig($configFile, array $data)
137			{
138			$path = '/Private/Config/' . ucfirst(Str::lowerCase($configFile)) . '.php';
139			if (!File::exist($path) \|\| !File::writable($path)) {
140			return false;
141			}
142			$saveData = '<?php return ' . Arr::exportVar($data) . ';';
143			File::write($path, $saveData);
144			// overload config values if changed
145			$this->load($configFile, true);
146			return true;
147			}
148			}

phpffcms / ffcms-core

Push — master ( 0df9f7...8b132e )

Properties::updateConfig() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like