Laravel - Artisan Console

Laravel framework provides three primary tools for interaction through command-line namely:Artisan, TickerandREPL. This chapter explains about Artisan in detail.

Introduction to Artisan

Artisan is the command line interface frequently used in Laravel and it includes a set of helpful commands for developing a web application.

Example

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

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

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

Writing Commands

In addition to the commands listed in Artisan, a user can also create a custom command which can be used in the web application. Please note that commands are stored inapp/console/commands directory.

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

php artisan make:console 

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

The file created forDefaultCommandis named asDefaultCommand.phpand is shown below −

        

         Copy after login
        
       

This file includes the signature and description for the command that user defined. The public function namedhandleexecutes the functionalities when the command is executed. These commands are registered in the fileKernel.phpin the same directory.

You can also create the schedule of tasks for the user defined command as shown in the following code −

command('inspire') // ->hourly(); } }

Note that the schedule of tasks for the given command is defined in the function namedschedule, which includes a parameter for scheduling the tasks which takeshourlyparameter.

The commands are registered in the array of commands, which includes the path and name of the commands.

Once the command is registered, it is listed in Artisan commands. The values included in the signature and description section will be displayed when you call for the help attribute of the specified command.

Let us see how to view the attributes of our commandDefaultCommand. You should use the command as shown below −

php artisan help DefaultCommand

The above is the detailed content of Laravel - Artisan Console. For more information, please follow other related articles on the PHP Chinese website!