Parser::parseEnv() - Code Metrics - Enjoyzz/dotenv - Measure and Improve Code Quality continuously with Scrutinizer

Parser::parseEnv() A
last analyzed 2025-04-13 20:09 UTC

↳ Parent: Parser

Complexity

Conditions	3
Paths	3

Size

Total Lines	11
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	3

Importance

Changes

Metric	Value
cc	3
eloc	6
c	0
b	0
f	0
nc	3
nop	1
dl	0
loc	11
ccs	6
cts	6
cp	1
crap	3
rs	10

<?php

declare(strict_types=1);


namespace Enjoys\Dotenv\Parser;


use Enjoys\Dotenv\Parser\Env\Comment;
use Enjoys\Dotenv\Parser\Env\Key;
use Enjoys\Dotenv\Parser\Env\Value;
use Enjoys\Dotenv\Parser\Lines\CommentLine;
use Enjoys\Dotenv\Parser\Lines\EmptyLine;
use Enjoys\Dotenv\Parser\Lines\EnvLine;
use Enjoys\Dotenv\Parser\Lines\LineInterface;
use Enjoys\Dotenv\Parser\Lines\Multiline;

final class Parser implements ParserInterface
{

    /**
     * @param string $content
     * @return array<string, string|null>
     */
    #[\Override]
    public function parseEnv(string $content): array
    {
        $envArray = [];
        /** @var LineInterface $line */
        foreach ($this->parseLines($content) as $line) {
            if ($line instanceof EnvLine) {
                $envArray[$line->getKey()->getValue()] = $line->getValue()?->getValue();
            }
        }
        return $envArray;
    }

    /**
     * @param string $content
     * @return array<array-key, LineInterface>

     */
    #[\Override]
    public function parseStructure(string $content): array
    {
        $structure = [];
        /** @var LineInterface $line */
        foreach ($this->parseLines($content) as $line) {
            if ($line instanceof EnvLine) {
                $structure[$line->getKey()->getValue()] = $line;
                continue;
            }
            $structure[] = $line;
        }
        return $structure;
    }

    public function parseLines(string $content): \Generator
    {
        $contentSplit = preg_split("/\R/u", $content);
        foreach (
            Multiline::handle(
                array_map(
                    'trim',
                    $contentSplit === false ? [] : $contentSplit
                )
            ) as $line
        ) {
            if (empty($line)) {
                yield new EmptyLine();
                continue;
            }

            if (str_starts_with($line, '#')) {
                yield new CommentLine($line);
                continue;
            }

            [$key, $value, $comment] = $this->parseEnvLine($line);
            yield new EnvLine(
                $key,
                $value,
                $comment
            );
        }
    }

    /**
     * @param string $rawLine
     * @return list{Key, ?Value, ?Comment}
filter:
    dependency_paths: ["lib/*"]
     */
    private function parseEnvLine(string $rawLine): array
    {
        /**
         * $explodedLine[0] - rawKey
         * $explodedLine[1] - rawValue
         * @var string[] $explodedLine
         */
        $explodedLine = array_map('trim', explode('=', $rawLine, 2));

        return [
            new Key($explodedLine[0]),
            ...$this->parseValue($explodedLine[1] ??= null)
        ];
    }

    /**
     * @param string|null $rawValue
     * @return list{?Value, ?Comment}
     */
    private function parseValue(?string $rawValue): array
    {
        if ($rawValue === null) {
            return [

                null,
                null
            ];
        }

        preg_match(
            '/^(?<value>([\'"])(?:(?!\1|\\\\).|\\\\.)*?\2)(?<comment>.*)?/',
            $rawValue,
            $matches,
            PREG_UNMATCHED_AS_NULL
        );

        $matches['value'] ??= false;
        $matches['comment'] ??= null;

        if ($matches['value'] !== false) {
            return [

                new Value($matches['value']),
                ($matches['comment'] === '' || $matches['comment'] === null) ? null : new Comment($matches['comment'])
            ];
        }

        $unquotedValue = array_map('trim', explode('#', $rawValue, 2));
        $value = $unquotedValue[0];
        $comment = $unquotedValue[1] ?? null;
        return [

            new Value($value),
            $comment !== null ? new Comment($comment) : null
        ];
    }

}


