NsCache::__construct() - Code Metrics - Inspection of "* Changed cache permissions #26" - Maslosoft/Addendum - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( a05d8f...d51291 )

by Peter

created 2016-01-19 18:02 UTC

NsCache::__construct() A

↳ Parent: NsCache

Complexity

Conditions	1
Paths	1

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
c	1
b	0
f	0
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	9.4285
cc	1
eloc	4
nc	1
nop	3
crap	1

<?php

/*
 * To change this license header, choose License Headers in Project Properties.
 * To change this template file, choose Tools | Templates
 * and open the template in the editor.
 */

namespace Maslosoft\Addendum\Cache;

use Maslosoft\Addendum\Addendum;
use Maslosoft\Addendum\Helpers\SoftIncluder;
use Maslosoft\Addendum\Options\MetaOptions;
use Maslosoft\Cli\Shared\Helpers\PhpExporter;

/**
 * Meta Namespaces cache
 *
 * @author Piotr Maselkowski <pmaselkowski at gmail.com>
 */
class NsCache
{

	const FileName = '_ns.php';


	private $_file = '';

	/**
	 * Addendum instance
	 * @var Addendum
	 */
	private $ad = null;
	private $_ns = [];


	/**
	 *
	 * @var
	 */
	private static $_nsCache = [];

	public function __construct($path, Addendum $addendum, MetaOptions $options = null)
	{
		$this->_file = sprintf('%s/%s', $path, self::FileName);
		$this->ad = $addendum;
		$this->setOptions($options);
	}

	public function setOptions(MetaOptions $options = null)
	{
		if (!empty($options))
		{
			foreach ($options->namespaces as $ns)
			{
				if (!$this->_valid($ns))
				{
					$this->ad->addNamespace($ns);
				}
			}
		}
	}

	public function valid()
	{
		$ns = $this->get();
		$valid = $this->_valid($ns);

		// Ovverride existing cache if not valid
		if (!$valid)
		{
			$this->set();
		}
		return $valid;
	}

	public function get()
	{
		if (!empty(self::$_nsCache[$this->_file]))
		{
			return self::$_nsCache[$this->_file];
		}
		self::$_nsCache[$this->_file] = SoftIncluder::includeFile($this->_file);
		return self::$_nsCache[$this->_file];
	}

	public function set()
	{
		foreach ($this->ad->namespaces as $name)
		{
			$ns[$name] = true;
foreach ($collection as $item) {
    $myArray['foo'] = $item->getFoo();

    if ($item->hasBar()) {
        $myArray['bar'] = $item->getBar();
    }

    // do something with $myArray
}
		}
		$data = PhpExporter::export($ns);
function myFunction($a) {
    switch ($a) {
        case 'foo':
            $x = 1;
            break;

        case 'bar':
            $x = 2;
            break;
    }

    // $x is potentially undefined here.
    echo $x;
}
		$mask = umask(0);
		file_put_contents($this->_file, $data);
		umask($mask);
		self::$_nsCache[$this->_file] = $ns;
	}

	public function remove()
	{
		unset(self::$_nsCache[$this->_file]);
		if (file_exists($this->_file))
		{
			unlink($this->_file);
		}
	}

	private function _valid($ns)
	{
		// Fresh data
		if (empty($ns))
		{
			return true;
		}

		foreach ($this->ad->namespaces as $name)
		{
			if (empty($ns[$name]))
			{
				return false;
			}
		}
		return true;
	}

}


