MemoryConfigCollection::create() - Code Metrics - Inspection of "API Throw user warning when using Config::inst()->..." - silverstripe/silverstripe-config - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#17)

by Robbie

created 2017-07-17 06:08 UTC

MemoryConfigCollection::create() A

↳ Parent: MemoryConfigCollection

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	4
ccs	0
cts	2
cp	0
rs	10
c	0
b	0
f	0
cc	1
eloc	2
nc	1
nop	0
crap	2

<?php

namespace SilverStripe\Config\Collections;

use SilverStripe\Config\MergeStrategy\Priority;
use SilverStripe\Config\Middleware\MiddlewareAware;
use SilverStripe\Config\Transformer\TransformerInterface;
use Serializable;

/**
 * Basic mutable config collection stored in memory
 */
class MemoryConfigCollection implements MutableConfigCollectionInterface, Serializable
{
    use MiddlewareAware;

    /**
     * Stores a list of key/value config prior to middleware being applied
     *
     * @var array
     */
    protected $config = [];

    /**
     * Call cache for non-trivial config calls including middleware
     *
     * @var array
     */
    protected $callCache = [];

    /**
     * @var array
     */
    protected $metadata = [];

    /**
     * @var array
     */
    protected $history = [];

    /**
     * @var boolean
     */
    protected $trackMetadata = false;

    /**
     * ConfigCollection constructor.
     *
     * @param bool $trackMetadata
     */
    public function __construct($trackMetadata = false)
    {
        $this->trackMetadata = $trackMetadata;
    }

    /**
     * @return static
     */
    public static function create()
    {
        return new static();
    }

    /**
     * Trigger transformers to load into this store
     *
     * @param  TransformerInterface[] $transformers
     * @return $this
     */
    public function transform($transformers)
    {
        foreach ($transformers as $transformer) {
            $transformer->transform($this);
        }
        return $this;
    }

    public function set($class, $name, $data, $metadata = [])
    {
        $class = strtolower($class);
        $this->saveMetadata($class, $metadata);

        if ($name) {
            if (!isset($this->config[$class])) {
                $this->config[$class] = [];
            }
            $this->config[$class][$name] = $data;
        } else {
            $this->config[$class] = $data;
        }

        // Flush call cache for this class, and any subclasses
        unset($this->callCache[$class]);
        foreach ($this->callCache as $nextClass => $data) {
            if (is_subclass_of($nextClass, $class, true)) {

                unset($this->callCache[$nextClass]);
            }
        }
        return $this;
    }

    public function get($class, $name = null, $excludeMiddleware = 0)
    {
        if (!is_int($excludeMiddleware) && $excludeMiddleware !== true) {
            throw new \InvalidArgumentException("Invalid middleware flags");
        }

        // Get config for complete class
        $class = strtolower($class);
        $config = $this->getClassConfig($class, $excludeMiddleware);

        // Return either name, or whole-class config
        if ($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return isset($config[$name]) ? $config[$name] : null;
        }
        return $config;
    }

    /**
     * Retrieve config for an entire class
     *
     * @param string $class Name of class
     * @param int|true $excludeMiddleware Optional flag of middleware to disable.
     * Passing in `true` disables all middleware.
     * Can also pass in int flags to specify specific middlewares.
     * @return array|null
     */
    protected function getClassConfig($class, $excludeMiddleware = 0)
    {
        $class = strtolower($class);

        // Can't apply middleware to config on non-existant class
        if (!isset($this->config[$class])) {
            return null;
        }

        // `true` excludes all middleware, so bypass call cache
        if ($excludeMiddleware === true) {
            return $this->config[$class];
        }

        // Check cache
        if (isset($this->callCache[$class][$excludeMiddleware])) {
            return $this->callCache[$class][$excludeMiddleware];
        }

        // Build middleware
        $result = $this->callMiddleware(
            $class, $excludeMiddleware, function ($class, $excludeMiddleware) {

                $class = strtolower($class);
                return isset($this->config[$class]) ? $this->config[$class] : [];
            }
        );

        // Save cache
        if (!isset($this->callCache[$class])) {
            $this->callCache[$class] = [];
        }
        $this->callCache[$class][$excludeMiddleware] = $result;
        return $result;
    }

