Loader::getenv() - Code Metrics - Inspection of "Add some tests" - rfussien/dotenv - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 1cff36...5446cd )

by Rémi

created 2017-02-01 22:07 UTC

Loader::getenv() A

↳ Parent: Loader

Complexity

Conditions	4
Paths	4

Size

Total Lines	12
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	10
CRAP Score	4

Importance

Changes

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

<?php

namespace Rfussien\Dotenv;

class Loader
{
    /**
     * Set the env file
     */
    protected $file;

    protected $parser;

    public function __construct($path, $filename = '.env')
    {
        $path = rtrim($path, DIRECTORY_SEPARATOR);
        $this->file = $path . DIRECTORY_SEPARATOR . $filename;

        return $this;

    }

    /**
     * parse and set the env
     */
    public function load()
    {
        $this->parse();
        $this->toEnv();

        return $this;
    }

    public function parse(array $options = [])

    {
        $this->parser = new Parser;

        $this->parser->parse($this->file);

        return $this;
    }

    /**
     * Return the parser
     */
    public function getParser()
    {
        return $this->parser;
    }

    public function toEnv()
    {
        if (!isset($this->parser)) {
            throw new \LogicException("You must call parse() before", 1);
        }

        foreach ($this->parser->getContent() as $key => $value) {
            static::putenv($key, $value);
        }

        return $this;
    }

    public static function putenv($key, $value)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        $_ENV[$key]    = $value;
        $_SERVER[$key] = $value;

        /*
         * putenv only accept string value
         */
        $value = $value === null ? 'null' : $value;
        putenv("$key=$value");
    }

    public static function getenv($key, $default = null)
// Bad
class Router
{
    public function generate($path)
    {
        return $_SERVER['HOST'].$path;
    }
}

// Better
class Router
{
    private $host;

    public function __construct($host)
    {
        $this->host = $host;
    }

    public function generate($path)
    {
        return $this->host.$path;
    }
}

class Controller
{
    public function myAction(Request $request)
    {
        // Instead of
        $page = isset($_GET['page']) ? intval($_GET['page']) : 1;

        // Better (assuming you use the Symfony2 request)
        $page = $request->query->get('page', 1);
    }
}
    {
        switch (true) {
            case array_key_exists($key, $_ENV):
                return $_ENV[$key];
            case array_key_exists($key, $_SERVER):
                return $_SERVER[$key];
            default:
                $value = getenv($key);
                return $value === false ? $default : $value;
        }
    }
}


1		<?php
2
3		namespace Rfussien\Dotenv;
4
5		class Loader
6		{
7		/**
8		* Set the env file
9		*/
10		protected $file;
11
12		protected $parser;
13
14	18	public function __construct($path, $filename = '.env')
15		{
16	18	$path = rtrim($path, DIRECTORY_SEPARATOR);
17	18	$this->file = $path . DIRECTORY_SEPARATOR . $filename;
18
19	18	return $this;
		0 ignored issues – show Bug introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report Constructors do not have meaningful return values, anything that is returned from here is discarded. Are you sure this is correct? Loading history...
20		}
21
22		/**
23		* parse and set the env
24		*/
25	15	public function load()
26		{
27	15	$this->parse();
28	15	$this->toEnv();
29
30	15	return $this;
31		}
32
33	15	public function parse(array $options = [])
		0 ignored issues – show Unused Code introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report The parameter `$options` is not used and could be removed. This check looks from parameters that have been defined for a function or method, but which are not used in the method body. Loading history...
34		{
35	15	$this->parser = new Parser;
36
37	15	$this->parser->parse($this->file);
38
39	15	return $this;
40		}
41
42		/**
43		* Return the parser
44		*/
45	3	public function getParser()
46		{
47	3	return $this->parser;
48		}
49
50	18	public function toEnv()
51		{
52	18	if (!isset($this->parser)) {
53	3	throw new \LogicException("You must call parse() before", 1);
54		}
55
56	15	foreach ($this->parser->getContent() as $key => $value) {
57	15	static::putenv($key, $value);
58	10	}
59
60	15	return $this;
61		}
62
63	15	public static function putenv($key, $value)
		2 ignored issues – show Coding Style introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report `putenv` uses the super-global variable `$_ENV` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report `putenv` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
64		{
65	15	$_ENV[$key] = $value;
66	15	$_SERVER[$key] = $value;
67
68		/*
69		* putenv only accept string value
70		*/
71	15	$value = $value === null ? 'null' : $value;
72	15	putenv("$key=$value");
73	15	}
74
75	9	public static function getenv($key, $default = null)
		2 ignored issues – show Coding Style introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report `getenv` uses the super-global variable `$_ENV` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history... Coding Style introduced 2017-02-01 16:55 UTC by Report Bug Copy Issue Report `getenv` uses the super-global variable `$_SERVER` which is generally not recommended. Instead of super-globals, we recommend to explicitly inject the dependencies of your class. This makes your code less dependent on global state and it becomes generally more testable: // Bad class Router { public function generate($path) { return $_SERVER['HOST'].$path; } } // Better class Router { private $host; public function __construct($host) { $this->host = $host; } public function generate($path) { return $this->host.$path; } } class Controller { public function myAction(Request $request) { // Instead of $page = isset($_GET['page']) ? intval($_GET['page']) : 1; // Better (assuming you use the Symfony2 request) $page = $request->query->get('page', 1); } } Loading history...
76		{
77	6	switch (true) {
78	9	case array_key_exists($key, $_ENV):
79	3	return $_ENV[$key];
80	6	case array_key_exists($key, $_SERVER):
81	3	return $_SERVER[$key];
82	2	default:
83	3	$value = getenv($key);
84	3	return $value === false ? $default : $value;
85	2	}
86		}
87		}
88

rfussien / dotenv

Push — master ( 1cff36...5446cd )

Loader::getenv() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like