Vars::getVariables() - Code Metrics - Inspection of "Move loader and extension logic from Vars to Loade..." - m1/Vars - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 61de95...83d765 )

by Miles

created 2015-12-08 14:24 UTC

Vars::getVariables() A

↳ Parent: Vars

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	2
Bugs	0	Features	0

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

<?php

/**
 * This file is part of the m1\vars library
 *
 * (c) m1 <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 *
 * @package     m1/vars
 * @version     0.1.0
 * @author      Miles Croxford <[email protected]>
 * @copyright   Copyright (c) Miles Croxford <[email protected]>
 * @license     http://github.com/m1/vars/blob/master/LICENSE
 * @link        http://github.com/m1/vars/blob/master/README.MD Documentation
 */

namespace M1\Vars;

use M1\Vars\Cache\CacheProvider;
use M1\Vars\Loader\LoaderProvider;
use M1\Vars\Resource\AbstractResource;
use M1\Vars\Resource\ResourceProvider;
use M1\Vars\Resource\VariableResource;

/**
 * Vars core class
 *
 * @since 0.1.0
 */
class Vars extends AbstractResource
{
    /**
     * The base path for the Vars config and cache folders
     *
     * @var string $base_path
     */
    private $base_path;

    /**
     * The cache object if the cache is wanted, else false
     *
     * @var \M1\Vars\Cache\CacheProvider $cache
     */
    public $cache;

    /**
     * The default options for Vars
     *
     * @var array $default_options
     */
    private $default_options = array(
        'base_path' => null,
        'cache' => true,
        'cache_path' => null,
        'cache_expire' => 300, // 5 minutes
        'loaders' => array('ini', 'json', 'php', 'toml', 'yaml', 'xml',)
    );

    /**
     * The loaderProvider for Vars supplies the file loaders and the extensions that are supported
     *
     * @var \M1\Vars\Loader\LoaderProvider $loader
     */
    public $loader;

    /**
     * Have the base and cache paths been set
     *
     * @var bool $paths_loaded
     */
    private $paths_loaded = false;

    /**
     * The imported resources
     *
     * @var array $resources
     */
    private $resources = array();

    /**
     * The words to be replaced in the config files
     *
     * @var array $variables
     */
    private $variables = array();

    /**
     * Creates a new instance of Vars
     *
     * @param string|array $resource The main configuration resource
     * @param array        $options  The options being used for Vars
     */
    public function __construct($resource, $options = array())
    {
        $options = $this->parseOptions($options);
        $this->makeCache($options, $resource);
        $this->makePaths($options);

        if (!$this->cache->checkCache()) {
            $this->makeLoader($options);
            $this->makeVariables($options);

            $resource = new ResourceProvider($this, $resource);
        }

        if ($this->cache->isHit()) {
            $this->loadFromCache();
        } else {
            $resource->mergeParentContent();
function someFunction(A $objectMaybe = null)
{
    if ($objectMaybe instanceof A) {
        $objectMaybe->doSomething();
    }
}
            $this->content = $resource->getContent();

            $this->cache->setTime(time());
            $this->cache->makeCache($this);

        }
    }

    /**
     * Parses the options so Vars can use them
     *
     * @param array $options  The options being used for Vars
     *
     * @return array The parsed options
     */
    private function parseOptions(array $options)
    {
        $parsed_options = array_merge($this->default_options, $options);

        if (isset($options['loaders'])) {
            $loaders = array();

            if (is_array($options['loaders']) && !empty($options['loaders'])) {
                $loaders = $options['loaders'];
            } elseif (is_string($options['loaders'])) {
                $loaders[] = $options['loaders'];
            } else {
                $loaders = $this->default_options['loaders'];
            }

            $parsed_options['loaders'] = $loaders;
        } else {
            $parsed_options['loaders'] = $this->default_options['loaders'];
        }

        return $parsed_options;
    }

    /**
     * Makes the CacheProvider with the options
     *
     * @param array        $options  The options being used for Vars
     * @param array|string $resource The main configuration resource
     */
    private function makeCache($options, $resource)
    {
        $cache = new CacheProvider($resource, $options);
        $this->cache = $cache;
    }