    public function exists($class, $name = null, $excludeMiddleware = 0)
    {
        $config = $this->get($class, null, $excludeMiddleware);
        if (!isset($config)) {
            return false;
        }
        if ($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            return array_key_exists($name, $config);
        }
        return true;
    }

    public function remove($class, $name = null)
    {
        $class = strtolower($class);
        if ($name) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            unset($this->config[$class][$name]);
        } else {
            unset($this->config[$class]);
        }
        // Discard call cache
        unset($this->callCache[$class]);
        return $this;
    }

    public function removeAll()
    {
        $this->config = [];
        $this->metadata = [];
        $this->history = [];
        $this->callCache = [];
    }

    /**
     * Get complete config (excludes middleware-applied config)
     *
     * @return array
     */
    public function getAll()
    {
        return $this->config;
    }

    /**
     * @deprecated 4.0...5.0
     *
     * Synonym for merge()
     *
     * @param string $class
     * @param string $name
     * @param mixed  $value
     * @return $this
     */
    public function update($class, $name, $value)
    {
        user_error(
            'Config::inst()->update() is deprecated. Please use YAML configuration, Config::modify()->merge() or ->set()',
            E_USER_WARNING
        );
        $this->merge($class, $name, $value);
        return $this;
    }

    public function merge($class, $name, $value)
    {
        // Detect mergeable config
        $existing = $this->get($class, $name, true);
function acceptsInteger($int) { }

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

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        if (is_array($value) && is_array($existing)) {
            $value = Priority::mergeArray($value, $existing);
        }

        // Apply
        $this->set($class, $name, $value);
        return $this;
    }

    public function getMetadata()
    {
        if (!$this->trackMetadata || !is_array($this->metadata)) {
            return [];
        }

        return $this->metadata;
    }

    public function getHistory()
    {
        if (!$this->trackMetadata || !is_array($this->history)) {
            return [];
        }

        return $this->history;
    }

    public function serialize()
    {
        return serialize([
            $this->config,
            $this->history,
            $this->metadata,
            $this->trackMetadata,
            $this->middlewares,
            $this->callCache
        ]);

    }

    public function unserialize($serialized)
    {
        list(
            $this->config,
            $this->history,
            $this->metadata,
            $this->trackMetadata,
            $this->middlewares,
            $this->callCache
        ) = unserialize($serialized);
    }

    public function nest()
    {
        return clone $this;
    }

    /**
     * Save metadata for the given class
     *
     * @param string $class
     * @param array  $metadata
     */
    protected function saveMetadata($class, $metadata)
    {
        if (!$this->trackMetadata) {
            return;
        }

        if (isset($this->metadata[$class]) && isset($this->config[$class])) {
            if (!isset($this->history[$class])) {
                $this->history[$class] = [];
            }

            array_unshift(
                $this->history[$class], [
                'value' => $this->config[$class],
                'metadata' => $this->metadata[$class]
                ]
            );
        }

        $this->metadata[$class] = $metadata;
    }
}


