maestriam / samurai

src/Foundation/EnvHandler.php

<?php

namespace Maestriam\Samurai\Foundation;

use Maestriam\Samurai\Exceptions\EnvNotFoundException;

class EnvHandler
{
    protected $filename;

    public function __construct()
    {
        if (! $this->exists()) {
            $this->initEnv();
        }
    }
    
    /**
     * Cria um novo arquivo de configurações do ambiente do projeto
     *
     * @param  string $custom
     * @return integer
     */
    public function initEnv() : int
    {        
        return touch($this->file());

The expression return touch($this->file()) returns the type boolean which is incompatible with the type-hinted return integer.

    }

    /**
     * Retorna o nome do arquivo de configurações de ambiente do projeto
     *
     * @return string
     */
    public function file() : string
    {
        $file = config('samurai.env_file') ?? '.env';

        return base_path($file);
    }

    /**
     * Undocumented function
     *
     * @param  string $key
     * @param  string $value
     * @return void
     */
    public function set(string $key, string $value)
    {
        $line = $this->existsKey($key);

        if ($line == null) {

It seems like you are loosely comparing $line of type integer|null against null; this is ambiguous if the integer can be zero. Consider using a strict comparison === instead.

            return $this->append($key, $value);

Are you sure the usage of $this->append($key, $value) targeting Maestriam\Samurai\Foundation\EnvHandler::append() seems to always return null.

        }

        return $this->change($line, $key, $value);

Are you sure the usage of $this->change($line, $key, $value) targeting Maestriam\Samurai\Foundation\EnvHandler::change() seems to always return null.

    }

    /**
     * Retorna o valor de uma chave dentro .env
     *
     * @param  string $key
     * @return string|null
     */
    public function get(string $key) : ?string
    {
        $no = $this->existsKey($key);

        if ($no === null) { return null;
        }

        $lines = $this->lines();

        $pieces = explode('=', $lines[$no]);

        return $pieces[1];
    }

    /**
     * Verifica se uma chave existe no arquivo de .env
     * Se existir, retorna seu índice dentro do array
     * Caso contrário, nulo
     *
     * @param  string $key
     * @return integer|null
     */
    public function existsKey(string $key) : ?int
    {
        $search  = null;
        $lines   = $this->lines();
        $pattern = strtoupper('/'. $key . '=/');

        if (empty($lines)) { return null;
        }

        foreach($lines as $no => $line) {
            if (preg_match($pattern, $line)) {
                $search = $no;
            }
        }

        return $search;
    }

    /**
     * Retorna todas as linhas do arquivo de configuração
     * dividas em um array
     *
     * @return array
     */
    private function lines() : array
    {
        $content = $this->content();

        return explode("\n", $content);
    }

    /**
     * Verifica se o arquivo .env está configurado
     * corretamente na base do projeto
     *
     * @return void
     */
    public function exists() : bool
    {
        return is_file($this->file());

The expression return is_file($this->file()) returns the type boolean which is incompatible with the documented return type void.

    }

    /**
     * Retorna o conteúdo do arquivo .env
     *
     * @return string
     */
    public function content() : string
    {
        if (! $this->exists()) {
            throw new EnvNotFoundException();
        }

        return file_get_contents($this->file());
    }

    /**
     * Adiciona uma nova chave no arquivo .env
     *
     * @param  string $key
     * @param  string $value
     * @return void
     */
    private function append(string $key, string $value)
    {
        $lines   = $this->lines();
        $content = strtoupper($key) . '=' . $value;
        $lines[] = $content;

        return $this->store($lines);

Are you sure the usage of $this->store($lines) targeting Maestriam\Samurai\Foundation\EnvHandler::store() seems to always return null.

    }

    /**
     * Substitui o valor de uma chave exsitente
     * no arquivo .env
     *
     * @param  string $key
     * @param  string $value
     * @return void
     */
    private function change(int $line, string $key, string $value)
    {
        $lines   = $this->lines();
        $content = strtoupper($key) . '=' . $value;

        $lines[$line] = $content;

        return $this->store($lines);

Are you sure the usage of $this->store($lines) targeting Maestriam\Samurai\Foundation\EnvHandler::store() seems to always return null.

    }

    /**
     * Undocumented function
     *
     * @param  array $lines
     * @return void
     */
    private function store(array $lines)
    {
        $content = implode("\n", $lines);

        return file_put_contents($this->file(), $content);

The expression return file_put_contents($this->file(), $content) returns the type integer which is incompatible with the documented return type void.

    }
}