Config::setCliRuntime() - Code Metrics - Inspection of "new luya config" - luyadev/luya - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#1952)

by Basil

created 2019-08-27 09:49 UTC

Config::setCliRuntime() A

↳ Parent: Config

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	4
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1

<?php

namespace luya;

use luya\helpers\ArrayHelper;

use function Opis\Closure\serialize;

/**
 * Configuration array Helper.
 * 
 * The {{luya\Config}} allows you to create the configuration for different hosts and difference between web and console config.
 * 
 * ```php
 * $config = new Config('myapp', dirname(__DIR__), [
 *     'siteTitle' => 'My LUYA Project',
 *     'defaultRoute' => 'cms',
 *     // other application level configurations
 * ]);
 * 
 * // define global components which works either for console or web runtime
 * 
 * $config->component('mail', [
 *     'host' => 'xyz',
 *     'from' => '[email protected]',
 * ]);
 * 
 * $config->component('db', [
 *     'class' => 'yii\db\Connection',
 *     'dsn' => 'mysql:host=localhost;dbname=prod_db',
 *     'username' => 'foo',
 *     'password' => 'bar',
 * ])->env('martin');
 * 
 * 
 * 
 * // define components which are only for web or console runtime:
 * 
 * $config->webComponent('request', [
 *     'cookieValidationKey' => 'xyz',
 * ]);
 * 
 * // which is equals to, but the above is better to read and structure in the config file
 * 
 * $config->component('request', [
 *     'cookieValidationKey' => 'xyz',
 * ])->webRuntime();
 * 
 * // adding modules
 * 
 * $config->module('admin', [
 *     'class' => 'luya\admin\Module',
 *     'secureLogin' => true,
 * ]);
 * 
 * $config->module('cms', 'luya\cms\frontend\Module'); // which is equals to $config->module('cms', ['class' => 'luya\cms\frontend\Module']);
 * 
 * // export and generate the config for a given enviroment or environment independent.
 * 
 * return $config->toArray(); // returns the config not taking care of enviroment variables like prod, env
 * 
 * return $config->toArray(Config::ENV_PROD);
 * ```
 * 
 * @author Basil Suter <[email protected]>
 * @since 1.0.10
 */
class Config
{
    const ENV_ALL = 'all';

    const ENV_PROD = 'prod';
    
    const ENV_PREP = 'prep';
    
    const ENV_DEV = 'dev';
    
    const ENV_LOCAL = 'local';

    const RUNTIME_ALL = 0;

    const RUNTIME_CONSOLE = 1;

    const RUNTIME_WEB = 2;
    
    public function __construct($id, $basePath, array $applicationConfig = [])
    {
        $applicationConfig['id'] = $id;
        $applicationConfig['basePath'] = $basePath;

        $this->application($applicationConfig);
    }

    /**
     * Undocumented function
     *
     * @param [type] $config

     * @return ConfigDefinition
     */
    public function application($config)
    {
        return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_APPLICATIONS, md5(serialize($config)), $config));
    }

    /**
     * Undocumented function
     *
     * @param [type] $id

     * @param [type] $config

     * @return ConfigDefinition
     */
    public function module($id, $config)
    {
        return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_MODULES, $id, $config));
    }

    /**
     * Undocumented function
     *
     * @param [type] $id

     * @param [type] $config

     * @param [type] $runtime

     * @return ConfigDefinition
     */
    public function component($id, $config, $runtime = self::RUNTIME_ALL)
    {
        return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_COMPONENTS, $id, $config))->runtime($runtime);
    }

    /**
     * Undocumented function
     *
     * @param [type] $id

     * @param [type] $config

     * @return ConfigDefinition
     */
    public function webComponent($id, $config)
    {
        return $this->component($id, $config, self::RUNTIME_WEB);
    }

    /**
     * Undocumented function
     *
     * @param [type] $id

     * @param [type] $config

     * @return ConfigDefinition
     */
    public function consoleComponent($id, $config)
    {
        return $this->component($id, $config, self::RUNTIME_CONSOLE);
    }

    private $_definitions = [];

    /**
     * Undocumented function
     *
     * @param ConfigDefinition $definition
     * @return ConfigDefinition
     */
    private function addDefinition(ConfigDefinition $definition)
    {
        $this->_definitions[] = $definition;

        return $definition;
    }

    private $_isCliRuntime;

    /**
     * Whether runtime is cli or not
     *
     * @return boolean
     */
    public function isCliRuntime()
    {
        if ($this->_isCliRuntime === null) {
            $this->_isCliRuntime = strtolower(php_sapi_name()) === 'cli';
        }

        return $this->_isCliRuntime;
    }

    public function setCliRuntime($value)
    {
        $this->_isCliRuntime = $value;
    }

    public function toArray(array $envs = [self::ENV_ALL])
    {
        $config = [];

        foreach ($this->_definitions as $defintion) {
            /** @var ConfigDefinition $definition */

            if (!$definition->validateEnvs($envs)) {

                continue;
            }

            if ($definition->validateRuntime(self::RUNTIME_ALL)) {

                $this->appendConfig($config, $definition);

            } elseif ($this->isCliRuntime() && $definition->validateRuntime(self::RUNTIME_CONSOLE)) {

                $this->appendConfig($config, $definition);

            } elseif (!$this->isCliRuntime() && $definition->validateRuntime(self::RUNTIME_WEB)) {

                $this->appendConfig($config, $definition);

            }
        }

        return $config;
    }

    private function appendConfig(&$config, ConfigDefinition $definition)
    {
        switch ($definition->getGroup()) {
            case ConfigDefinition::GROUP_APPLICATIONS:
                foreach ($definition->getConfig() as $k => $v) {
                    $config[$k] = $v;
                }
                break;
            case ConfigDefinition::GROUP_COMPONENTS:
                if (!array_key_exists('components', $config)) {
                    $config['components'] = [];
                }
                $config['components'][$definition->getKey()] = $definition->getConfig();
                break;
            case ConfigDefinition::GROUP_MODULES:
                if (!array_key_exists('modules', $config)) {
                    $config['modules'] = [];
                }
                $config['modules'][$definition->getKey()] = $definition->getConfig();
                break;
        }
    }
}