1		<?php
2
3		/*
4		* To change this license header, choose License Headers in Project Properties.
5		* To change this template file, choose Tools \| Templates
6		* and open the template in the editor.
7		*/
8
9		namespace Maslosoft\Addendum\Cache;
10
11		use Maslosoft\Addendum\Addendum;
12		use Maslosoft\Addendum\Helpers\SoftIncluder;
13		use Maslosoft\Addendum\Options\MetaOptions;
14		use Maslosoft\Cli\Shared\Helpers\PhpExporter;
15
16		/**
17		* Meta Namespaces cache
18		*
19		* @author Piotr Maselkowski <pmaselkowski at gmail.com>
20		*/
21		class NsCache
22		{
23
24		const FileName = '_ns.php';
		1 ignored issue – show Coding Style introduced 2015-12-16 15:41 UTC by Report Bug Copy Issue Report Constant FileName should be defined in uppercase Loading history...
25
26		private $_file = '';
27
28		/**
29		* Addendum instance
30		* @var Addendum
31		*/
32		private $ad = null;
33		private $_ns = [];
		0 ignored issues – show Unused Code introduced 2015-12-16 15:41 UTC by Report Bug Copy Issue Report The property `$_ns` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
34
35		/**
36		*
37		* @var
38		*/
39		private static $_nsCache = [];
40
41	3	public function __construct($path, Addendum $addendum, MetaOptions $options = null)
42		{
43	3	$this->_file = sprintf('%s/%s', $path, self::FileName);
44	3	$this->ad = $addendum;
45	3	$this->setOptions($options);
46	3	}
47
48	30	public function setOptions(MetaOptions $options = null)
49		{
50	30	if (!empty($options))
51	30	{
52	3	foreach ($options->namespaces as $ns)
53		{
54	3	if (!$this->_valid($ns))
55	3	{
56	3	$this->ad->addNamespace($ns);
57	3	}
58	3	}
59	3	}
60	30	}
61
62	28	public function valid()
63		{
64	28	$ns = $this->get();
65	28	$valid = $this->_valid($ns);
66
67		// Ovverride existing cache if not valid
68	28	if (!$valid)
69	28	{
70	2	$this->set();
71	2	}
72	28	return $valid;
73		}
74
75	28	public function get()
76		{
77	28	if (!empty(self::$_nsCache[$this->_file]))
78	28	{
79	26	return self::$_nsCache[$this->_file];
80		}
81	2	self::$_nsCache[$this->_file] = SoftIncluder::includeFile($this->_file);
82	2	return self::$_nsCache[$this->_file];
83		}
84
85	19	public function set()
86		{
87	19	foreach ($this->ad->namespaces as $name)
88		{
89	19	$ns[$name] = true;
		0 ignored issues – show Coding Style Comprehensibility introduced 2015-12-16 15:41 UTC by Report Bug Copy Issue Report `$ns` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$ns = array();` before regardless. Adding an explicit array definition is generally preferable to implicit array definition as it guarantees a stable state of the code. Let’s take a look at an example: foreach ($collection as $item) { $myArray['foo'] = $item->getFoo(); if ($item->hasBar()) { $myArray['bar'] = $item->getBar(); } // do something with $myArray } As you can see in this example, the array `$myArray` is initialized the first time when the foreach loop is entered. You can also see that the value of the `bar` key is only written conditionally; thus, its value might result from a previous iteration. This might or might not be intended. To make your intention clear, your code more readible and to avoid accidental bugs, we recommend to add an explicit initialization `$myArray = array()` either outside or inside the foreach loop. Loading history...
90	19	}
91	19	$data = PhpExporter::export($ns);
		0 ignored issues – show Bug introduced 2015-12-16 15:41 UTC by Report Bug Copy Issue Report The variable `$ns` does not seem to be defined for all execution paths leading up to this point. If you define a variable conditionally, it can happen that it is not defined for all execution paths. Let’s take a look at an example: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } // $x is potentially undefined here. echo $x; } In the above example, the variable `$x` is defined if you pass “foo” or “bar” as argument for `$a`. However, since the `switch` statement has no default case statement, if you pass any other value, the variable `$x` would be undefined. Available Fixes Check for existence of the variable explicitly: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } if (isset($x)) { // Make sure it's always set. echo $x; } } Define a default value for the variable: function myFunction($a) { $x = ''; // Set a default which gets overridden for certain paths. switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; } echo $x; } Add a value for the missing path: function myFunction($a) { switch ($a) { case 'foo': $x = 1; break; case 'bar': $x = 2; break; // We add support for the missing case. default: $x = ''; break; } echo $x; } Loading history...
92	19	$mask = umask(0);
93	19	file_put_contents($this->_file, $data);
94	19	umask($mask);
95	19	self::$_nsCache[$this->_file] = $ns;
96	19	}
97
98		public function remove()
99		{
100		unset(self::$_nsCache[$this->_file]);
101		if (file_exists($this->_file))
102		{
103		unlink($this->_file);
104		}
105		}
106
107	28	private function _valid($ns)
108		{
109		// Fresh data
110	28	if (empty($ns))
111	28	{
112	2	return true;
113		}
114
115	26	foreach ($this->ad->namespaces as $name)
116		{
117	26	if (empty($ns[$name]))
118	26	{
119	3	return false;
120		}
121	26	}
122	25	return true;
123		}
124
125		}
126

Maslosoft / Addendum

Push — master ( a05d8f...d51291 )

NsCache::__construct() A

Complexity

Size

Duplication

Code Coverage

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like