Laravel - Artisan Console

Laravel framework provides three essential apparatuses for connection through order line to be specific: Artisan, Ticker, and REPL. This section clarifies Artisan in detail.

Introduction to Artisan

Craftsman is the order line interface as often as possible utilized in Laravel and it incorporates a lot of accommodating commands for building up a web application.

Example

Here is a list of a few commands in Artisan along with their respective functionalities −

To start the 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

The following screenshot shows the output of the commands given above −

Writing Commands

Notwithstanding the commands recorded in Artisan, a client can likewise make a custom order which can be utilized in the web application. It would be ideal if you note that commands are put away in app/console/commands catalog.

The default command for creating user defined command is shown below −

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

Once you type the above given command, you can see the output as shown in the screenshot given below −

The file created for DefaultCommand is named as DefaultCommand.php and is shown below −

<?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() {
      //
   }
}

This record incorporates the mark and depiction for the direction that client characterized. The open capacity named handle executes the functionalities when the direction is executed. These commands are enlisted in the document Kernel.php in a similar registry.

You can likewise make the timetable of errands for the client characterized direction as appeared in the accompanying code −

<?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();
   }
}

Note that the timetable of assignments for the given direction is characterized in the capacity named plan, which incorporates a parameter for planning the undertakings which takes hourly parameter.

The commands are enlisted in the variety of commands, which incorporates the way and name of the commands.

When the order is enrolled, it is recorded in Artisan commands. The qualities incorporated into the mark and portrayal area will be shown when you require the assistance trait of the predetermined direction.

Give us a chance to perceive how to see the qualities of our order DefaultCommand. You should utilize the order as appeared beneath −

php artisan help DefaultCommand