Env::getCurrentPath() - Code Metrics - Inspection of "Merge pull request #10 from dgagnon/dgagnon-patch-..." - zemit-cms/core - Measure and Improve Code Quality continuously with Scrutinizer

Test Failed
Push — master ( ffc597...4abc3b )

by Julien
created 2022-03-29 00:25 UTC
Env::getCurrentPath() A

↳ Parent: Env
Complexity

Conditions	3
Paths	3
Size

Total Lines	11
Code Lines	5
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	4
CRAP Score	3.3332
Importance

Changes	1
Bugs	1	Features	0
Metric	Value
eloc	5
c	1
b	1
f	0
dl	0
loc	11
ccs	4
cts	6
cp	0.6667
rs	10
cc	3
nc	3
nop	0
crap	3.3332
<?php
/**
 * This file is part of the Zemit Framework.
 *
 * (c) Zemit Team <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE.txt
 * file that was distributed with this source code.
 */

namespace Zemit\Utils;

use Dotenv\Dotenv;

/**
 * Class Env
 * Allow to access environment variable easily
 *
 * Example usage:
 * ```php
 * $this->SET_APPLICATION_ENV('production'); // SET APPLICATION_ENV to 'production'
 * self::SET_APPLICATION_ENV('production'); // SET APPLICATION_ENV to 'production'
 * $this->GET_APPLICATION_ENV('default'); // GET APPLICATION_ENV value or 'default'
 * self::GET_APPLICATION_ENV('default'); // GET APPLICATION_ENV value or 'default'
 * ```
 *
 * @todo fix dotenv mandatory file
 * @author Julien Turbide <[email protected]>
 * @copyright Zemit Team <[email protected]>
 *
 * @since 1.0
 * @version 1.0
 *
 * @package Zemit\Utils
 */
class Env
{
    /**
     * @var array
     */
    public static $vars;
    
    /**
     * Dotenv loader to manage the environment varialbe
     * @var \Dotenv\Loader
     */
    public static $dotenv;
    
    /**
     * Get the dotenv loader
     * @return \Dotenv\Loader
     */
    public static function getDotenv(array $filePath = null)
    {
        $filePath ??= self::getCurrentPath();
        $envFilePath = $filePath . '/.env';
        
        if (is_readable($envFilePath)) {
            self::$dotenv ??= Dotenv::create($filePath);
            self::$dotenv ??= Dotenv::create(/** @scrutinizer ignore-type */ $filePath);
            self::$vars ??= self::$dotenv->load();
        }
    
        self::$vars ??= getenv();
        return self::$dotenv;
    }
    
    /**
     * @return false|mixed|string
     */
    public static function getCurrentPath() {
        
        if (!empty($_SERVER['DOCUMENT_ROOT'])) {
            return dirname($_SERVER['DOCUMENT_ROOT']);
        }
        
        if (defined('ENV_PATH')) {
            return constant('ENV_PATH');
        }
        
        return getcwd();
    }
    
    /**
     * Get or set the environment variable
     * Ex. (SET): $this->SET_APPLICATION_ENV('production');
     * Ex. (SET): self::SET_APPLICATION_ENV('production');
     * Ex. (SET): Env::SET_APPLICATION_ENV('production');
     * Ex. (GET): $this->GET_APPLICATION_ENV('development');
     * Ex. (GET): self::GET_APPLICATION_ENV('development');
     * Ex. (GET): Env::GET_APPLICATION_ENV('development');
     * @param string $name key to get/set
     * @param mixed $arguments Default fallback value for get, or value to set for set
     * @return mixed Return void for set, and return the environment variable value, or default value for get
     */
    public static function call($name, $arguments)
    {
        $ret = null;

        $getSet = 'set';
        if (strpos($name, 'SET_') === 0) {
            $name = substr($name, 0, 4);
        } elseif (strpos($name, 'set') === 0) {
            $name = substr($name, 0, 3);
        } elseif (strpos($name, 'GET_') === 0) {
            $getSet = 'get';
            $name = substr($name, 0, 4);
        } elseif (strpos($name, 'get') === 0) {
            $getSet = 'get';
            $name = substr($name, 0, 3);
        }
        return self::$getSet($name, array_pop($arguments));
    }
    
    /**
     * Gets the value of an environment variable. Passe the $default for fallback value.
     * @param string $key Key to get
     * @param mixed $default Value to fallback if the key can't be found
     * @return mixed Return the environment variable value or the default value
     */
    public static function get($key, $default = null)
    {
        self::getDotenv();
        
        $ret = self::$vars[$key] ?? null;
        $ret ??= ($default instanceof Closure) ? $default() : $default;

        
        if (is_string($ret)) {
            switch (strtolower($ret)) {
                case 'true':
                    $ret = true;
                    break;
                case 'false':
                    $ret = false;
                    break;
                case 'empty':
                    $ret = '';
                    break;
                case 'null':
                    $ret = null;
                    break;
            }
        }
    
        return $ret;
    }
    
    /**
     * Set an environment variable
     * @param $key string Key to set
     * @param $value mixed Value to set
     */
    public static function set($key, $value)
    {
        $dotenv = self::getDotenv();
        $dotenv? $dotenv->setEnvironmentVariable($key, $value) : $_ENV[$key] = $value;

    }
    
    /**
     * Return the environnement variable
     * @param $name Env key to fetch
     * @return mixed Env value
     */
    public function __get($name)
    {
        return self::get($name);
    }
    
    /**
     * Set the environnement variable
     * @param $name string Env key to set
     * @param $value mixed Value to set
     */
    public function __set(string $name, $value)
    {
        self::set($name, $value);
    }
    
    /**
     * Get or set the environment variable
     * Ex. (SET): self::SET_APPLICATION_ENV('production');
     * Ex. (SET): Env::SET_APPLICATION_ENV('production');
     * Ex. (GET): self::GET_APPLICATION_ENV('development');
     * Ex. (GET): Env::GET_APPLICATION_ENV('development');
     * @param $name string Key to get/set
     * @param $arguments array Default fallback value for get, or value to set for set
     * @return mixed Return void for set, and return the environment variable value, or default value for get
     */
    public static function __callStatic(string $name, array $arguments)
    {
        return self::call($name, $arguments);
    }
    
    /**
     * Get or set the environment variable
     * Ex. (SET): $this->SET_APPLICATION_ENV('production');
     * Ex. (GET): $this->GET_APPLICATION_ENV('development');
     * @param $name string Key to get/set
     * @param $arguments array Default fallback value for get, or value to set for set
     * @return mixed Return void for set, and return the environment variable value, or default value for get
     */
    public function __call(string $name, array $arguments)
    {
        return self::call($name, $arguments);
    }
}

zemit-cms / core

Push — master ( ffc597...4abc3b )

Env::getCurrentPath() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
