Maestriam\Samurai\Console\BaseCommand

Complexity

Total Complexity

8

Size/Duplication

Total Lines	113
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	failure()	0	7	1
A	__construct()	0	3	1
A	success()	0	7	1
A	getDirectiveArgument()	0	9	2
A	clean()	0	3	1
A	getThemeArgument()	0	9	2

<?php

namespace Maestriam\Samurai\Console;

use Exception;
use Illuminate\Console\Command;
use Maestriam\Samurai\Exceptions\InvalidDirectiveNameException;
use Maestriam\Samurai\Support\Samurai;

class BaseCommand extends Command
{

    
    /**
     * O nome e a assinatura do método
     *
     * @var string
     */
    protected $signature;

    /**
     * A descrição do comando
     *
     * @var string
     */
    protected $description;

    /**
     * Mensagem de sucesso ao executar o comando
     *
     * @var string
     */
    protected string $successMessage;

    /**
     * Mensagem de erro ao executar o comando
     *
     * @var string
     */
    protected string $errorMessage;

    /**
     * Cria a instância de um novo comando via console
     *
     * @return void
     */
    public function __construct()
    {
        parent::__construct();
    }

    /**
     * Retorna a mensagem de erro 
     *
     * @param  mixed ...$params
     * @return integer
     */
    protected function success(...$params) : int
    {
        $success = vsprintf($this->successMessage, $params);
        
        $this->info($success);
        
        return 0;
    }
    
    /**
     * Retorna a mensagem de erro ao usuário junto com seu código. 
     *
     * @param  Exception $e
     * @return integer
     */
    protected function failure(Exception $e) : int
    {
        $error = sprintf($this->errorMessage, $e->getMessage());

        $this->error($error);

        return $e->getCode();
    }

    /**
     * Retorna o nome do tema para execução.  
     * Em caso de nulo, tenta recuperar o tema atual da aplicação.  
     *
     * @return string
     */
    protected function getThemeArgument() : string
    {   
        $console = (string) $this->argument('theme');

        if (strlen($console)) {
            return $console;
        }

        return Samurai::base()->current()->package();

The method base() does not exist on Maestriam\Samurai\Support\Samurai. Since you implemented __callStatic, consider adding a @method annotation.

    }

    /**
     * Retorna o nome do nome da diretiva
     *
     * @return string
     */
    protected function getDirectiveArgument() : string
    {
        $name = (string) $this->argument('name');

        if ($name) {
            return $name;
        }
        
        throw new InvalidDirectiveNameException($name);
    }

    /**
     * Limpa o cache da aplicação Laravel
     *
     * @return void
     */
    protected function clean()
    {
        return Samurai::base()->clean();
    }
}