Space::replacePlaceholders() - Code Metrics - Inspection of "create a dedicate Config class as the data wrapper" - theiconic/config - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( d7ccd4...e440d3 )

by Andre

created 2017-05-26 03:48 UTC

Space::replacePlaceholders() B

↳ Parent: Project

Complexity

Conditions	5
Paths	5

Size

Total Lines	19
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	19
rs	8.8571
c	0
b	0
f	0
cc	5
eloc	10
nc	5
nop	1

<?php

namespace TheIconic\Config;

use TheIconic\Config\Exception\ParserException;
use TheIconic\Config\Exception\PreconditionException;
use TheIconic\Config\Parser\AbstractParser;
use TheIconic\Config\Parser\Autodetect as Parser;

/**
 * handler for shared application config
 *
 * @package Shared\Helper
 */
class Space
{
    /**
     * @var Config
     */
    protected $config;

    /**
     * @var array the config file paths
     */
    protected $paths = [];

    /**
     * @var Cache the config cache handler
     */
    protected $cache;

    /**
     * @var string
     */
    protected $cachePath;

    /**
     * @var array the sections to use
     */
    protected $sections = [];

    /**
     * @var AbstractParser $parser
     */
    protected $parser;

    /**
     * @var string the config namespace
     */
    protected $name;

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

    /**
     * Space constructor.
     * @param $name
     */
    public function __construct($name)
    {
        $this->name = $name;
    }

    /**
     * @param null $key
     * @param null $default
     * @return array|mixed|null
     */
    public function get($key = null, $default = null)
    {
        $this->init();

        return $this->config->get($key, $default);
    }

    /**
     * @return array
     */
    public function flatten()
    {
        $this->init();

        return $this->config->flatten();
    }

    /**
     * initialize the config space
     *
     * loads the config from cache or the config files
     */
    protected function init()
    {
        if (null !== $this->config) {
            return;
        }

        $cache = $this->getCache();
        $cacheKey = $this->getCacheKey();

        if ($cache->isValid($cacheKey, $this->getTimestamp())) {
            $config = $cache->read($cacheKey);
        } else {
            $config = $this->parse();
            $cache->write($cacheKey, $config, $this->getPaths());
        }

        $this->config = new Config($config);
    }

    /**
     * parses the configs
     *
     * @return array the parsed and flattened config array
     */
    protected function parse()
    {
        $parser = $this->getParser();

        $config = [];
        foreach ($this->getReadableSources() as $path) {
            try {
                $config = $this->merge($config, $this->replacePlaceholders($parser->parse($path)));
            } catch (ParserException $e) {
                // ignore parse errors
            }
        }

        return $this->flattenSections($config);
    }

    /**
     * @param array $config
     * @return array
     */
    protected function replacePlaceholders(array $config)
    {
        if (empty($this->placeholders)) {
            return $config;
        }

        foreach ($config as $key => $value) {
            if (is_array($value)) {
                $config[$key] = $this->replacePlaceholders($value);
                continue;
            }

            if (is_string($value)) {
                $config[$key] = strtr($value, $this->placeholders);
            }
        }

        return $config;
    }

    /**
     * @return int
     */
    protected function getTimestamp()
    {
        $timestamp = 0;
        foreach ($this->getReadableSources() as $path) {
            $timestamp = max($timestamp, filemtime($path));
            $timestamp = max($timestamp, filemtime(dirname($path)));
        }

        return $timestamp;
    }
    
    /**
     * get the actually readable source paths
     *
     * @return array
     */
    protected function getReadableSources()
    {
        $paths = [];

        foreach ($this->getPaths() as $path) {
            if (is_readable($path)) {
                $paths[] = $path;
            }
        }

        return $paths;
    }

