maestriam / samurai

src/Entities/Foundation.php

<?php

namespace Maestriam\Samurai\Entities;

use Maestriam\Samurai\Foundation\ConfigKeeper;
use Maestriam\Samurai\Foundation\EnvHandler;
use Maestriam\Samurai\Foundation\FileSystem;
use Maestriam\Samurai\Concerns\WithFileNominator;
use Maestriam\Samurai\Foundation\FilenameParser;
use Maestriam\Samurai\Foundation\SyntaxValidator;
use Maestriam\Samurai\Foundation\DirectoryStructure;

class Foundation
{
    use WithFileNominator;

    /**
     * Classe auxiliar para gerenciamento de estrutura de diretórios
     * dentor do projeto
     *
     * @var DirectoryStructure
     */
    private $dir;

    /**
     * Classe auxiliar para criação de arquivos/diretórios
     * dentro do projeto
     *
     * @var FileSystem
     */
    private $file;

    /**
     * Classe auxiliar para validação de nome de diretivas/temas
     * e verificações de tipos
     *
     * @var SyntaxValidator
     */
    private $valid;

    /**
     * Instância do helper para atualizar arquivos .env
     *
     * @var EnvHandler
     */
    private $env;

    /**
     * Instância do helper para
     *
     * @var ConfigKeeper
     */
    private $config;
    
    /**
     * Instância do parser de filepath para objeto
     *
     * @var FilenameParser
     */
    private $parser;

    /**
     * Retorna uma instância auxiliar para 
     * tarefas de sistema de arquivos
     *
     * @return void
     */
    protected function file() : FileSystem
    {
        if ($this->file == null) {
            $this->file = new FileSystem();
        }

        return $this->file;

The expression return $this->file returns the type Maestriam\Samurai\Foundation\FileSystem which is incompatible with the documented return type void.

    }

    /**
     * Classe auxiliar para validar a sintaxe das informações preenchidas 
     * sobre o tema
     *
     * @return SyntaxValidator
     */
    protected function valid() : SyntaxValidator
    {
        if ($this->valid == null) {
            $this->valid = new SyntaxValidator();
        }

        return $this->valid;
    }

    /**
     * Classe auxiliar para  instância de RN sobre 
     * estrutura de pasta do tema
     *
     * @return DirectoryStructure
     */
    protected function dir() : DirectoryStructure
    {
        if ($this->dir == null) {
            $this->dir = new DirectoryStructure();
        }

        return $this->dir;
    }

    /**
     * Classe auxiliar para retorno das informações de configurações do pacote
     *
     * @return void
     */
    protected function config() : ConfigKeeper
    {
        if (! $this->config) {
            $this->config = new ConfigKeeper();
        }

        return $this->config;

The expression return $this->config returns the type Maestriam\Samurai\Foundation\ConfigKeeper which is incompatible with the documented return type void.

    }

    /**
     * Classe auxiliar para identificar o nome e o tipo da diretiva, 
     * através de seu caminho absoluto
     *
     * @param  string $file
     * @return object|null
     */
    protected function parser() : FilenameParser
    {
        if ($this->parser == null) {
            $this->parser = new FilenameParser();
        }

        return $this->parser;
    }
    
    /**
     * Classe auxiliar para modificar o arquivo .env do projeto Laravel
     *
     * @return EnvHandler
     */
    protected function env() : EnvHandler
    {
        if (! $this->env) {
            $this->env = new EnvHandler();
        }

        return $this->env;
    }
}