EnvVarsObjectTrait::getEnvVars() - Code Metrics - Inspection of "Add MainConfigurationInterface + Add minor customi..." - appserver-io/server - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#29)

by Tim

created 2016-06-28 09:16 UTC

EnvVarsObjectTrait::getEnvVars() A

↳ Parent: EnvVarsObjectTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	4
Ratio	100 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes	2
Bugs	0	Features	0

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

<?php

/**
 * \AppserverIo\Server\Traits\EnvVarsObjectTrait
 *
 * 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;

/**
 * Trait EnvVarsObjectTrait
 *
 * @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 EnvVarsObjectTrait

{
    /**
     * 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)
    {
        $this->envVars->add($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)
    {
        $this->envVars->remove($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)
    {
        // get from hash map
        return $this->envVars->get($envVar);
    }

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

    /**
     * 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
        return $this->envVars->exists($envVar);
    }

    /**
     * Clears the env vars storage
     *
     * @return void
     */
    public function clearEnvVars()
    {
        $this->envVars->clear();
    }
}


1		<?php
2
3		/**
4		* \AppserverIo\Server\Traits\EnvVarsObjectTrait
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		/**
24		* Trait EnvVarsObjectTrait
25		*
26		* @author Johann Zelger <[email protected]>
27		* @copyright 2015 TechDivision GmbH <[email protected]>
28		* @license http://opensource.org/licenses/osl-3.0.php Open Software License (OSL 3.0)
29		* @link https://github.com/appserver-io/server
30		* @link http://www.appserver.io
31		*/
32	View Code Duplication	trait EnvVarsObjectTrait
		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...
33		{
34		/**
35		* Sets a value to specific env var
36		*
37		* @param string $envVar The env var to set
38		* @param string $value The value to env var
39		*
40		* @return void
41		*/
42		public function setEnvVar($envVar, $value)
43		{
44		$this->envVars->add($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...
45		}
46
47		/**
48		* Unsets a specific env var
49		*
50		* @param string $envVar The env var to unset
51		*
52		* @return void
53		*/
54		public function unsetEnvVar($envVar)
55		{
56		$this->envVars->remove($envVar);
57		}
58
59		/**
60		* Returns a value for specific env var
61		*
62		* @param string $envVar The env var to get value for
63		*
64		* @throws \AppserverIo\Server\Exceptions\ServerException
65		*
66		* @return mixed The value to given env var
67		*/
68		public function getEnvVar($envVar)
69		{
70		// get from hash map
71		return $this->envVars->get($envVar);
72		}
73
74		/**
75		* Returns all the env vars as array key value pair format
76		*
77		* @return array The env vars as array
78		*/
79		public function getEnvVars()
80		{
81		return $this->envVars->toIndexedArray();
82		}
83
84		/**
85		* Checks if value exists for given env var
86		*
87		* @param string $envVar The env var to check
88		*
89		* @return boolean Weather it has envVar (true) or not (false)
90		*/
91		public function hasEnvVar($envVar)
92		{
93		// check if var is set
94		return $this->envVars->exists($envVar);
95		}
96
97		/**
98		* Clears the env vars storage
99		*
100		* @return void
101		*/
102		public function clearEnvVars()
103		{
104		$this->envVars->clear();
105		}
106		}
107

appserver-io / server

Pull Request — master (#29)

EnvVarsObjectTrait::getEnvVars() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like