Maestriam\FileSystem\Foundation\Drive\StructureDirectory

Complexity

Total Complexity

14

Size/Duplication

Total Lines	161
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	findByTemplate()	0	7	1
A	getPaths()	0	3	1
A	template()	0	3	2
A	setTemplate()	0	5	1
A	root()	0	3	2
A	getTemplate()	0	3	1
A	setRoot()	0	5	1
A	paths()	0	7	2
A	getRoot()	0	3	1
A	initFinder()	0	7	1
A	setPaths()	0	5	1

<?php

namespace Maestriam\FileSystem\Foundation\Drive;

use Maestriam\FileSystem\Concerns\FluentGetter;

class StructureDirectory
{    
    use FluentGetter;

    /**
     * Caminho-raíz do projeto
     */
    private string $rootPath = '.';

    /**
     * Caminho onde está os arquivos de template
     */
    private string $templatePath = '.';

    /**
     * Lista de caminhos de template
     */
    private array $pathList = [];

    /**
     * Busc
     */
    private PathFinder $finder;

    /**
     * Define/Retorna o caminho-raíz do projeto, 
     * de acordo com o tipo de parâmetro 
     *
     * @param string $path
     * @return mixed
     */
    public function root(string $path = null)
    {
        return (! $path) ? $this->getRoot() : $this->setRoot($path);
    }
    
    /**
     * Define o caminho-raiz do projeto
     *
     * @param string $path
     * @return StructureDirectory
     */
    public function setRoot(string $path) : StructureDirectory
    {
        $this->rootPath = $path;
        
        return $this;
    }
    
    /**
     * Retorna o caminho-raiz do projeto
     *
     * @param string $path
     * @return StructureDirectory
     */
    private function getRoot() : string
    {
        return $this->rootPath;

The expression return $this->rootPath returns the type string which is incompatible with the documented return type Maestriam\FileSystem\Foundation\Drive\StructureDirectory.

    }

    /**
     * Define/Retorna o caminho de diretório de templates 
     *
     * @param string $path
     * @return mixed
     */
    public function template(string $path = null)
    {
        return (! $path) ? $this->getTemplate() : $this->setTemplate($path);
    }

    /**
     * Define o caminho de templates 
     *
     * @param string $path
     * @return mixed
     */    
    public function setTemplate(string $path) : StructureDirectory
    {
        $this->templatePath = $path;
        
        return $this;
    }

    /**
     * Retorna o caminho de templates 
     *
     * @param string $path
     * @return mixed
     */
    private function getTemplate() : string
    {
        return $this->templatePath;
    }
    
     /**
     * Retorna caminho baseado nas configurações de template
     *
     * @param string $file
     * @return string
     */
    public function findByTemplate(string $template) : string
    {   
        $folder = $this->finder->findByTemplate($template);

        $path = $this->root() . DS . $folder . DS;

        return PathSanitizer::sanitize($path); 
    }

    /**
     * 
     *
     * @param array $paths
     * @return mixed
     */
    public function paths(array $paths = null)
    {
        if (! $paths) {
            return $this->getPaths();
        }  
         
        return $this->setPaths($paths)->initFinder();

Are you sure the usage of $this->setPaths($paths)->initFinder() targeting Maestriam\FileSystem\Foundation\Drive\StructureDirectory::initFinder() seems to always return null.

    }

    /**
     * Inicia a instância com as regras de negócio para pesquisar
     * o diretório apropriado de acordo com o template
     *
     * @return void
     */
    private function initFinder()
    {
        $structure = $this->getPaths();

        $this->finder = new PathFinder($structure);

        return $this;

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

    }
    
    /**
     * Define a lista de caminho de templates
     *
     * @param string $path
     * @return mixed
     */
    public function setPaths(array $list) : StructureDirectory
    {
        $this->pathList = $list;

        return $this;
    }

    /**
     * Retorna a lista de caminhos definidos dentro do projeto
     *
     * @return void
     */
    public function getPaths() : array
    {
        return $this->pathList;

The expression return $this->pathList returns the type array which is incompatible with the documented return type void.

    }
}