Env::__parse() - Code Metrics - Inspection of ":sparkles: Container: added isset/unset/isPrivate,..." - chillerlan/php-traits - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c6902f...770aa3 )

by smiley

created 2018-01-09 22:10 UTC

Env::__parse() B

↳ Parent: Env

Complexity

Conditions	4
Paths	5

Size

Total Lines	25
Code Lines	11

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	4
eloc	11
nc	5
nop	1
dl	0
loc	25
rs	8.5806
c	0
b	0
f	0

<?php
/**
 * Trait Env
 *
 * @filesource   Env.php
 * @created      25.11.2017
 * @package      chillerlan\Traits
 * @author       Smiley <[email protected]>
 * @copyright    2017 Smiley
 * @license      MIT
 */

namespace chillerlan\Traits;

/**
 * Loads .env config files into the environment
 *
 * $_ENV > getenv()!
 *
 * @link https://github.com/vlucas/phpdotenv
 * @link http://php.net/variables-order
 *
 */
trait Env{

	/**
	 * a backup environment in case everything goes downhill
	 *
	 * @var array
	 */
	private $_ENV = [];

	/**
	 * Sets the global $_ENV if true. Otherwise all variables are being kept internally
	 * in $this->_ENV to avoid leaks, making them only accessible via Env::__getEnv().
	 *
	 * @var bool
	 */
	private $_global;

	/**
	 * @param string      $path
	 * @param string|null $filename
	 * @param bool|null   $overwrite
	 * @param array|null  $required
	 * @param bool|null   $global
	 *
	 * @return $this
	 */
	protected function __loadEnv(string $path, string $filename = null, bool $overwrite = null, array $required = null, bool $global = null){
		$this->_global = $global !== null ? $global : false;
		$content       = $this->__read(rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.($filename ?? '.env'));

		return $this
			->__load($content, $overwrite !== null ? $overwrite : false)
			->__check($required)
		;
	}

	/**
	 * @param string $var
	 *
	 * @return bool|mixed
	 */
	protected function __getEnv(string $var){
		$var = strtoupper($var);
		$env = null;

		if($this->_global === true){

			if(array_key_exists($var, $_ENV)){
				$env = $_ENV[$var];
			}
			elseif(function_exists('getenv')){
				$env = getenv($var);
			}
			// @codeCoverageIgnoreStart
			elseif(function_exists('apache_getenv')){
				$env = apache_getenv($var);
			}
			// @codeCoverageIgnoreEnd

		}

		return $env ?? $this->_ENV[$var] ?? false;
	}

	/**
	 * @param string $var
	 * @param string $value
	 *
	 * @return $this
	 */
	protected function __setEnv(string $var, string $value = null){
		$var   = strtoupper($var);
		$value = $this->__parse($value);

		if($this->_global === true){
			putenv($var.'='.$value);

			// fill $_ENV explicitly, assuming variables_order="GPCS" (production)
			$_ENV[$var] = $value;

			// @codeCoverageIgnoreStart
			if(function_exists('apache_setenv')){
				apache_setenv($var, $value);
			}
			// @codeCoverageIgnoreEnd
		}

		// a backup
		$this->_ENV[$var] = $value;

		return $this;
	}

	/**
	 * @param string $var
	 *
	 * @return bool
	 */
	public function __issetEnv(string $var):bool {
		return
			($this->_global && (
				isset($_ENV[$var])
				|| getenv($var)
				|| (function_exists('apache_getenv') && apache_getenv($var))
			))
			|| array_key_exists($var, $this->_ENV);
	}

	/**
	 * @param string $var
	 *
	 * @return $this
	 */
	protected function __unsetEnv(string $var){
		$var = strtoupper($var);

		if($this->_global === true){
			unset($_ENV[$var]);
			putenv($var);
		}

		unset($this->_ENV[$var]);

		return $this;
	}

	/**
	 * use with caution!
	 *
	 * @return $this
	 */
	protected function __clearEnv(){

		if($this->_global === true){
			$_ENV = [];
		}

		$this->_ENV = [];

		return $this;
	}