    /**
     * flattens the config array for the given environment
     *
     * @param array $config the raw config array
     * @return array the flattened config array
     */
    protected function flattenSections(array $config)
    {
        $merged = [];

        $sections = $this->getSections();

        if (empty($sections)) {
            throw new PreconditionException('No sections have been configured.');
        }

        foreach (array_unique($this->getSections()) as $section) {
            $section = strtolower($section);

            if (!isset($config[$section])) {
                continue;
            }

            $merged = $this->merge($merged, $config[$section]);
        }

        return $merged;
    }
    
    /**
     * get the config cache handler
     *
     * @return Cache
     */
    public function getCache()
    {
        return $this->cache;
    }

    /**
     * set the config cache handler
     *
     * @param Cache $cache
     * @return $this
     */
    public function setCache(Cache $cache)
    {
        $this->cache = $cache;

        return $this;
    }

    /**
     * get the environment
     *
     * @return array
     */
    public function getSections()
    {
        return $this->sections;
    }

    /**
     * set the sections to use
     *
     * @param array $sections
     * @return $this
     */
    public function setSections(array $sections)
    {
        $this->sections = $sections;

        return $this;
    }

    /**
     * @param string $section
     * @return $this
     */
    public function addSection(string $section)
    {
        if (!in_array($section, $this->sections)) {
            $this->sections[] = $section;
        }

        return $this;
    }

    /**
     * get the parser
     *
     * @return Parser
     */
    public function getParser()
    {
        if (null === $this->parser) {
            $this->parser = new Parser();
        }

        return $this->parser;
    }

    /**
     * set the parser
     *
     * @param AbstractParser $parser
     * @return $this
     */
    public function setParser(AbstractParser $parser)
    {
        $this->parser = $parser;

        return $this;
    }

    /**
     * get configuration file paths
     *
     * @return array an array of configuration file paths
     */
    public function getPaths(): array
    {
        return $this->paths;
    }

    /**
     * @param array $paths
     * @return Space
     */
    public function setPaths(array $paths): Space
    {
        $this->paths = $paths;

        return $this;
    }

    /**
     * @param string $path
     * @return Space
     */
    public function addPath($path): Space
    {
        if (!in_array($path, $this->paths)) {
            $this->paths[] = $path;
        }

        return $this;
    }

    /**
     * get the path to the cache config file for the current environment
     *
     * @return string the file path
     */
    protected function getCacheKey()
    {
        return strtolower(md5(sprintf('%s_%s', implode('::', $this->getPaths()), implode('::', $this->getSections()))));
    }

    /**
     * recursively merges the arrays
     * later keys overload earlier keys
     * numeric keys are appended
     *
     * @param array $base
     * @param array $subject
     *
     * @return array the result of the merge
     */
    protected function merge(array $base, array $subject): array
    {
        foreach ($subject as $k => $v) {
            if (is_numeric($k)) {
                $base[] = $v;
            } elseif (array_key_exists($k, $base) && (is_array($v) || is_array($base[$k]))) {
                $base[$k] = $this->merge((array) $base[$k], (array) $v);
            } else {
                $base[$k] = $v;
            }
        }

        return $base;
    }

    /**
     * @return array
     */
    public function getPlaceholders()
    {
        return $this->placeholders;
    }

    /**
     * @param array $placeholders
     * @return $this
     */
    public function setPlaceholders(array $placeholders)
    {
        $this->placeholders = $placeholders;

        return $this;
    }

    /**
     * @param $placeholder
     * @param $value
     */
    public function addPlaceholder($placeholder, $value)
    {
        $this->placeholders[$placeholder] = $value;
    }
}