1		<?php
2
3		namespace luya;
4
5		use luya\helpers\ArrayHelper;
6
7		use function Opis\Closure\serialize;
8
9		/**
10		* Configuration array Helper.
11		*
12		* The {{luya\Config}} allows you to create the configuration for different hosts and difference between web and console config.
13		*
14		* ```php
15		* $config = new Config('myapp', dirname(__DIR__), [
16		* 'siteTitle' => 'My LUYA Project',
17		* 'defaultRoute' => 'cms',
18		* // other application level configurations
19		* ]);
20		*
21		* // define global components which works either for console or web runtime
22		*
23		* $config->component('mail', [
24		* 'host' => 'xyz',
25		* 'from' => '[email protected]',
26		* ]);
27		*
28		* $config->component('db', [
29		* 'class' => 'yii\db\Connection',
30		* 'dsn' => 'mysql:host=localhost;dbname=prod_db',
31		* 'username' => 'foo',
32		* 'password' => 'bar',
33		* ])->env('martin');
34		*
35		*
36		*
37		* // define components which are only for web or console runtime:
38		*
39		* $config->webComponent('request', [
40		* 'cookieValidationKey' => 'xyz',
41		* ]);
42		*
43		* // which is equals to, but the above is better to read and structure in the config file
44		*
45		* $config->component('request', [
46		* 'cookieValidationKey' => 'xyz',
47		* ])->webRuntime();
48		*
49		* // adding modules
50		*
51		* $config->module('admin', [
52		* 'class' => 'luya\admin\Module',
53		* 'secureLogin' => true,
54		* ]);
55		*
56		* $config->module('cms', 'luya\cms\frontend\Module'); // which is equals to $config->module('cms', ['class' => 'luya\cms\frontend\Module']);
57		*
58		* // export and generate the config for a given enviroment or environment independent.
59		*
60		* return $config->toArray(); // returns the config not taking care of enviroment variables like prod, env
61		*
62		* return $config->toArray(Config::ENV_PROD);
63		* ```
64		*
65		* @author Basil Suter <[email protected]>
66		* @since 1.0.10
67		*/
68		class Config
69		{
70		const ENV_ALL = 'all';
71
72		const ENV_PROD = 'prod';
73
74		const ENV_PREP = 'prep';
75
76		const ENV_DEV = 'dev';
77
78		const ENV_LOCAL = 'local';
79
80		const RUNTIME_ALL = 0;
81
82		const RUNTIME_CONSOLE = 1;
83
84		const RUNTIME_WEB = 2;
85
86		public function __construct($id, $basePath, array $applicationConfig = [])
87		{
88		$applicationConfig['id'] = $id;
89		$applicationConfig['basePath'] = $basePath;
90
91		$this->application($applicationConfig);
92		}
93
94		/**
95		* Undocumented function
96		*
97		* @param [type] $config
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
98		* @return ConfigDefinition
99		*/
100		public function application($config)
101		{
102		return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_APPLICATIONS, md5(serialize($config)), $config));
103		}
104
105		/**
106		* Undocumented function
107		*
108		* @param [type] $id
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
109		* @param [type] $config
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
110		* @return ConfigDefinition
111		*/
112		public function module($id, $config)
113		{
114		return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_MODULES, $id, $config));
115		}
116
117		/**
118		* Undocumented function
119		*
120		* @param [type] $id
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
121		* @param [type] $config
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
122		* @param [type] $runtime
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
123		* @return ConfigDefinition
124		*/
125		public function component($id, $config, $runtime = self::RUNTIME_ALL)
126		{
127		return $this->addDefinition(new ConfigDefinition(ConfigDefinition::GROUP_COMPONENTS, $id, $config))->runtime($runtime);
128		}
129
130		/**
131		* Undocumented function
132		*
133		* @param [type] $id
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
134		* @param [type] $config
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
135		* @return ConfigDefinition
136		*/
137		public function webComponent($id, $config)
138		{
139		return $this->component($id, $config, self::RUNTIME_WEB);
140		}
141
142		/**
143		* Undocumented function
144		*
145		* @param [type] $id
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
146		* @param [type] $config
		0 ignored issues – show Documentation introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The doc-type `[type]` could not be parsed: Unknown type name "" at position 0. [(view supported doc-types) This check marks PHPDoc comments that could not be parsed by our parser. To see which comment annotations we can parse, please refer to our documentation on supported doc-types. Loading history...
147		* @return ConfigDefinition
148		*/
149		public function consoleComponent($id, $config)
150		{
151		return $this->component($id, $config, self::RUNTIME_CONSOLE);
152		}
153
154		private $_definitions = [];
155
156		/**
157		* Undocumented function
158		*
159		* @param ConfigDefinition $definition
160		* @return ConfigDefinition
161		*/
162		private function addDefinition(ConfigDefinition $definition)
163		{
164		$this->_definitions[] = $definition;
165
166		return $definition;
167		}
168
169		private $_isCliRuntime;
170
171		/**
172		* Whether runtime is cli or not
173		*
174		* @return boolean
175		*/
176		public function isCliRuntime()
177		{
178		if ($this->_isCliRuntime === null) {
179		$this->_isCliRuntime = strtolower(php_sapi_name()) === 'cli';
180		}
181
182		return $this->_isCliRuntime;
183		}
184
185		public function setCliRuntime($value)
186		{
187		$this->_isCliRuntime = $value;
188		}
189
190		public function toArray(array $envs = [self::ENV_ALL])
191		{
192		$config = [];
193
194		foreach ($this->_definitions as $defintion) {
195		/** @var ConfigDefinition $definition */
196
197		if (!$definition->validateEnvs($envs)) {
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
198		continue;
199		}
200
201		if ($definition->validateRuntime(self::RUNTIME_ALL)) {
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
202		$this->appendConfig($config, $definition);
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
203		} elseif ($this->isCliRuntime() && $definition->validateRuntime(self::RUNTIME_CONSOLE)) {
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
204		$this->appendConfig($config, $definition);
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
205		} elseif (!$this->isCliRuntime() && $definition->validateRuntime(self::RUNTIME_WEB)) {
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
206		$this->appendConfig($config, $definition);
		0 ignored issues – show Bug introduced 2019-08-27 09:51 UTC by Report Bug Copy Issue Report The variable `$definition` does not exist. Did you mean `$defintion`? This check looks for variables that are accessed but have not been defined. It raises an issue if it finds another variable that has a similar name. The variable may have been renamed without also renaming all references. Loading history...
207		}
208		}
209
210		return $config;
211		}
212
213		private function appendConfig(&$config, ConfigDefinition $definition)
214		{
215		switch ($definition->getGroup()) {
216		case ConfigDefinition::GROUP_APPLICATIONS:
217		foreach ($definition->getConfig() as $k => $v) {
218		$config[$k] = $v;
219		}
220		break;
221	View Code Duplication	case ConfigDefinition::GROUP_COMPONENTS:
222		if (!array_key_exists('components', $config)) {
223		$config['components'] = [];
224		}
225		$config['components'][$definition->getKey()] = $definition->getConfig();
226		break;
227	View Code Duplication	case ConfigDefinition::GROUP_MODULES:
228		if (!array_key_exists('modules', $config)) {
229		$config['modules'] = [];
230		}
231		$config['modules'][$definition->getKey()] = $definition->getConfig();
232		break;
233		}
234		}
235		}

luyadev / luya

Pull Request — master (#1952)

Config::setCliRuntime() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like