Enjoyzz / dotenv

src/Parser/Parser.php

<?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>

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>.

     */
    #[\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}

The type Enjoys\Dotenv\Parser\list was not found. Maybe you did not declare it correctly or list all dependencies?

     */
    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 [

The expression return array(null, null) returns the type array<integer,null> which is incompatible with the documented return type Enjoys\Dotenv\Parser\list.

                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 [

The expression return array(new Enjoys\Dotenv\Parser\Env\Value($matches['value']), $matches['comment'] === '' || $matches['comment'] === null ? null : new Enjoys\Dotenv\Parser\Env\Comment($matches['comment'])) returns the type array<integer,Enjoys\Dotenv\Parser\Env\Comment|Enjoys\Dotenv\Parser\Env\Value|null> which is incompatible with the documented return type Enjoys\Dotenv\Parser\list.

                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 [

The expression return array(new Enjoys\Dotenv\Parser\Env\Value($value), $comment !== null ? new Enjoys\Dotenv\Parser\Env\Comment($comment) : null) returns the type array<integer,Enjoys\Dotenv\Parser\Env\Comment|Enjoys\Dotenv\Parser\Env\Value|null> which is incompatible with the documented return type Enjoys\Dotenv\Parser\list.

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

}