1			<?php
2
3			namespace TheIconic\Config;
4
5			use TheIconic\Config\Exception\ParserException;
6			use TheIconic\Config\Exception\PreconditionException;
7			use TheIconic\Config\Parser\AbstractParser;
8			use TheIconic\Config\Parser\Autodetect as Parser;
9
10			/**
11			* handler for shared application config
12			*
13			* @package Shared\Helper
14			*/
15			class Space
16			{
17			/**
18			* @var Config
19			*/
20			protected $config;
21
22			/**
23			* @var array the config file paths
24			*/
25			protected $paths = [];
26
27			/**
28			* @var Cache the config cache handler
29			*/
30			protected $cache;
31
32			/**
33			* @var string
34			*/
35			protected $cachePath;
36
37			/**
38			* @var array the sections to use
39			*/
40			protected $sections = [];
41
42			/**
43			* @var AbstractParser $parser
44			*/
45			protected $parser;
46
47			/**
48			* @var string the config namespace
49			*/
50			protected $name;
51
52			/**
53			* @var array placeholders
54			*/
55			protected $placeholders = [];
56
57			/**
58			* Space constructor.
59			* @param $name
60			*/
61			public function __construct($name)
62			{
63			$this->name = $name;
64			}
65
66			/**
67			* @param null $key
68			* @param null $default
69			* @return array\|mixed\|null
70			*/
71			public function get($key = null, $default = null)
72			{
73			$this->init();
74
75			return $this->config->get($key, $default);
76			}
77
78			/**
79			* @return array
80			*/
81			public function flatten()
82			{
83			$this->init();
84
85			return $this->config->flatten();
86			}
87
88			/**
89			* initialize the config space
90			*
91			* loads the config from cache or the config files
92			*/
93			protected function init()
94			{
95			if (null !== $this->config) {
96			return;
97			}
98
99			$cache = $this->getCache();
100			$cacheKey = $this->getCacheKey();
101
102			if ($cache->isValid($cacheKey, $this->getTimestamp())) {
103			$config = $cache->read($cacheKey);
104			} else {
105			$config = $this->parse();
106			$cache->write($cacheKey, $config, $this->getPaths());
107			}
108
109			$this->config = new Config($config);
110			}
111
112			/**
113			* parses the configs
114			*
115			* @return array the parsed and flattened config array
116			*/
117			protected function parse()
118			{
119			$parser = $this->getParser();
120
121			$config = [];
122			foreach ($this->getReadableSources() as $path) {
123			try {
124			$config = $this->merge($config, $this->replacePlaceholders($parser->parse($path)));
125			} catch (ParserException $e) {
126			// ignore parse errors
127			}
128			}
129
130			return $this->flattenSections($config);
131			}
132
133			/**
134			* @param array $config
135			* @return array
136			*/
137			protected function replacePlaceholders(array $config)
138			{
139			if (empty($this->placeholders)) {
140			return $config;
141			}
142
143			foreach ($config as $key => $value) {
144			if (is_array($value)) {
145			$config[$key] = $this->replacePlaceholders($value);
146			continue;
147			}
148
149			if (is_string($value)) {
150			$config[$key] = strtr($value, $this->placeholders);
151			}
152			}
153
154			return $config;
155			}
156
157			/**
158			* @return int
159			*/
160			protected function getTimestamp()
161			{
162			$timestamp = 0;
163			foreach ($this->getReadableSources() as $path) {
164			$timestamp = max($timestamp, filemtime($path));
165			$timestamp = max($timestamp, filemtime(dirname($path)));
166			}
167
168			return $timestamp;
169			}
170
171			/**
172			* get the actually readable source paths
173			*
174			* @return array
175			*/
176			protected function getReadableSources()
177			{
178			$paths = [];
179
180			foreach ($this->getPaths() as $path) {
181			if (is_readable($path)) {
182			$paths[] = $path;
183			}
184			}
185
186			return $paths;
187			}
188
189			/**
190			* flattens the config array for the given environment
191			*
192			* @param array $config the raw config array
193			* @return array the flattened config array
194			*/
195			protected function flattenSections(array $config)
196			{
197			$merged = [];
198
199			$sections = $this->getSections();
200
201			if (empty($sections)) {
202			throw new PreconditionException('No sections have been configured.');
203			}
204
205			foreach (array_unique($this->getSections()) as $section) {
206			$section = strtolower($section);
207
208			if (!isset($config[$section])) {
209			continue;
210			}
211
212			$merged = $this->merge($merged, $config[$section]);
213			}
214
215			return $merged;
216			}
217
218			/**
219			* get the config cache handler
220			*
221			* @return Cache
222			*/
223			public function getCache()
224			{
225			return $this->cache;
226			}
227
228			/**
229			* set the config cache handler
230			*
231			* @param Cache $cache
232			* @return $this
233			*/
234			public function setCache(Cache $cache)
235			{
236			$this->cache = $cache;
237
238			return $this;
239			}
240
241			/**
242			* get the environment
243			*
244			* @return array
245			*/
246			public function getSections()
247			{
248			return $this->sections;
249			}
250
251			/**
252			* set the sections to use
253			*
254			* @param array $sections
255			* @return $this
256			*/
257			public function setSections(array $sections)
258			{
259			$this->sections = $sections;
260
261			return $this;
262			}
263
264			/**
265			* @param string $section
266			* @return $this
267			*/
268			public function addSection(string $section)
269			{
270			if (!in_array($section, $this->sections)) {
271			$this->sections[] = $section;
272			}
273
274			return $this;
275			}
276
277			/**
278			* get the parser
279			*
280			* @return Parser
281			*/
282			public function getParser()
283			{
284			if (null === $this->parser) {
285			$this->parser = new Parser();
286			}
287
288			return $this->parser;
289			}
290
291			/**
292			* set the parser
293			*
294			* @param AbstractParser $parser
295			* @return $this
296			*/
297			public function setParser(AbstractParser $parser)
298			{
299			$this->parser = $parser;
300
301			return $this;
302			}
303
304			/**
305			* get configuration file paths
306			*
307			* @return array an array of configuration file paths
308			*/
309			public function getPaths(): array
310			{
311			return $this->paths;
312			}
313
314			/**
315			* @param array $paths
316			* @return Space
317			*/
318			public function setPaths(array $paths): Space
319			{
320			$this->paths = $paths;
321
322			return $this;
323			}
324
325			/**
326			* @param string $path
327			* @return Space
328			*/
329			public function addPath($path): Space
330			{
331			if (!in_array($path, $this->paths)) {
332			$this->paths[] = $path;
333			}
334
335			return $this;
336			}
337
338			/**
339			* get the path to the cache config file for the current environment
340			*
341			* @return string the file path
342			*/
343			protected function getCacheKey()
344			{
345			return strtolower(md5(sprintf('%s_%s', implode('::', $this->getPaths()), implode('::', $this->getSections()))));
346			}
347
348			/**
349			* recursively merges the arrays
350			* later keys overload earlier keys
351			* numeric keys are appended
352			*
353			* @param array $base
354			* @param array $subject
355			*
356			* @return array the result of the merge
357			*/
358			protected function merge(array $base, array $subject): array
359			{
360			foreach ($subject as $k => $v) {
361			if (is_numeric($k)) {
362			$base[] = $v;
363			} elseif (array_key_exists($k, $base) && (is_array($v) \|\| is_array($base[$k]))) {
364			$base[$k] = $this->merge((array) $base[$k], (array) $v);
365			} else {
366			$base[$k] = $v;
367			}
368			}
369
370			return $base;
371			}
372
373			/**
374			* @return array
375			*/
376			public function getPlaceholders()
377			{
378			return $this->placeholders;
379			}
380
381			/**
382			* @param array $placeholders
383			* @return $this
384			*/
385			public function setPlaceholders(array $placeholders)
386			{
387			$this->placeholders = $placeholders;
388
389			return $this;
390			}
391
392			/**
393			* @param $placeholder
394			* @param $value
395			*/
396			public function addPlaceholder($placeholder, $value)
397			{
398			$this->placeholders[$placeholder] = $value;
399			}
400			}
401

theiconic / config

Push — master ( d7ccd4...e440d3 )

Space::replacePlaceholders() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like