	/**
	 * @param string $file
	 *
	 * @return array
	 * @throws \chillerlan\Traits\TraitException
	 */
	private function __read(string $file):array{

		if(!is_readable($file) || !is_file($file)){
			throw new TraitException('invalid file: '.$file);
		}

		// Read file into an array of lines with auto-detected line endings
		$autodetect = ini_get('auto_detect_line_endings');
		ini_set('auto_detect_line_endings', '1');
		$lines = file($file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
		ini_set('auto_detect_line_endings', $autodetect);

		if(!is_array($lines) || empty($lines)){
			throw new TraitException('error while reading file: '.$file);
		}

		return array_map('trim', $lines);
	}

	/**
	 * @param array $data
	 * @param bool  $overwrite
	 *
	 * @return $this
	 */
	private function __load(array $data, bool $overwrite){

		foreach($data as $line){

			// skip empty lines and comments
			if(empty($line) || strpos($line, '#') === 0){
				continue;
			}

			$kv = array_map('trim', explode('=', $line, 2));

			// skip empty and numeric keys, keys with spaces, existing keys that shall not be overwritten
			if(empty($kv[0]) || is_numeric($kv[0]) || strpos($kv[0], ' ') !== false || (!$overwrite && $this->__getEnv($kv[0]) !== false)){
				continue;
			}

			$this->__setEnv($kv[0], isset($kv[1]) ? trim($kv[1]) : null);
		}

		return $this;
	}

	/**
	 * @param string $value
	 *
	 * @return string|null
	 */
	private function __parse(string $value = null){

		if($value !== null){

			$q = $value[0] ?? null;

			$value = in_array($q, ["'", '"'], true)
				// handle quoted strings
				? preg_replace("/^$q((?:[^$q\\\\]|\\\\\\\\|\\\\$q)*)$q.*$/mx", '$1', $value)
				// skip inline comments
				: trim(explode('#', $value, 2)[0]);

			// handle multiline values
			$value = implode(PHP_EOL, explode('\\n', $value));

			// handle nested ${VARS}
			if(strpos($value, '$') !== false){
				$value = preg_replace_callback('/\${(?<var>[_a-z\d]+)}/i', function($matches){
					return $this->__getEnv($matches['var']);
				}, $value);
			}

		}

		return $value;
	}

	/**
	 * @param array|null $required
	 *
	 * @return $this
	 * @throws \chillerlan\Traits\TraitException
	 */
	private function __check(array $required = null){

		if($required === null || empty($required)){
			return $this;
		}

		foreach($required as $var){
			if($this->__getEnv($var) === false || $this->__getEnv($var) === null){
				throw new TraitException('required variable not set: '.strtoupper($var));
			}
		}

		return $this;
	}
}


1			<?php
2			/**
3			* Trait Env
4			*
5			* @filesource Env.php
6			* @created 25.11.2017
7			* @package chillerlan\Traits
8			* @author Smiley <[email protected]>
9			* @copyright 2017 Smiley
10			* @license MIT
11			*/
12
13			namespace chillerlan\Traits;
14
15			/**
16			* Loads .env config files into the environment
17			*
18			* $_ENV > getenv()!
19			*
20			* @link https://github.com/vlucas/phpdotenv
21			* @link http://php.net/variables-order
22			*
23			*/
24			trait Env{
25
26			/**
27			* a backup environment in case everything goes downhill
28			*
29			* @var array
30			*/
31			private $_ENV = [];
32
33			/**
34			* Sets the global $_ENV if true. Otherwise all variables are being kept internally
35			* in $this->_ENV to avoid leaks, making them only accessible via Env::__getEnv().
36			*
37			* @var bool
38			*/
39			private $_global;
40
41			/**
42			* @param string $path
43			* @param string\|null $filename
44			* @param bool\|null $overwrite
45			* @param array\|null $required
46			* @param bool\|null $global
47			*
48			* @return $this
49			*/
50			protected function __loadEnv(string $path, string $filename = null, bool $overwrite = null, array $required = null, bool $global = null){
51			$this->_global = $global !== null ? $global : false;
52			$content = $this->__read(rtrim($path, DIRECTORY_SEPARATOR).DIRECTORY_SEPARATOR.($filename ?? '.env'));
53
54			return $this
55			->__load($content, $overwrite !== null ? $overwrite : false)
56			->__check($required)
57			;
58			}
59
60			/**
61			* @param string $var
62			*
63			* @return bool\|mixed
64			*/
65			protected function __getEnv(string $var){
66			$var = strtoupper($var);
67			$env = null;
68
69			if($this->_global === true){
70
71			if(array_key_exists($var, $_ENV)){
72			$env = $_ENV[$var];
73			}
74			elseif(function_exists('getenv')){
75			$env = getenv($var);
76			}
77			// @codeCoverageIgnoreStart
78			elseif(function_exists('apache_getenv')){
79			$env = apache_getenv($var);
80			}
81			// @codeCoverageIgnoreEnd
82
83			}
84
85			return $env ?? $this->_ENV[$var] ?? false;
86			}
87
88			/**
89			* @param string $var
90			* @param string $value
91			*
92			* @return $this
93			*/
94			protected function __setEnv(string $var, string $value = null){
95			$var = strtoupper($var);
96			$value = $this->__parse($value);
97
98			if($this->_global === true){
99			putenv($var.'='.$value);
100
101			// fill $_ENV explicitly, assuming variables_order="GPCS" (production)
102			$_ENV[$var] = $value;
103
104			// @codeCoverageIgnoreStart
105			if(function_exists('apache_setenv')){
106			apache_setenv($var, $value);
107			}
108			// @codeCoverageIgnoreEnd
109			}
110
111			// a backup
112			$this->_ENV[$var] = $value;
113
114			return $this;
115			}
116
117			/**
118			* @param string $var
119			*
120			* @return bool
121			*/
122			public function __issetEnv(string $var):bool {
123			return
124			($this->_global && (
125			isset($_ENV[$var])
126			\|\| getenv($var)
127			\|\| (function_exists('apache_getenv') && apache_getenv($var))
128			))
129			\|\| array_key_exists($var, $this->_ENV);
130			}
131
132			/**
133			* @param string $var
134			*
135			* @return $this
136			*/
137			protected function __unsetEnv(string $var){
138			$var = strtoupper($var);
139
140			if($this->_global === true){
141			unset($_ENV[$var]);
142			putenv($var);
143			}
144
145			unset($this->_ENV[$var]);
146
147			return $this;
148			}
149
150			/**
151			* use with caution!
152			*
153			* @return $this
154			*/
155			protected function __clearEnv(){
156
157			if($this->_global === true){
158			$_ENV = [];
159			}
160
161			$this->_ENV = [];
162
163			return $this;
164			}
165
166			/**
167			* @param string $file
168			*
169			* @return array
170			* @throws \chillerlan\Traits\TraitException
171			*/
172			private function __read(string $file):array{
173
174			if(!is_readable($file) \|\| !is_file($file)){
175			throw new TraitException('invalid file: '.$file);
176			}
177
178			// Read file into an array of lines with auto-detected line endings
179			$autodetect = ini_get('auto_detect_line_endings');
180			ini_set('auto_detect_line_endings', '1');
181			$lines = file($file, FILE_IGNORE_NEW_LINES \| FILE_SKIP_EMPTY_LINES);
182			ini_set('auto_detect_line_endings', $autodetect);
183
184			if(!is_array($lines) \|\| empty($lines)){
185			throw new TraitException('error while reading file: '.$file);
186			}
187
188			return array_map('trim', $lines);
189			}
190
191			/**
192			* @param array $data
193			* @param bool $overwrite
194			*
195			* @return $this
196			*/
197			private function __load(array $data, bool $overwrite){
198
199			foreach($data as $line){
200
201			// skip empty lines and comments
202			if(empty($line) \|\| strpos($line, '#') === 0){
203			continue;
204			}
205
206			$kv = array_map('trim', explode('=', $line, 2));
207
208			// skip empty and numeric keys, keys with spaces, existing keys that shall not be overwritten
209			if(empty($kv[0]) \|\| is_numeric($kv[0]) \|\| strpos($kv[0], ' ') !== false \|\| (!$overwrite && $this->__getEnv($kv[0]) !== false)){
210			continue;
211			}
212
213			$this->__setEnv($kv[0], isset($kv[1]) ? trim($kv[1]) : null);
214			}
215
216			return $this;
217			}
218
219			/**
220			* @param string $value
221			*
222			* @return string\|null
223			*/
224			private function __parse(string $value = null){
225
226			if($value !== null){
227
228			$q = $value[0] ?? null;
229
230			$value = in_array($q, ["'", '"'], true)
231			// handle quoted strings
232			? preg_replace("/^$q((?:[^$q\\\\]\|\\\\\\\\\|\\\\$q))$q.$/mx", '$1', $value)
233			// skip inline comments
234			: trim(explode('#', $value, 2)[0]);
235
236			// handle multiline values
237			$value = implode(PHP_EOL, explode('\\n', $value));
238
239			// handle nested ${VARS}
240			if(strpos($value, '$') !== false){
241			$value = preg_replace_callback('/\${(?<var>[_a-z\d]+)}/i', function($matches){
242			return $this->__getEnv($matches['var']);
243			}, $value);
244			}
245
246			}
247
248			return $value;
249			}
250
251			/**
252			* @param array\|null $required
253			*
254			* @return $this
255			* @throws \chillerlan\Traits\TraitException
256			*/
257			private function __check(array $required = null){
258
259			if($required === null \|\| empty($required)){
260			return $this;
261			}
262
263			foreach($required as $var){
264			if($this->__getEnv($var) === false \|\| $this->__getEnv($var) === null){
265			throw new TraitException('required variable not set: '.strtoupper($var));
266			}
267			}
268
269			return $this;
270			}
271			}
272

chillerlan / php-traits

Push — master ( c6902f...770aa3 )

Env::__parse() B

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like