Environment::hasKey() - Code Metrics - Inspection of "Cloud storage library simplifications" - softberg/quantum-php-core - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#223)

by Arman

created 2025-03-18 14:27 UTC

Environment::hasKey() A

↳ Parent: Environment

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	1

Metric	Value
cc	1
eloc	1
c	2
b	0
f	1
nc	1
nop	1
dl	0
loc	3
rs	10

<?php

/**
 * Quantum PHP Framework
 *
 * An open source software development framework for PHP
 *
 * @package Quantum
 * @author Arman Ag. <[email protected]>
 * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
 * @link http://quantum.softberg.org/
 * @since 2.9.6
 */

namespace Quantum\Environment;

use Quantum\Environment\Exceptions\EnvException;
use Quantum\Di\Exceptions\DiException;
use Quantum\Exceptions\BaseException;
use Quantum\Loader\Loader;
use Quantum\Loader\Setup;
use ReflectionException;
use Quantum\App\App;
use Dotenv\Dotenv;
use Quantum\Di\Di;

/**
 * Class Environment
 * @package Quantum\Environment
 * @uses Dotenv
 */
class Environment
{

    /**
     * Environment file
     * @var string
     */
    private $envFile = '.env';

    /**
     * @var bool
     */
    private $isMutable = false;

    /**
     * Loaded env content
     * @var array
     */
    private $envContent = [];

    private static $appEnv = 'production';

    /**
     * Instance of Environment
     * @var Environment
     */
    private static $instance = null;

    /**
     * GetInstance
     * @return Environment
     */
    public static function getInstance(): Environment
    {
        if (self::$instance === null) {
            self::$instance = new self();
        }

        return self::$instance;
    }

    /**
     * @param bool $isMutable
     * @return Environment
     */
    public function setMutable(bool $isMutable): Environment
    {
        $this->isMutable = $isMutable;
        return $this;
    }

    /**
     * Loads environment variables from file
     * @param Setup $setup
     * @return void
     * @throws BaseException
     * @throws EnvException
     * @throws DiException
     * @throws ReflectionException
     */
    public function load(Setup $setup)
    {
        if (!empty($this->envContent)) {
            return;
        }

        $envConfig = Di::get(Loader::class)->setup($setup)->load();

        $appEnv = $envConfig['app_env'] ?? 'production';
        $this->envFile = ".env" . ($appEnv !== 'production' ? ".$appEnv" : '');

        if (!file_exists(App::getBaseDir() . DS . $this->envFile)) {
            throw EnvException::fileNotFound($this->envFile);
        }

        $dotenv = $this->isMutable
            ? Dotenv::createMutable(App::getBaseDir(), $this->envFile)
            : Dotenv::createImmutable(App::getBaseDir(), $this->envFile);

        $this->envContent = $dotenv->load();

        self::$appEnv = $appEnv;
    }

    /**
     * Gets the app current environment
     * @return string
     */
    public function getAppEnv(): string
    {
        return self::$appEnv;
    }

    /**
     * Gets the environment variable value
     * @param string $key
     * @param null|mixed $default
     * @return mixed
     * @throws EnvException
     */
    public function getValue(string $key, $default = null)
    {
        if (empty($this->envContent)) {
            throw EnvException::environmentNotLoaded();
        }

        $val = getenv($key);

        return $val !== false ? $val : $default;
    }

    /**
     * Checks if there is a such key
     * @param string $key
     * @return bool
     */
    public function hasKey(string $key): bool
    {
        return $this->findKeyRow($key) !== null;
    }

    /**
     * Gets the row of .env file by given key
     * @param string $key
     * @return string|null
     */
    public function getRow(string $key): ?string
    {
        return $this->findKeyRow($key);
    }

    /**
     * Creates or updates the row in .env
     * @param string $key
     * @param string|null $value
     * @throws EnvException
     */
    public function updateRow(string $key, ?string $value)
    {
        if (!$this->isMutable) {
            throw EnvException::environmentImmutable();
        }

        if (empty($this->envContent)) {
            throw EnvException::environmentNotLoaded();
        }

        $row = $this->getRow($key);

        $envFilePath = App::getBaseDir() . DS . $this->envFile;

        if ($row) {
            $envFileContent = file_get_contents($envFilePath);
            $envFileContent = preg_replace('/^' . preg_quote($row, '/') . '/m', $key . "=" . $value, $envFileContent);
            file_put_contents($envFilePath, $envFileContent);
        } else {
            file_put_contents($envFilePath, PHP_EOL . $key . "=" . $value . PHP_EOL, FILE_APPEND);
        }

        $this->envContent = Dotenv::createMutable(App::getBaseDir(), $this->envFile)->load();
    }

    /**
     * @param string $key
     * @return string|null
     */
    private function findKeyRow(string $key): ?string
    {
        foreach ($this->envContent as $index => $row) {
            if (preg_match('/^' . $key . '/', $index)) {
                return $key . '=' . preg_quote($row, '/');
            }
        }

        return null;
    }
}