    /**
     * Sets the base path if the options have been set and the cache path if the cache path has not been set but the
     * base path has
     *
     * @param array $options The options being used for Vars
     */
    private function makePaths($options)
    {
        $this->setBasePath($options['base_path']);

        if (is_null($options['cache_path']) && !is_null($options['base_path'])) {
            $this->cache->setPath($options['base_path']);
            $this->paths_loaded = true;
        }
    }

    /**
     * Makes the LoaderProvider with the options
     *
     * @param array $options  The options being used for Vars
     */
    private function makeLoader($options)
    {
        $loader = new LoaderProvider($options, $this->default_options['loaders']);
        $this->loader = $loader;
    }
    /**
     * Sets the replacement variables if the option has been set
     *
     * @param array|null $options The options being used for Vars
     */
    private function makeVariables($options)
    {
        if (isset($options['variables'])) {
            $variables = new VariableResource($this, $options['variables']);

            $v = array();

            foreach ($variables->getVariables() as $variable_key => $variable_value) {
                $v["%".$variable_key.'%'] = $variable_value;
            }

            $this->variables = $v;
        }
    }

    /**
     * Loads the cached file into the current class
     */
    private function loadFromCache()
    {
        $this->cache->load();

        $passed_keys = array(
            'base_path',
            'content',
            'extensions',
            'loaders',
            'resources',
            'variables',
        );

        $loaded_vars = get_object_vars($this->cache->getLoadedVars());

        foreach ($loaded_vars as $key => $value) {
            if (in_array($key, $passed_keys)) {
                $this->$key = $value;
            }
        }

        $this->cache->setTime($loaded_vars['cache']->getTime());
    }

    /**
     * Checks if the base and cache paths have been set, if not set then will use the $resource as the base path
     *
     * @param string $resource The resource to use to set the paths if they haven't been set
     */
    public function pathsLoadedCheck($resource)
    {
        if (!$this->paths_loaded) {
            $base_path = $this->getBasePath();

            if (!$base_path) {
                $file = pathinfo(realpath($resource));
                $base_path = $file['dirname'];
                $this->setBasePath($base_path);
            }

            if ($this->cache->getProvide() && !$this->cache->getPath()) {
                $this->cache->setPath($base_path);
            }

            $this->paths_loaded = true;
        }
    }

    /**
     * Get the Vars base path
     *
     * @return string The Vars base path
     */
    public function getBasePath()
    {
        return $this->base_path;
    }

    /**
     * Set the Vars base path
     *
     * @param string $base_path The base path to set
     *
     * @throws \InvalidArgumentException If the base path does not exist or is not writable
     *
     * @return \M1\Vars\Vars
     */
    public function setBasePath($base_path)

    {
        if (is_null($base_path)) {
            return;
        }

        if (!is_dir($base_path)) {
            throw new \InvalidArgumentException(sprintf(
                "'%s' base path does not exist or is not writable",
                $base_path
            ));
        }

        $this->base_path = realpath($base_path);
        return $this;
    }
    
    /**
     * Adds a resource to $this->resources
     *
     * @param string $resource Resource to add to the stack
     *
     * @return int The position of the added resource
     */
    public function addResource($resource)
    {
        $r = realpath($resource);
        $pos = count($this->resources);
        $this->resources[$pos] = $r;
        return $pos;
    }

    /**
     * Updates the string resource with the FileResource
     *
     * @param \M1\Vars\Resource\FileResource $resource The FileResource to add
     * @param int                            $pos      The position of the string resource
     *
     * @return \M1\Vars\Vars
     */
    public function updateResource($resource, $pos)
    {
        $this->resources[$pos] = $resource;
        return $this;
    }

    /**
     * Tests to see if the resource has been imported already -- this is to avoid getting into a infinite loop
     *
     * @param \M1\Vars\Resource\FileResource|string $resource Resource to check
     *
     * @return bool Has resource already been imported
     */
    public function resourceImported($resource)
    {
        $resource = realpath($resource);
        foreach ($this->getResources() as $r) {
            if ((is_a($r, 'M1\Vars\Resource\FileResource') && $resource === $r->getFile()) ||
                (is_string($r) && $resource === $r)) {
                return true;
            }
        }
        return false;
    }

