maestriam / filesystem

src/Foundation/Drive.php

<?php

namespace Maestriam\FileSystem\Foundation;

use Illuminate\Support\Facades\Cache;
use Maestriam\FileSystem\Concerns\FluentGetter;
use Maestriam\FileSystem\Foundation\Drive\StructureDirectory;

class Drive
{
    use FluentGetter;
    
    /**
     * Nome do driver que será manipulado
     */
    private string $name;

    /**
     * Instância responsável pelas RNs sobre diretórios
     */
    private StructureDirectory $structure;    

    /**
     * Driver para manipulações de arquivos
     *
     * @param string $name
     */
    public function __construct(string $name)
    {
        $this->initStructure()->setName($name);

        if (! $this->exists()) {
            return $this;
        }

        return $this->load();
    }

    /**
     * Carrega as informações do drive salvas no cache
     *
     * @return Drive
     */
    private function load() : Drive
    {
        $name = $this->getName();
        $cached = Cache::get($name);

        $structure = $cached['structure'];

        $this->setName($cached['name']);

        $this->structure()->root($structure['root']);
        $this->structure()->template($structure['template']);        
        $this->structure()->paths($structure['paths']);

        return $this;
    }

    /**
     * Cria instância para manipulações de diretórios
     *
     * @return Drive
     */
    private function initStructure() : Drive
    {
        $this->structure = new StructureDirectory();

        return $this;
    }

    /**
     * Define o nome do drive que será manipulado
     *
     * @param string $name
     * @return Drive
     */
    private function setName(string $name) : Drive
    {
        $this->name = $name;

        return $this;
    }

    /**
     * Retorna o nome do drive
     *
     * @return string
     */
    private function getName() : string
    {
        return $this->name;
    }

    /**
     * Retorna a instância para manipulação de arquivos baseado em um template,
     * sobre as configurações deste driver
     *
     * @param string $name
     * @return File
     */
    public function template(string $name) : Template
    {
        return new Template($name, $this->structure);

The expression return new Maestriam\FileSystem\Foundation\Template($name, $this->structure) returns the type Maestriam\FileSystem\Foundation\Template which is incompatible with the documented return type Maestriam\FileSystem\Foundation\File.

    }

    /**
     * Retorna a estrutura de diretórios defindos no drive
     *
     * @return StructureDirectory
     */
    public function structure() : StructureDirectory
    {
        return $this->structure;
    }

    /**
     * Converte as  informações do objeto para um array
     *
     * @return array
     */
    private function toArray() : array
    {
        return [
            'name' => $this->name,
            'structure' => [
                'root'     => $this->structure->root(),
                'paths'    => $this->structure->paths(),
                'template' => $this->structure->template(),
            ]
        ];
    }

    /**
     * Salva as informações definidas do drive no cache da aplicação
     *
     * @return void
     */
    public function save()
    {
        Cache::add($this->name, $this->toArray());

        return $this;   

The expression return $this returns the type Maestriam\FileSystem\Foundation\Drive which is incompatible with the documented return type void.

    }

    /**
     * Retorna se o drive existe no cache
     *
     * @return boolean
     */
    public function exists() : bool
    {   
        $name = $this->getName();

        $cached = Cache::get($name);

        return (! $cached) ? false : true;
    }
}