SiteAliasWithConfig::determineCorrectRuntimeConfig() - Code Metrics - Inspection of "Code cleanup" - consolidation/site-alias - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#32)

by Greg

created 2019-03-03 20:01 UTC

determineCorrectRuntimeConfig() A

↳ Parent: SiteAliasWithConfig

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	2

<?php
namespace Consolidation\SiteAlias;

use Consolidation\Config\Config;
use Consolidation\Config\ConfigInterface;
use Consolidation\Config\Util\ConfigRutimeInterface;
use Consolidation\SiteAlias\SiteAlias;
use Consolidation\SiteAlias\SiteAliasInterface;
use Consolidation\SiteAlias\SiteAliasTrait;

/**
 * SiteAliasWithConfig delegates to a site alias, and
 * also combines it with two config stores:
 *
 *   - Runtime config (set on commandline): Options that override site alias contents
 *   - Default config (set from config files): Default options
 */
class SiteAliasWithConfig implements SiteAliasInterface, ConfigRuntimeInterface
{
    use SiteAliasTrait;

    protected $runtimeConfig;
    protected $siteAlias;
    protected $defaultConfig;

    public function __construct(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
    {
        $this->siteAlias = $siteAlias;
        $this->defaultConfig = $defaultConfig;
        $this->runtimeConfig = $runtimeConfig;
    }

    /**
     * combine the provided site alias with configuration.
     *
     * @return SiteAlias read-only site alias combined with the runtime
     *   config (overrides the site alias values) and the default config.
     */
    public static function create(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig = null)
    {
        $runtimeConfig = static::determineCorrectRuntimeConfig($defaultConfig, $runtimeConfig);

        return new self($siteAlias, $defaultConfig, $runtimeConfig);
    }

    /**
     * Determine what object to use for the runtime config. If a specific
     * runtime config is given, use that. Otherwise, pull it from the default
     * configuration if available.
     */
    protected static function determineCorrectRuntimeConfig(ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
    {
        if ($runtimeConfig) {
            return $runtimeConfig;
        }

        if ($defaultConfig instanceof ConfigRutimeInterface) {
if ($x instanceof DoesNotExist) {
    // Do something.
}
            return $defaultConfig->runtimeConfig();
        }

        return new Config();
    }

    /**
     * @inheritdoc
     */
    public function runtimeConfig()
    {
        return $this->runtimeConfig;
    }

    /**
     * @inheritdoc
     */
    public function name()
    {
        return $this->siteAlias->name();
    }

    /**
     * @inheritdoc
     */
    public function has($key)
    {
        return
            $this->runtimeConfig->has($key) ||
            $this->siteAlias->has($key) ||
            $this->defaultConfig->has($key);
    }

    /**
     * @inheritdoc
     */
    public function get($key, $defaultFallback = null)
    {
        if ($this->runtimeConfig->has($key)) {
            return $this->runtimeConfig->get($key);
        }
        if ($this->siteAlias->has($key)) {
            return $this->siteAlias->get($key);
        }
        if ($this->defaultConfig->has($key)) {
            return $this->defaultConfig->get($key);
        }

        return $defaultFallback;
    }

    /**
     * @inheritdoc
     */
    public function set($key, $value)
    {
        $this->changesProhibited();
    }

    /**
     * @inheritdoc
     */
    public function import($data)
    {
        $this->changesProhibited();
    }

    /**
     * @inheritdoc
     */
    public function replace($data)
    {
        $this->changesProhibited();
    }

    /**
     * @inheritdoc
     */
    public function combine($data)
    {
        $this->changesProhibited();
    }

    /**
     * Export all configuration as a nested array.
     */
    public function export()
    {
        throw new \Exception('SiteAliasWithConfig::export() not supported.');
    }

    /**
     * @inheritdoc
     */
    public function hasDefault($key)
    {
        return false;
    }

    /**
     * @inheritdoc
     */
    public function getDefault($key, $defaultFallback = null)
    {
        return $defaultFallback;
    }

    /**
     * @inheritdoc
     */
    public function setDefault($key, $value)
    {
        $this->changesProhibited();
    }

    /**
     * @inheritdoc
     */
    public function exportConfig()
    {
        throw new \Exception('SiteAliasWithConfig::exportConfig() not supported.');
    }

    protected function changesProhibited()
    {
        throw new \Exception('Changing a SiteAliasWithConfig is not permitted.');
    }
}


1			<?php
2			namespace Consolidation\SiteAlias;
3
4			use Consolidation\Config\Config;
5			use Consolidation\Config\ConfigInterface;
6			use Consolidation\Config\Util\ConfigRutimeInterface;
7			use Consolidation\SiteAlias\SiteAlias;
8			use Consolidation\SiteAlias\SiteAliasInterface;
9			use Consolidation\SiteAlias\SiteAliasTrait;
10
11			/**
12			* SiteAliasWithConfig delegates to a site alias, and
13			* also combines it with two config stores:
14			*
15			* - Runtime config (set on commandline): Options that override site alias contents
16			* - Default config (set from config files): Default options
17			*/
18			class SiteAliasWithConfig implements SiteAliasInterface, ConfigRuntimeInterface
19			{
20			use SiteAliasTrait;
21
22			protected $runtimeConfig;
23			protected $siteAlias;
24			protected $defaultConfig;
25
26			public function __construct(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
27			{
28			$this->siteAlias = $siteAlias;
29			$this->defaultConfig = $defaultConfig;
30			$this->runtimeConfig = $runtimeConfig;
31			}
32
33			/**
34			* combine the provided site alias with configuration.
35			*
36			* @return SiteAlias read-only site alias combined with the runtime
37			* config (overrides the site alias values) and the default config.
38			*/
39			public static function create(SiteAliasInterface $siteAlias, ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig = null)
40			{
41			$runtimeConfig = static::determineCorrectRuntimeConfig($defaultConfig, $runtimeConfig);
42
43			return new self($siteAlias, $defaultConfig, $runtimeConfig);
44			}
45
46			/**
47			* Determine what object to use for the runtime config. If a specific
48			* runtime config is given, use that. Otherwise, pull it from the default
49			* configuration if available.
50			*/
51			protected static function determineCorrectRuntimeConfig(ConfigInterface $defaultConfig, ConfigInterface $runtimeConfig)
52			{
53			if ($runtimeConfig) {
54			return $runtimeConfig;
55			}
56
57			if ($defaultConfig instanceof ConfigRutimeInterface) {
			0 ignored issues – show Bug introduced 2019-03-03 19:54 UTC by Report Bug Copy Issue Report The class `Consolidation\Config\Util\ConfigRutimeInterface` does not exist. Did you forget a USE statement, or did you not list all dependencies? This error could be the result of: 1. Missing dependencies PHP Analyzer uses your `composer.json` file (if available) to determine the dependencies of your project and to determine all the available classes and functions. It expects the `composer.json` to be in the root folder of your repository. Are you sure this class is defined by one of your dependencies, or did you maybe not list a dependency in either the `require` or `require-dev` section? 2. Missing use statement PHP does not complain about undefined classes in `ìnstanceof` checks. For example, the following PHP code will work perfectly fine: if ($x instanceof DoesNotExist) { // Do something. } If you have not tested against this specific condition, such errors might go unnoticed. Loading history...
58			return $defaultConfig->runtimeConfig();
59			}
60
61			return new Config();
62			}
63
64			/**
65			* @inheritdoc
66			*/
67			public function runtimeConfig()
68			{
69			return $this->runtimeConfig;
70			}
71
72			/**
73			* @inheritdoc
74			*/
75			public function name()
76			{
77			return $this->siteAlias->name();
78			}
79
80			/**
81			* @inheritdoc
82			*/
83			public function has($key)
84			{
85			return
86			$this->runtimeConfig->has($key) \|\|
87			$this->siteAlias->has($key) \|\|
88			$this->defaultConfig->has($key);
89			}
90
91			/**
92			* @inheritdoc
93			*/
94			public function get($key, $defaultFallback = null)
95			{
96			if ($this->runtimeConfig->has($key)) {
97			return $this->runtimeConfig->get($key);
98			}
99			if ($this->siteAlias->has($key)) {
100			return $this->siteAlias->get($key);
101			}
102			if ($this->defaultConfig->has($key)) {
103			return $this->defaultConfig->get($key);
104			}
105
106			return $defaultFallback;
107			}
108
109			/**
110			* @inheritdoc
111			*/
112			public function set($key, $value)
113			{
114			$this->changesProhibited();
115			}
116
117			/**
118			* @inheritdoc
119			*/
120			public function import($data)
121			{
122			$this->changesProhibited();
123			}
124
125			/**
126			* @inheritdoc
127			*/
128			public function replace($data)
129			{
130			$this->changesProhibited();
131			}
132
133			/**
134			* @inheritdoc
135			*/
136			public function combine($data)
137			{
138			$this->changesProhibited();
139			}
140
141			/**
142			* Export all configuration as a nested array.
143			*/
144			public function export()
145			{
146			throw new \Exception('SiteAliasWithConfig::export() not supported.');
147			}
148
149			/**
150			* @inheritdoc
151			*/
152			public function hasDefault($key)
153			{
154			return false;
155			}
156
157			/**
158			* @inheritdoc
159			*/
160			public function getDefault($key, $defaultFallback = null)
161			{
162			return $defaultFallback;
163			}
164
165			/**
166			* @inheritdoc
167			*/
168			public function setDefault($key, $value)
169			{
170			$this->changesProhibited();
171			}
172
173			/**
174			* @inheritdoc
175			*/
176			public function exportConfig()
177			{
178			throw new \Exception('SiteAliasWithConfig::exportConfig() not supported.');
179			}
180
181			protected function changesProhibited()
182			{
183			throw new \Exception('Changing a SiteAliasWithConfig is not permitted.');
184			}
185			}
186

consolidation / site-alias

Pull Request — master (#32)

determineCorrectRuntimeConfig() A

Complexity

Size

Duplication

Importance

1. Missing dependencies

2. Missing use statement

Duplication Side-by-Side

Filter issues like