1		<?php
2
3		declare(strict_types=1);
4
5
6		namespace Enjoys\Dotenv\Parser;
7
8
9		use Enjoys\Dotenv\Parser\Env\Comment;
10		use Enjoys\Dotenv\Parser\Env\Key;
11		use Enjoys\Dotenv\Parser\Env\Value;
12		use Enjoys\Dotenv\Parser\Lines\CommentLine;
13		use Enjoys\Dotenv\Parser\Lines\EmptyLine;
14		use Enjoys\Dotenv\Parser\Lines\EnvLine;
15		use Enjoys\Dotenv\Parser\Lines\LineInterface;
16		use Enjoys\Dotenv\Parser\Lines\Multiline;
17
18		final class Parser implements ParserInterface
19		{
20
21		/**
22		* @param string $content
23		* @return array<string, string\|null>
24		*/
25	43	#[\Override]
26		public function parseEnv(string $content): array
27		{
28	43	$envArray = [];
29		/** @var LineInterface $line */
30	43	foreach ($this->parseLines($content) as $line) {
31	42	if ($line instanceof EnvLine) {
32	42	$envArray[$line->getKey()->getValue()] = $line->getValue()?->getValue();
33		}
34		}
35	41	return $envArray;
36		}
37
38		/**
39		* @param string $content
40		* @return array<array-key, LineInterface>
		0 ignored issues – show Documentation Bug introduced 2022-09-11 18:45 UTC by Report Bug Copy Issue Report The doc comment `array<array-key, LineInterface>` at position `2` could not be parsed: Unknown type name 'array-key' at position 2 in array<array-key, LineInterface>. Loading history...
41		*/
42	2	#[\Override]
43		public function parseStructure(string $content): array
44		{
45	2	$structure = [];
46		/** @var LineInterface $line */
47	2	foreach ($this->parseLines($content) as $line) {
48	2	if ($line instanceof EnvLine) {
49	2	$structure[$line->getKey()->getValue()] = $line;
50	2	continue;
51		}
52	2	$structure[] = $line;
53		}
54	2	return $structure;
55		}
56
57	54	public function parseLines(string $content): \Generator
58		{
59	54	$contentSplit = preg_split("/\R/u", $content);
60		foreach (
61	54	Multiline::handle(
62	54	array_map(
63	54	'trim',
64	54	$contentSplit === false ? [] : $contentSplit
65	54	)
66	54	) as $line
67		) {
68	54	if (empty($line)) {
69	43	yield new EmptyLine();
70	43	continue;
71		}
72
73	53	if (str_starts_with($line, '#')) {
74	9	yield new CommentLine($line);
75	9	continue;
76		}
77
78	53	[$key, $value, $comment] = $this->parseEnvLine($line);
79	52	yield new EnvLine(
80	52	$key,
81	52	$value,
82	52	$comment
83	52	);
84		}
85		}
86
87		/**
88		* @param string $rawLine
89		* @return list{Key, ?Value, ?Comment}
		0 ignored issues – show Bug introduced 2023-08-27 19:19 UTC by Report Bug Copy Issue Report The type `Enjoys\Dotenv\Parser\list` was not found. Maybe you did not declare it correctly or list all dependencies? The issue could also be caused by a filter entry in the build configuration. If the path has been excluded in your configuration, e.g. `excluded_paths: ["lib/"]`, you can move it to the dependency path list as follows: filter: dependency_paths: ["lib/"] For further information see https://scrutinizer-ci.com/docs/tools/php/php-scrutinizer/#list-dependency-paths Loading history...
90		*/
91	53	private function parseEnvLine(string $rawLine): array
92		{
93		/**
94		* $explodedLine[0] - rawKey
95		* $explodedLine[1] - rawValue
96		* @var string[] $explodedLine
97		*/
98	53	$explodedLine = array_map('trim', explode('=', $rawLine, 2));
99
100	53	return [
101	53	new Key($explodedLine[0]),
102	53	...$this->parseValue($explodedLine[1] ??= null)
103	53	];
104		}
105
106		/**
107		* @param string\|null $rawValue
108		* @return list{?Value, ?Comment}
109		*/
110	52	private function parseValue(?string $rawValue): array
111		{
112	52	if ($rawValue === null) {
113	10	return [
		0 ignored issues – show Bug Best Practice introduced 2023-08-27 19:19 UTC by Report Bug Copy Issue Report The expression `return array(null, null)` returns the type `array<integer,null>` which is incompatible with the documented return type `Enjoys\Dotenv\Parser\list`. Loading history...
114	10	null,
115	10	null
116	10	];
117		}
118
119	46	preg_match(
120	46	'/^(?<value>([\'"])(?:(?!\1\|\\\\).\|\\\\.)?\2)(?<comment>.)?/',
121	46	$rawValue,
122	46	$matches,
123	46	PREG_UNMATCHED_AS_NULL
124	46	);
125
126	46	$matches['value'] ??= false;
127	46	$matches['comment'] ??= null;
128
129	46	if ($matches['value'] !== false) {
130	22	return [
		0 ignored issues – show Bug Best Practice introduced 2025-04-13 20:06 UTC by Report Bug Copy Issue Report The expression `return array(new Enjoys\...t($matches['comment']))` returns the type `array<integer,Enjoys\Dot...\Parser\Env\Value\|null>` which is incompatible with the documented return type `Enjoys\Dotenv\Parser\list`. Loading history...
131	22	new Value($matches['value']),
132	22	($matches['comment'] === '' \|\| $matches['comment'] === null) ? null : new Comment($matches['comment'])
133	22	];
134		}
135
136	42	$unquotedValue = array_map('trim', explode('#', $rawValue, 2));
137	42	$value = $unquotedValue[0];
138	42	$comment = $unquotedValue[1] ?? null;
139	42	return [
		0 ignored issues – show Bug Best Practice introduced 2025-04-13 20:06 UTC by Report Bug Copy Issue Report The expression `return array(new Enjoys\...mment($comment) : null)` returns the type `array<integer,Enjoys\Dot...\Parser\Env\Value\|null>` which is incompatible with the documented return type `Enjoys\Dotenv\Parser\list`. Loading history...
140	42	new Value($value),
141	42	$comment !== null ? new Comment($comment) : null
142	42	];
143		}
144
145		}
146

Enjoyzz / dotenv

GitHub Access Token became invalid

Parser::parseEnv() A last analyzed 2025-04-13 20:09 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Parser::parseEnv() A
last analyzed 2025-04-13 20:09 UTC