Laravel - Console Artisan

O framework Laravel fornece três ferramentas principais para interação através da linha de comando, a saber: Artisan, Ticker e REPL. Este capítulo explica sobre o Artisan em detalhes.

Introdução ao Artisan

Artisan é a interface de linha de comando freqüentemente usada no Laravel e inclui um conjunto de comandos úteis para o desenvolvimento de uma aplicação web.

Exemplo

Aqui está uma lista de alguns comandos no Artisan, juntamente com suas respectivas funcionalidades -

To start Laravel project

php artisan serve

To enable caching mechanism

php artisan route:cache

To view the list of available commands supported by Artisan

php artisan list

To view help about any command and view the available options and arguments

php artisan help serve

A imagem a seguir mostra a saída dos comandos dados acima -

Comandos de escrita

Além dos comandos listados no Artisan, um usuário também pode criar um comando personalizado que pode ser usado na aplicação web. Observe que os comandos são armazenados emapp/console/commands directory.

O comando padrão para a criação de comandos definidos pelo usuário é mostrado abaixo -

php artisan make:console <name-of-command>

Depois de digitar o comando fornecido acima, você pode ver a saída conforme mostrado na imagem fornecida abaixo -

O arquivo criado para DefaultCommand é nomeado como DefaultCommand.php e é mostrado abaixo -

<?php

namespace App\Console\Commands;
use Illuminate\Console\Command;

class DefaultCommand extends Command{
   /**
      * The name and signature of the console command.
      *
      * @var string
   */
   
   protected $signature = 'command:name';
   
   /**
      * The console command description.
      *
      * @var string
   */
   
   protected $description = 'Command description';
   
   /**
      * Create a new command instance.
      *
      * @return void
   */
   
   public function __construct() {
      parent::__construct();
   }
   
   /**
      * Execute the console command.
      *
      * @return mixed
   */
   
   public function handle() {
      //
   }
}

Este arquivo inclui a assinatura e a descrição do comando definido pelo usuário. A função pública chamadahandleexecuta as funcionalidades quando o comando é executado. Esses comandos são registrados no arquivoKernel.php no mesmo diretório.

Você também pode criar a programação de tarefas para o comando definido pelo usuário, conforme mostrado no código a seguir -

<?php

namespace App\Console;

use Illuminate\Console\Scheduling\Schedule;
use Illuminate\Foundation\Console\Kernel as ConsoleKernel;

class Kernel extends ConsoleKernel {
   /**
      * The Artisan commands provided by your application.
      *
      * @var array
   */
   
   protected $commands = [
      // Commands\Inspire::class,
      Commands\DefaultCommand::class
   ];
   
   /**
      * Define the application's command schedule.
      *
      * @param \Illuminate\Console\Scheduling\Schedule $schedule
      * @return void
   */
   
   protected function schedule(Schedule $schedule) {
      // $schedule->command('inspire')
      // ->hourly();
   }
}

Observe que a programação de tarefas para o comando fornecido é definida na função chamada schedule, que inclui um parâmetro para agendar as tarefas que leva hourly parâmetro.

Os comandos são registrados na matriz de comandos, que inclui o caminho e o nome dos comandos.

Uma vez que o comando é registrado, ele é listado nos comandos Artisan. Os valores incluídos na seção de assinatura e descrição serão exibidos quando você chamar o atributo de ajuda do comando especificado.

Vamos ver como ver os atributos do nosso comando DefaultCommand. Você deve usar o comando conforme mostrado abaixo -

php artisan help DefaultCommand