1			<?php
2
3			/**
4			* Quantum PHP Framework
5			*
6			* An open source software development framework for PHP
7			*
8			* @package Quantum
9			* @author Arman Ag. <[email protected]>
10			* @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
11			* @link http://quantum.softberg.org/
12			* @since 2.9.6
13			*/
14
15			namespace Quantum\Environment;
16
17			use Quantum\Environment\Exceptions\EnvException;
18			use Quantum\Di\Exceptions\DiException;
19			use Quantum\Exceptions\BaseException;
20			use Quantum\Loader\Loader;
21			use Quantum\Loader\Setup;
22			use ReflectionException;
23			use Quantum\App\App;
24			use Dotenv\Dotenv;
25			use Quantum\Di\Di;
26
27			/**
28			* Class Environment
29			* @package Quantum\Environment
30			* @uses Dotenv
31			*/
32			class Environment
33			{
34
35			/**
36			* Environment file
37			* @var string
38			*/
39			private $envFile = '.env';
40
41			/**
42			* @var bool
43			*/
44			private $isMutable = false;
45
46			/**
47			* Loaded env content
48			* @var array
49			*/
50			private $envContent = [];
51
52			private static $appEnv = 'production';
53
54			/**
55			* Instance of Environment
56			* @var Environment
57			*/
58			private static $instance = null;
59
60			/**
61			* GetInstance
62			* @return Environment
63			*/
64			public static function getInstance(): Environment
65			{
66			if (self::$instance === null) {
67			self::$instance = new self();
68			}
69
70			return self::$instance;
71			}
72
73			/**
74			* @param bool $isMutable
75			* @return Environment
76			*/
77			public function setMutable(bool $isMutable): Environment
78			{
79			$this->isMutable = $isMutable;
80			return $this;
81			}
82
83			/**
84			* Loads environment variables from file
85			* @param Setup $setup
86			* @return void
87			* @throws BaseException
88			* @throws EnvException
89			* @throws DiException
90			* @throws ReflectionException
91			*/
92			public function load(Setup $setup)
93			{
94			if (!empty($this->envContent)) {
95			return;
96			}
97
98			$envConfig = Di::get(Loader::class)->setup($setup)->load();
99
100			$appEnv = $envConfig['app_env'] ?? 'production';
101			$this->envFile = ".env" . ($appEnv !== 'production' ? ".$appEnv" : '');
102
103			if (!file_exists(App::getBaseDir() . DS . $this->envFile)) {
104			throw EnvException::fileNotFound($this->envFile);
105			}
106
107			$dotenv = $this->isMutable
108			? Dotenv::createMutable(App::getBaseDir(), $this->envFile)
109			: Dotenv::createImmutable(App::getBaseDir(), $this->envFile);
110
111			$this->envContent = $dotenv->load();
112
113			self::$appEnv = $appEnv;
114			}
115
116			/**
117			* Gets the app current environment
118			* @return string
119			*/
120			public function getAppEnv(): string
121			{
122			return self::$appEnv;
123			}
124
125			/**
126			* Gets the environment variable value
127			* @param string $key
128			* @param null\|mixed $default
129			* @return mixed
130			* @throws EnvException
131			*/
132			public function getValue(string $key, $default = null)
133			{
134			if (empty($this->envContent)) {
135			throw EnvException::environmentNotLoaded();
136			}
137
138			$val = getenv($key);
139
140			return $val !== false ? $val : $default;
141			}
142
143			/**
144			* Checks if there is a such key
145			* @param string $key
146			* @return bool
147			*/
148			public function hasKey(string $key): bool
149			{
150			return $this->findKeyRow($key) !== null;
151			}
152
153			/**
154			* Gets the row of .env file by given key
155			* @param string $key
156			* @return string\|null
157			*/
158			public function getRow(string $key): ?string
159			{
160			return $this->findKeyRow($key);
161			}
162
163			/**
164			* Creates or updates the row in .env
165			* @param string $key
166			* @param string\|null $value
167			* @throws EnvException
168			*/
169			public function updateRow(string $key, ?string $value)
170			{
171			if (!$this->isMutable) {
172			throw EnvException::environmentImmutable();
173			}
174
175			if (empty($this->envContent)) {
176			throw EnvException::environmentNotLoaded();
177			}
178
179			$row = $this->getRow($key);
180
181			$envFilePath = App::getBaseDir() . DS . $this->envFile;
182
183			if ($row) {
184			$envFileContent = file_get_contents($envFilePath);
185			$envFileContent = preg_replace('/^' . preg_quote($row, '/') . '/m', $key . "=" . $value, $envFileContent);
186			file_put_contents($envFilePath, $envFileContent);
187			} else {
188			file_put_contents($envFilePath, PHP_EOL . $key . "=" . $value . PHP_EOL, FILE_APPEND);
189			}
190
191			$this->envContent = Dotenv::createMutable(App::getBaseDir(), $this->envFile)->load();
192			}
193
194			/**
195			* @param string $key
196			* @return string\|null
197			*/
198			private function findKeyRow(string $key): ?string
199			{
200			foreach ($this->envContent as $index => $row) {
201			if (preg_match('/^' . $key . '/', $index)) {
202			return $key . '=' . preg_quote($row, '/');
203			}
204			}
205
206			return null;
207			}
208			}

softberg / quantum-php-core

Pull Request — master (#223)

Environment::hasKey() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like