    /**
     * Searches the resource stack for a certain resource
     *
     * @param string $resource The resource to search for
     *
     * @return bool Returns the resource if found
     */
    public function getResource($resource)
    {
        foreach ($this->getResources() as $r) {
            if ($resource === $r->getFilename()) {
                return $r;
            }
        }

        return false;
    }

    /**
     * Returns the imported resources
     *
     * @return array The Vars imported resources
     */
    public function getResources()
    {
        return $this->resources;
    }

    /**
     * Returns the Vars replacement variables
     *
     * @return array The Vars replacement variables
     */
    public function getVariables()
    {
        return $this->variables;
    }

    /**
     * Returns the CacheProvider if set, if not return false
     *
     * @return \M1\Vars\Cache\CacheProvider|false The CacheProvider or false
     */
    public function getCache()
    {
        return $this->cache;
    }
}


1			<?php
2
3			/**
4			* This file is part of the m1\vars library
5			*
6			* (c) m1 <[email protected]>
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*
11			* @package m1/vars
12			* @version 0.1.0
13			* @author Miles Croxford <[email protected]>
14			* @copyright Copyright (c) Miles Croxford <[email protected]>
15			* @license http://github.com/m1/vars/blob/master/LICENSE
16			* @link http://github.com/m1/vars/blob/master/README.MD Documentation
17			*/
18
19			namespace M1\Vars;
20
21			use M1\Vars\Cache\CacheProvider;
22			use M1\Vars\Loader\LoaderProvider;
23			use M1\Vars\Resource\AbstractResource;
24			use M1\Vars\Resource\ResourceProvider;
25			use M1\Vars\Resource\VariableResource;
26
27			/**
28			* Vars core class
29			*
30			* @since 0.1.0
31			*/
32			class Vars extends AbstractResource
33			{
34			/**
35			* The base path for the Vars config and cache folders
36			*
37			* @var string $base_path
38			*/
39			private $base_path;
40
41			/**
42			* The cache object if the cache is wanted, else false
43			*
44			* @var \M1\Vars\Cache\CacheProvider $cache
45			*/
46			public $cache;
47
48			/**
49			* The default options for Vars
50			*
51			* @var array $default_options
52			*/
53			private $default_options = array(
54			'base_path' => null,
55			'cache' => true,
56			'cache_path' => null,
57			'cache_expire' => 300, // 5 minutes
58			'loaders' => array('ini', 'json', 'php', 'toml', 'yaml', 'xml',)
59			);
60
61			/**
62			* The loaderProvider for Vars supplies the file loaders and the extensions that are supported
63			*
64			* @var \M1\Vars\Loader\LoaderProvider $loader
65			*/
66			public $loader;
67
68			/**
69			* Have the base and cache paths been set
70			*
71			* @var bool $paths_loaded
72			*/
73			private $paths_loaded = false;
74
75			/**
76			* The imported resources
77			*
78			* @var array $resources
79			*/
80			private $resources = array();
81
82			/**
83			* The words to be replaced in the config files
84			*
85			* @var array $variables
86			*/
87			private $variables = array();
88
89			/**
90			* Creates a new instance of Vars
91			*
92			* @param string\|array $resource The main configuration resource
93			* @param array $options The options being used for Vars
94			*/
95			public function __construct($resource, $options = array())
96			{
97			$options = $this->parseOptions($options);
98			$this->makeCache($options, $resource);
99			$this->makePaths($options);
100
101	63		if (!$this->cache->checkCache()) {
102			$this->makeLoader($options);
103	63		$this->makeVariables($options);
104	63
105	62		$resource = new ResourceProvider($this, $resource);
106			}
107	61
108	61		if ($this->cache->isHit()) {
109	59		$this->loadFromCache();
110			} else {
111	58		$resource->mergeParentContent();
			0 ignored issues – show Bug introduced 2015-12-07 14:50 UTC by Report Bug Copy Issue Report It seems like `$resource` is not always an object, but can also be of type `string\|array`. Maybe add an additional type check? If a variable is not always an object, we recommend to add an additional type check to ensure your method call is safe: function someFunction(A $objectMaybe = null) { if ($objectMaybe instanceof A) { $objectMaybe->doSomething(); } } Loading history...
112	47		$this->content = $resource->getContent();
113
114	47		$this->cache->setTime(time());
115	2		$this->cache->makeCache($this);
116	2
117	47		}
118	47		}
119
120	47		/**
121	47		* Parses the options so Vars can use them
122			*
123			* @param array $options The options being used for Vars
124	47		*
125			* @return array The parsed options
126			*/
127			private function parseOptions(array $options)
128			{
129			$parsed_options = array_merge($this->default_options, $options);
130
131			if (isset($options['loaders'])) {
132			$loaders = array();
133	63
134			if (is_array($options['loaders']) && !empty($options['loaders'])) {
135	63		$loaders = $options['loaders'];
136	1		} elseif (is_string($options['loaders'])) {
137	1		$loaders[] = $options['loaders'];
138	62		} else {
139			$loaders = $this->default_options['loaders'];
140	62		}
141	8
142	3		$parsed_options['loaders'] = $loaders;
143	8		} else {
144	4		$parsed_options['loaders'] = $this->default_options['loaders'];
145	4		}
146	1
147			return $parsed_options;
148			}
149	8
150	54		/**
151			* Makes the CacheProvider with the options
152			*
153	62		* @param array $options The options being used for Vars
154			* @param array\|string $resource The main configuration resource
155			*/
156	63		private function makeCache($options, $resource)
157			{
158			$cache = new CacheProvider($resource, $options);
159			$this->cache = $cache;
160			}
161
162			/**
163			* Sets the base path if the options have been set and the cache path if the cache path has not been set but the
164			* base path has
165	63		*
166			* @param array $options The options being used for Vars
167	63		*/
168	62		private function makePaths($options)
169	62		{
170			$this->setBasePath($options['base_path']);
171
172			if (is_null($options['cache_path']) && !is_null($options['base_path'])) {
173			$this->cache->setPath($options['base_path']);
174			$this->paths_loaded = true;
175			}
176			}
177	62
178			/**
179	62		* Makes the LoaderProvider with the options
180			*
181	61		* @param array $options The options being used for Vars
182	1		*/
183	1		private function makeLoader($options)
184	1		{
185	61		$loader = new LoaderProvider($options, $this->default_options['loaders']);
186			$this->loader = $loader;
187			}
188			/**
189			* Sets the replacement variables if the option has been set
190			*
191			* @param array\|null $options The options being used for Vars
192			*/
193	61		private function makeVariables($options)
194			{
195	61		if (isset($options['variables'])) {
196			$variables = new VariableResource($this, $options['variables']);
197	61
198	61		$v = array();
199	2
200	2		foreach ($variables->getVariables() as $variable_key => $variable_value) {
201	60		$v["%".$variable_key.'%'] = $variable_value;
202			}
203	61
204			$this->variables = $v;
205	61		}
206			}
207	61
208	60		/**
209	59		* Loads the cached file into the current class
210			*/
211			private function loadFromCache()
212			{
213			$this->cache->load();
214
215			$passed_keys = array(
216			'base_path',
217			'content',
218			'extensions',
219			'loaders',
220			'resources',
221	61		'variables',
222			);
223	61
224			$loaded_vars = get_object_vars($this->cache->getLoadedVars());
225	61
226	61		foreach ($loaded_vars as $key => $value) {
227	58		if (in_array($key, $passed_keys)) {
228	58		$this->$key = $value;
229			}
230	61		}
231	1
232			$this->cache->setTime($loaded_vars['cache']->getTime());
233			}
234	60
235	60		/**
236			* Checks if the base and cache paths have been set, if not set then will use the $resource as the base path
237			*
238	60		* @param string $resource The resource to use to set the paths if they haven't been set
239			*/
240			public function pathsLoadedCheck($resource)
241			{
242	60		if (!$this->paths_loaded) {
243			$base_path = $this->getBasePath();
244
245			if (!$base_path) {
246			$file = pathinfo(realpath($resource));
247			$base_path = $file['dirname'];
248			$this->setBasePath($base_path);
249			}
250	59
251			if ($this->cache->getProvide() && !$this->cache->getPath()) {
252	59		$this->cache->setPath($base_path);
253	4		}
254
255	3		$this->paths_loaded = true;
256			}
257	3		}
258	3
259	3		/**
260			* Get the Vars base path
261	3		*
262	3		* @return string The Vars base path
263	58		*/
264			public function getBasePath()
265			{
266			return $this->base_path;
267			}
268	2
269			/**
270	2		* Set the Vars base path
271			*
272			* @param string $base_path The base path to set
273	2		*
274	2		* @throws \InvalidArgumentException If the base path does not exist or is not writable
275	2		*
276	2		* @return \M1\Vars\Vars
277	2		*/
278	2	View Code Duplication	public function setBasePath($base_path)
			0 ignored issues – show Duplication introduced 2015-12-08 12:35 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
279	2		{
280			if (is_null($base_path)) {
281	2		return;
282			}
283	2
284	2		if (!is_dir($base_path)) {
285	2		throw new \InvalidArgumentException(sprintf(
286	2		"'%s' base path does not exist or is not writable",
287	2		$base_path
288			));
289	2		}
290	2
291			$this->base_path = realpath($base_path);
292			return $this;
293			}
294
295			/**
296			* Adds a resource to $this->resources
297			*
298			* @param string $resource Resource to add to the stack
299			*
300			* @return int The position of the added resource
301			*/
302			public function addResource($resource)
303	60		{
304			$r = realpath($resource);
305	60		$pos = count($this->resources);
306			$this->resources[$pos] = $r;
307	60		return $pos;
308	60		}
309	60
310			/**
311	60		* Updates the string resource with the FileResource
312	1		*
313			* @param \M1\Vars\Resource\FileResource $resource The FileResource to add
314			* @param int $pos The position of the string resource
315	59		*
316			* @return \M1\Vars\Vars
317			*/
318			public function updateResource($resource, $pos)
319			{
320			$this->resources[$pos] = $resource;
321			return $this;
322			}
323	53
324			/**
325	53		* Tests to see if the resource has been imported already -- this is to avoid getting into a infinite loop
326	52		*
327			* @param \M1\Vars\Resource\FileResource\|string $resource Resource to check
328	52		*
329	50		* @return bool Has resource already been imported
330	50		*/
331	50		public function resourceImported($resource)
332	50		{
333			$resource = realpath($resource);
334	52		foreach ($this->getResources() as $r) {
335			if ((is_a($r, 'M1\Vars\Resource\FileResource') && $resource === $r->getFile()) \|\|
336			(is_string($r) && $resource === $r)) {
337			return true;
338	52		}
339	52		}
340	53		return false;
341			}
342
343			/**
344			* Searches the resource stack for a certain resource
345			*
346			* @param string $resource The resource to search for
347	53		*
348			* @return bool Returns the resource if found
349	53		*/
350			public function getResource($resource)
351			{
352			foreach ($this->getResources() as $r) {
353			if ($resource === $r->getFilename()) {
354			return $r;
355			}
356			}
357	4
358			return false;
359	4		}
360
361			/**
362			* Returns the imported resources
363			*
364			* @return array The Vars imported resources
365			*/
366			public function getResources()
367	53		{
368			return $this->resources;
369	53		}
370
371			/**
372			* Returns the Vars replacement variables
373			*
374			* @return array The Vars replacement variables
375			*/
376			public function getVariables()
377			{
378			return $this->variables;
379			}
380
381	62		/**
382			* Returns the CacheProvider if set, if not return false
383	62		*
384	58		* @return \M1\Vars\Cache\CacheProvider\|false The CacheProvider or false
385			*/
386			public function getCache()
387	54		{
388	1		return $this->cache;
389	1		}
390			}
391

m1 / Vars

GitHub Access Token became invalid

Push — master ( 61de95...83d765 )

Vars::getVariables() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like