1		<?php
2
3		namespace SilverStripe\Config\Collections;
4
5		use SilverStripe\Config\MergeStrategy\Priority;
6		use SilverStripe\Config\Middleware\MiddlewareAware;
7		use SilverStripe\Config\Transformer\TransformerInterface;
8		use Serializable;
9
10		/**
11		* Basic mutable config collection stored in memory
12		*/
13		class MemoryConfigCollection implements MutableConfigCollectionInterface, Serializable
14		{
15		use MiddlewareAware;
16
17		/**
18		* Stores a list of key/value config prior to middleware being applied
19		*
20		* @var array
21		*/
22		protected $config = [];
23
24		/**
25		* Call cache for non-trivial config calls including middleware
26		*
27		* @var array
28		*/
29		protected $callCache = [];
30
31		/**
32		* @var array
33		*/
34		protected $metadata = [];
35
36		/**
37		* @var array
38		*/
39		protected $history = [];
40
41		/**
42		* @var boolean
43		*/
44		protected $trackMetadata = false;
45
46		/**
47		* ConfigCollection constructor.
48		*
49		* @param bool $trackMetadata
50		*/
51	25	public function __construct($trackMetadata = false)
52		{
53	25	$this->trackMetadata = $trackMetadata;
54	25	}
55
56		/**
57		* @return static
58		*/
59		public static function create()
60		{
61		return new static();
62		}
63
64		/**
65		* Trigger transformers to load into this store
66		*
67		* @param TransformerInterface[] $transformers
68		* @return $this
69		*/
70	16	public function transform($transformers)
71		{
72	16	foreach ($transformers as $transformer) {
73	16	$transformer->transform($this);
74	15	}
75	15	return $this;
76		}
77
78	22	public function set($class, $name, $data, $metadata = [])
79		{
80	22	$class = strtolower($class);
81	22	$this->saveMetadata($class, $metadata);
82
83	22	if ($name) {
84	6	if (!isset($this->config[$class])) {
85	6	$this->config[$class] = [];
86	6	}
87	6	$this->config[$class][$name] = $data;
88	6	} else {
89	22	$this->config[$class] = $data;
90		}
91
92		// Flush call cache for this class, and any subclasses
93	22	unset($this->callCache[$class]);
94	22	foreach ($this->callCache as $nextClass => $data) {
95	1	if (is_subclass_of($nextClass, $class, true)) {
		0 ignored issues – show Bug introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report Due to PHP Bug #53727, `is_subclass_of` might return inconsistent results on some PHP versions if `$class` can be an interface. If so, you could instead use `ReflectionClass::implementsInterface`. Loading history...
96		unset($this->callCache[$nextClass]);
97		}
98	22	}
99	22	return $this;
100		}
101
102	23	public function get($class, $name = null, $excludeMiddleware = 0)
103		{
104	23	if (!is_int($excludeMiddleware) && $excludeMiddleware !== true) {
105		throw new \InvalidArgumentException("Invalid middleware flags");
106		}
107
108		// Get config for complete class
109	23	$class = strtolower($class);
110	23	$config = $this->getClassConfig($class, $excludeMiddleware);
111
112		// Return either name, or whole-class config
113	23	if ($name) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
114	6	return isset($config[$name]) ? $config[$name] : null;
115		}
116	23	return $config;
117		}
118
119		/**
120		* Retrieve config for an entire class
121		*
122		* @param string $class Name of class
123		* @param int\|true $excludeMiddleware Optional flag of middleware to disable.
124		* Passing in `true` disables all middleware.
125		* Can also pass in int flags to specify specific middlewares.
126		* @return array\|null
127		*/
128	23	protected function getClassConfig($class, $excludeMiddleware = 0)
129		{
130	23	$class = strtolower($class);
131
132		// Can't apply middleware to config on non-existant class
133	23	if (!isset($this->config[$class])) {
134	13	return null;
135		}
136
137		// `true` excludes all middleware, so bypass call cache
138	22	if ($excludeMiddleware === true) {
139	12	return $this->config[$class];
140		}
141
142		// Check cache
143	22	if (isset($this->callCache[$class][$excludeMiddleware])) {
144	1	return $this->callCache[$class][$excludeMiddleware];
145		}
146
147		// Build middleware
148	22	$result = $this->callMiddleware(
149	22	$class, $excludeMiddleware, function ($class, $excludeMiddleware) {
		0 ignored issues – show Unused Code introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report The parameter `$excludeMiddleware` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
150	22	$class = strtolower($class);
151	22	return isset($this->config[$class]) ? $this->config[$class] : [];
152		}
153	22	);
154
155		// Save cache
156	22	if (!isset($this->callCache[$class])) {
157	22	$this->callCache[$class] = [];
158	22	}
159	22	$this->callCache[$class][$excludeMiddleware] = $result;
160	22	return $result;
161		}
162
163	2	public function exists($class, $name = null, $excludeMiddleware = 0)
164		{
165	2	$config = $this->get($class, null, $excludeMiddleware);
166	2	if (!isset($config)) {
167	2	return false;
168		}
169	1	if ($name) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
170		return array_key_exists($name, $config);
171		}
172	1	return true;
173		}
174
175	1	public function remove($class, $name = null)
176		{
177	1	$class = strtolower($class);
178	1	if ($name) {
		0 ignored issues – show Bug Best Practice introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report The expression `$name` of type `string\|null` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
179		unset($this->config[$class][$name]);
180		} else {
181	1	unset($this->config[$class]);
182		}
183		// Discard call cache
184	1	unset($this->callCache[$class]);
185	1	return $this;
186		}
187
188	1	public function removeAll()
189		{
190	1	$this->config = [];
191	1	$this->metadata = [];
192	1	$this->history = [];
193	1	$this->callCache = [];
194	1	}
195
196		/**
197		* Get complete config (excludes middleware-applied config)
198		*
199		* @return array
200		*/
201		public function getAll()
202		{
203		return $this->config;
204		}
205
206		/**
207		* @deprecated 4.0...5.0
208		*
209		* Synonym for merge()
210		*
211		* @param string $class
212		* @param string $name
213		* @param mixed $value
214		* @return $this
215		*/
216		public function update($class, $name, $value)
217		{
218		user_error(
219		'Config::inst()->update() is deprecated. Please use YAML configuration, Config::modify()->merge() or ->set()',
220		E_USER_WARNING
221		);
222		$this->merge($class, $name, $value);
223		return $this;
224		}
225
226		public function merge($class, $name, $value)
227		{
228		// Detect mergeable config
229		$existing = $this->get($class, $name, true);
		0 ignored issues – show Documentation introduced 2017-04-10 22:07 UTC by Report Bug Copy Issue Report `true` is of type `boolean`, but the function expects a `integer`. 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...
230		if (is_array($value) && is_array($existing)) {
231		$value = Priority::mergeArray($value, $existing);
232		}
233
234		// Apply
235		$this->set($class, $name, $value);
236		return $this;
237		}
238
239	8	public function getMetadata()
240		{
241	8	if (!$this->trackMetadata \|\| !is_array($this->metadata)) {
242	7	return [];
243		}
244
245	1	return $this->metadata;
246		}
247
248	2	public function getHistory()
249		{
250	2	if (!$this->trackMetadata \|\| !is_array($this->history)) {
251	1	return [];
252		}
253
254	1	return $this->history;
255		}
256
257		public function serialize()
258		{
259		return serialize([
260		$this->config,
261		$this->history,
262		$this->metadata,
263		$this->trackMetadata,
264		$this->middlewares,
265		$this->callCache
266		]);
267
268		}
269
270		public function unserialize($serialized)
271		{
272		list(
273		$this->config,
274		$this->history,
275		$this->metadata,
276		$this->trackMetadata,
277		$this->middlewares,
278		$this->callCache
279		) = unserialize($serialized);
280		}
281
282		public function nest()
283		{
284		return clone $this;
285		}
286
287		/**
288		* Save metadata for the given class
289		*
290		* @param string $class
291		* @param array $metadata
292		*/
293	22	protected function saveMetadata($class, $metadata)
294		{
295	22	if (!$this->trackMetadata) {
296	21	return;
297		}
298
299	1	if (isset($this->metadata[$class]) && isset($this->config[$class])) {
300	1	if (!isset($this->history[$class])) {
301	1	$this->history[$class] = [];
302	1	}
303
304	1	array_unshift(
305	1	$this->history[$class], [
306	1	'value' => $this->config[$class],
307	1	'metadata' => $this->metadata[$class]
308	1	]
309	1	);
310	1	}
311
312	1	$this->metadata[$class] = $metadata;
313	1	}
314		}
315

silverstripe / silverstripe-config

Pull Request — master (#17)

MemoryConfigCollection::create() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like