EnvVarsArrayTrait::clearEnvVars() - Code Metrics - appserver-io/server - Measure and Improve Code Quality continuously with Scrutinizer

EnvVarsArrayTrait::clearEnvVars() A
last analyzed 2018-06-19 19:33 UTC

↳ Parent: EnvVarsArrayTrait

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	3

Duplication

Lines	6
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	6

Importance

Changes

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

<?php

/**
 * \AppserverIo\Server\Traits\EnvVarsArrayTrait
 *
 * NOTICE OF LICENSE
 *
 * This source file is subject to the Open Software License (OSL 3.0)
 * that is available through the world-wide-web at this URL:
 * http://opensource.org/licenses/osl-3.0.php
 *
 * PHP version 5
 *
 * @author    Johann Zelger <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/server
 * @link      http://www.appserver.io
 */

namespace AppserverIo\Server\Traits;

use AppserverIo\Server\Exceptions\ServerException;

/**
 * Trait EnvVarsArrayTrait
 *
 * @author    Johann Zelger <[email protected]>
 * @copyright 2015 TechDivision GmbH <[email protected]>
 * @license   http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
 * @link      https://github.com/appserver-io/server
 * @link      http://www.appserver.io
 */
trait EnvVarsArrayTrait

{
    /**
     * Sets a value to specific env var
     *
     * @param string $envVar The env var to set
     * @param string $value  The value to env var
     *
     * @return void
     */
    public function setEnvVar($envVar, $value)
    {
        if (!is_null($value)) {
            $this->envVars[$envVar] = $value;
class MyClass { }

$x = new MyClass();
$x->foo = true;
        }
    }

    /**
     * Unsets a specific env var
     *
     * @param string $envVar The env var to unset
     *
     * @return void
     */
    public function unsetEnvVar($envVar)
    {
        if (isset($this->envVars[$envVar])) {
            unset($this->envVars[$envVar]);
        }
    }

    /**
     * Returns a value for specific env var
     *
     * @param string $envVar The env var to get value for
     *
     * @throws \AppserverIo\Server\Exceptions\ServerException
     *
     * @return mixed The value to given env var
     */
    public function getEnvVar($envVar)
    {
        // check if var is set
        if (isset($this->envVars[$envVar])) {
            // return vars value
            return $this->envVars[$envVar];
        }
        // throw exception
        throw new ServerException("Env var '$envVar'' does not exist.", 500);
    }

    /**
     * Returns all the env vars as array key value pair format
     *
     * @return array The env vars as array
     */
    public function getEnvVars()
    {
        return $this->envVars;
    }

    /**
     * Checks if value exists for given env var
     *
     * @param string $envVar The env var to check
     *
     * @return boolean Weather it has envVar (true) or not (false)
     */
    public function hasEnvVar($envVar)
    {
        // check if var is set
        if (!isset($this->envVars[$envVar])) {
            return false;
        }

        return true;
    }

    /**
     * Clears the env vars storage
     *
     * @return void
     */
    public function clearEnvVars()
    {
        foreach ($this->envVars as $key => $value) {
            unset($this->envVars[$key]);
        }
    }
}


1		<?php
2
3		/**
4		* \AppserverIo\Server\Traits\EnvVarsArrayTrait
5		*
6		* NOTICE OF LICENSE
7		*
8		* This source file is subject to the Open Software License (OSL 3.0)
9		* that is available through the world-wide-web at this URL:
10		* http://opensource.org/licenses/osl-3.0.php
11		*
12		* PHP version 5
13		*
14		* @author Johann Zelger <[email protected]>
15		* @copyright 2015 TechDivision GmbH <[email protected]>
16		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
17		* @link https://github.com/appserver-io/server
18		* @link http://www.appserver.io
19		*/
20
21		namespace AppserverIo\Server\Traits;
22
23		use AppserverIo\Server\Exceptions\ServerException;
24
25		/**
26		* Trait EnvVarsArrayTrait
27		*
28		* @author Johann Zelger <[email protected]>
29		* @copyright 2015 TechDivision GmbH <[email protected]>
30		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
31		* @link https://github.com/appserver-io/server
32		* @link http://www.appserver.io
33		*/
34	View Code Duplication	trait EnvVarsArrayTrait
		0 ignored issues – show Duplication introduced 2016-02-24 23:06 UTC by Report Bug Copy Issue Report This class 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...
35		{
36		/**
37		* Sets a value to specific env var
38		*
39		* @param string $envVar The env var to set
40		* @param string $value The value to env var
41		*
42		* @return void
43		*/
44		public function setEnvVar($envVar, $value)
45		{
46		if (!is_null($value)) {
47		$this->envVars[$envVar] = $value;
		0 ignored issues – show Bug introduced 2016-02-24 23:06 UTC by Report Bug Copy Issue Report The property `envVars` does not exist. Did you maybe forget to declare it? In PHP it is possible to write to properties without declaring them. For example, the following is perfectly valid PHP code: class MyClass { } $x = new MyClass(); $x->foo = true; Generally, it is a good practice to explictly declare properties to avoid accidental typos and provide IDE auto-completion: class MyClass { public $foo; } $x = new MyClass(); $x->foo = true; Loading history...
48		}
49		}
50
51		/**
52		* Unsets a specific env var
53		*
54		* @param string $envVar The env var to unset
55		*
56		* @return void
57		*/
58		public function unsetEnvVar($envVar)
59		{
60		if (isset($this->envVars[$envVar])) {
61		unset($this->envVars[$envVar]);
62		}
63		}
64
65		/**
66		* Returns a value for specific env var
67		*
68		* @param string $envVar The env var to get value for
69		*
70		* @throws \AppserverIo\Server\Exceptions\ServerException
71		*
72		* @return mixed The value to given env var
73		*/
74		public function getEnvVar($envVar)
75		{
76		// check if var is set
77		if (isset($this->envVars[$envVar])) {
78		// return vars value
79		return $this->envVars[$envVar];
80		}
81		// throw exception
82		throw new ServerException("Env var '$envVar'' does not exist.", 500);
83		}
84
85		/**
86		* Returns all the env vars as array key value pair format
87		*
88		* @return array The env vars as array
89		*/
90		public function getEnvVars()
91		{
92		return $this->envVars;
93		}
94
95		/**
96		* Checks if value exists for given env var
97		*
98		* @param string $envVar The env var to check
99		*
100		* @return boolean Weather it has envVar (true) or not (false)
101		*/
102		public function hasEnvVar($envVar)
103		{
104		// check if var is set
105		if (!isset($this->envVars[$envVar])) {
106		return false;
107		}
108
109		return true;
110		}
111
112		/**
113		* Clears the env vars storage
114		*
115		* @return void
116		*/
117		public function clearEnvVars()
118		{
119		foreach ($this->envVars as $key => $value) {
120		unset($this->envVars[$key]);
121		}
122		}
123		}
124

appserver-io / server

EnvVarsArrayTrait::clearEnvVars() A last analyzed 2018-06-19 19:33 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

EnvVarsArrayTrait::clearEnvVars() A
last analyzed 2018-06-19 19:33 UTC