CachedConfigCollection::getCollectionCreator() - Code Metrics - Inspection of "Merge pull request #17 from robbieaverill/pulls/1...." - silverstripe/silverstripe-config - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( d49acb...a0b4b8 )

by Damian

created 2017-07-17 21:49 UTC

CachedConfigCollection::getCollectionCreator() A

↳ Parent: CachedConfigCollection

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 BadMethodCallException;
use Psr\SimpleCache\CacheInterface;
use SilverStripe\Config\Middleware\MiddlewareAware;

class CachedConfigCollection implements ConfigCollectionInterface
{
    use MiddlewareAware;

    /**
     * @const string
     */
    const CACHE_KEY = '__CACHE__';

    /**
     * @var CacheInterface
     */
    protected $cache;

    /**
     * Nested config to delegate to
     *
     * @var ConfigCollectionInterface
     */
    protected $collection;

    /**
     * @var callable
     */
    protected $collectionCreator;

    /**
     * @var bool
     */
    protected $flush = false;

    /**
     * Set to true while building config.
     * Used to protect against infinite loops.
     *
     * @var bool
     */
    protected $building = false;

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

    public function get($class, $name = null, $excludeMiddleware = 0)
    {
        return $this->getCollection()->get($class, $name, $excludeMiddleware);
    }

    public function getAll()
    {
        return $this->getCollection()->getAll();
    }

    public function exists($class, $name = null, $excludeMiddleware = 0)
    {
        return $this->getCollection()->exists($class, $name, $excludeMiddleware);
    }

    public function getMetadata()
    {
        return $this->getCollection()->getMetadata();
    }

    public function getHistory()
    {
        return $this->getCollection()->getHistory();
    }

    /**
     * Get or build collection
     *
     * @return ConfigCollectionInterface
     */
    public function getCollection()
    {
        // Get current collection
        if ($this->collection) {
            return $this->collection;
        }

        // Load from cache (unless flushing)
        if (!$this->flush) {
            $this->collection = $this->cache->get(self::CACHE_KEY);
            if ($this->collection) {
                return $this->collection;
            }
        }

        // Protect against infinity loop
        if ($this->building) {
            throw new BadMethodCallException("Infinite loop detected. Config could not be bootstrapped.");
        }
        $this->building = true;

        // Cache missed
        try {
            $this->collection = call_user_func($this->collectionCreator);
        } finally {
            $this->building = false;
        }

        // Save immediately.
        // Note additional deferred save will occur in _destruct()
        $this->cache->set(self::CACHE_KEY, $this->collection);
        return $this->collection;
    }

    /**
     * Commits the cache
     */
    public function __destruct()
    {
        // Ensure back-end cache is updated
        if ($this->collection) {
            $this->cache->set(self::CACHE_KEY, $this->collection);

            // Prevent double-destruct
            $this->collection = null;
        }
    }

    public function nest()
    {
        return $this->getCollection()->nest();
    }

    /**
     * Set a PSR-16 cache
     *
     * @param CacheInterface $cache
     * @return $this
     */
    public function setCache(CacheInterface $cache)
    {
        $this->cache = $cache;
        if ($this->flush) {
            $cache->clear();
        }
        return $this;
    }

    /**
     * @param callable $collectionCreator
     * @return $this
     */
    public function setCollectionCreator($collectionCreator)
    {
        $this->collectionCreator = $collectionCreator;
        return $this;
    }

    /**
     * @return callable
     */
    public function getCollectionCreator()
    {
        return $this->collectionCreator;
    }

    /**
     * @return CacheInterface
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * @param bool $flush
     * @return $this
     */
    public function setFlush($flush)
    {
        $this->flush = $flush;
        if ($flush && $this->cache) {
            $this->cache->clear();
        }
        return $this;
    }

    /**
     * @return bool
     */
    public function getFlush()
    {
        return $this->flush;
    }

    public function setMiddlewares($middlewares)
    {
        throw new BadMethodCallException(
            "Please apply middleware to collection factory via setCollectionCreator()"
        );
    }

    /**
     * @deprecated 4.0...5.0 Please use YAML configuration, ::modify()->set() or ::modify()->merge()
     * @throws BadMethodCallException
     */
    public function update($class, $name, $value)

    {
        throw new BadMethodCallException(
            'Config::inst()->update() is deprecated. Please use YAML configuration, Config::modify()->merge() or ->set()'
        );
    }
}


1		<?php
2
3		namespace SilverStripe\Config\Collections;
4
5		use BadMethodCallException;
6		use Psr\SimpleCache\CacheInterface;
7		use SilverStripe\Config\Middleware\MiddlewareAware;
8
9		class CachedConfigCollection implements ConfigCollectionInterface
10		{
11		use MiddlewareAware;
12
13		/**
14		* @const string
15		*/
16		const CACHE_KEY = '__CACHE__';
17
18		/**
19		* @var CacheInterface
20		*/
21		protected $cache;
22
23		/**
24		* Nested config to delegate to
25		*
26		* @var ConfigCollectionInterface
27		*/
28		protected $collection;
29
30		/**
31		* @var callable
32		*/
33		protected $collectionCreator;
34
35		/**
36		* @var bool
37		*/
38		protected $flush = false;
39
40		/**
41		* Set to true while building config.
42		* Used to protect against infinite loops.
43		*
44		* @var bool
45		*/
46		protected $building = false;
47
48		/**
49		* @return static
50		*/
51		public static function create()
52		{
53		return new static();
54		}
55
56	2	public function get($class, $name = null, $excludeMiddleware = 0)
57		{
58	2	return $this->getCollection()->get($class, $name, $excludeMiddleware);
59		}
60
61		public function getAll()
62		{
63		return $this->getCollection()->getAll();
64		}
65
66	2	public function exists($class, $name = null, $excludeMiddleware = 0)
67		{
68	2	return $this->getCollection()->exists($class, $name, $excludeMiddleware);
69		}
70
71		public function getMetadata()
72		{
73		return $this->getCollection()->getMetadata();
74		}
75
76		public function getHistory()
77		{
78		return $this->getCollection()->getHistory();
79		}
80
81		/**
82		* Get or build collection
83		*
84		* @return ConfigCollectionInterface
85		*/
86	3	public function getCollection()
87		{
88		// Get current collection
89	3	if ($this->collection) {
90	2	return $this->collection;
91		}
92
93		// Load from cache (unless flushing)
94	3	if (!$this->flush) {
95	3	$this->collection = $this->cache->get(self::CACHE_KEY);
96	3	if ($this->collection) {
97	1	return $this->collection;
98		}
99	2	}
100
101		// Protect against infinity loop
102	2	if ($this->building) {
103	1	throw new BadMethodCallException("Infinite loop detected. Config could not be bootstrapped.");
104		}
105	2	$this->building = true;
106
107		// Cache missed
108		try {
109	2	$this->collection = call_user_func($this->collectionCreator);
110	1	} finally {
111	2	$this->building = false;
112	2	}
113
114		// Save immediately.
115		// Note additional deferred save will occur in _destruct()
116	1	$this->cache->set(self::CACHE_KEY, $this->collection);
117	1	return $this->collection;
118		}
119
120		/**
121		* Commits the cache
122		*/
123	2	public function __destruct()
124		{
125		// Ensure back-end cache is updated
126	2	if ($this->collection) {
127	2	$this->cache->set(self::CACHE_KEY, $this->collection);
128
129		// Prevent double-destruct
130	2	$this->collection = null;
131	2	}
132	2	}
133
134		public function nest()
135		{
136		return $this->getCollection()->nest();
137		}
138
139		/**
140		* Set a PSR-16 cache
141		*
142		* @param CacheInterface $cache
143		* @return $this
144		*/
145	3	public function setCache(CacheInterface $cache)
146		{
147	3	$this->cache = $cache;
148	3	if ($this->flush) {
149		$cache->clear();
150		}
151	3	return $this;
152		}
153
154		/**
155		* @param callable $collectionCreator
156		* @return $this
157		*/
158	3	public function setCollectionCreator($collectionCreator)
159		{
160	3	$this->collectionCreator = $collectionCreator;
161	3	return $this;
162		}
163
164		/**
165		* @return callable
166		*/
167		public function getCollectionCreator()
168		{
169		return $this->collectionCreator;
170		}
171
172		/**
173		* @return CacheInterface
174		*/
175		public function getCache()
176		{
177		return $this->cache;
178		}
179
180		/**
181		* @param bool $flush
182		* @return $this
183		*/
184		public function setFlush($flush)
185		{
186		$this->flush = $flush;
187		if ($flush && $this->cache) {
188		$this->cache->clear();
189		}
190		return $this;
191		}
192
193		/**
194		* @return bool
195		*/
196		public function getFlush()
197		{
198		return $this->flush;
199		}
200
201		public function setMiddlewares($middlewares)
202		{
203		throw new BadMethodCallException(
204		"Please apply middleware to collection factory via setCollectionCreator()"
205		);
206		}
207
208		/**
209		* @deprecated 4.0...5.0 Please use YAML configuration, ::modify()->set() or ::modify()->merge()
210		* @throws BadMethodCallException
211		*/
212		public function update($class, $name, $value)
		0 ignored issues – show Unused Code introduced 2017-07-17 21:41 UTC by Report Bug Copy Issue Report The parameter `$class` 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... Unused Code introduced 2017-07-17 21:41 UTC by Report Bug Copy Issue Report The parameter `$name` 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... Unused Code introduced 2017-07-17 21:41 UTC by Report Bug Copy Issue Report The parameter `$value` 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...
213		{
214		throw new BadMethodCallException(
215		'Config::inst()->update() is deprecated. Please use YAML configuration, Config::modify()->merge() or ->set()'
216		);
217		}
218		}
219

silverstripe / silverstripe-config

Push — master ( d49acb...a0b4b8 )

CachedConfigCollection::getCollectionCreator() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like