아티즌 명령어 개발하기(Artisan Development)

소개
명령어 만들기
명령어 등록하기

소개

아티즌에서 제공하는 명령어에 추가로 애플리케이션에서 동작하는 자신의 고유한 명령어를 만들 수 있습니다. 여러분의 고유한 명령어는 app/Console/Commands 디렉토리에 저장하면 됩니다만, 실제로는 명령어가 composer.json 세팅을 기반하여 오토로딩 될 수 있다면 어느 위치에 넣어도 상관없습니다.

명령어 만들기

클래스 생성하기

새로운 명령어를 생성하기 위해 아티즌 명령어 make:console을 사용합니다:

새로운 명령어 클래스 생성하기

php artisan make:console FooCommand

이 명령어는 app/Console/Commands/FooCommand.php파일을 생성할 것입니다.

명령어를 생성할 때 --command 옵션을 사용하면 터미널에서 사용할 명령어 이름을 지정할 수 있습니다:

php artisan make:console AssignUsers --command=users:assign

명령어 작성하기

명령어가 생성되면 클래스의 name과 description을 입력합니다. 이것들은 list 화면에 커맨드를 표시 할 때 사용됩니다.

file 메소드는 명령이 실행될 때 호출됩니다. 수행할 로직을 이 메소드 안에 작성하면 됩니다.

인자 & 옵션

명령어가 입력받는 인자와 옵션을 getArguments와 getOptions 메소드에 정의합니다. 이 두 메소드는 배열 옵션 목록에서 표시되는 커맨드의 배열을 반환합니다.

arguments를 정의하는 정의 배열은 다음과 같은 형식입니다:

[$name, $mode, $description, $defaultValue]

인자의 mode는 InputArgument::REQUIRED 또는 InputArgument::OPTIONAL 중 하나의 값을 가집니다.

options를 정의하는 배열은 다음과 같은 형식입니다:

[$name, $shortcut, $mode, $description, $defaultValue]

옵션에서 mode는 InputOption:REQUIRED, InputOption::OPTIONAL, InputOption::VALUE_IS_ARRAY, InputOption::VALUE_NONE 중 하나의 값을 가집니다.

VALUE_IS_ARRAY 모드는 명령 실행 시 여러 번 사용되는 스위치를 나타냅니다:

InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY

위의 모드는 다음의 커맨드를 허용합니다:

php artisan foo --option=bar --option=baz

VALUE_NONE 옵션은 이 옵션이 단순히 스위치로 사용된다는 것을 나타냅니다:

php artisan foo --option

Retrieving Input 입력값 조회하기

While your command is executing, you will obviously need to access the values for the arguments and options accepted by your application. 명령이 실행중일 때, 애플리케이션이 받은 인자 및 옵션의 값에 엑세스할 필요가 있습니다. To do so, you may use the argument and option methods: 이 경우 argument와 option메소드를 사용하면 됩니다.

명령어 인자 값 조회

$value = $this->argument('name');

모든 인자 값을 조회하기

$arguments = $this->argument();

명령어 옵션 값 조회하기

$value = $this->option('name');

모든 옵션 값 조회하기

$options = $this->option();

출력 작성하기

콘솔에 출력하려면 info, comment, question과 error 메소드를 사용하면 됩니다. 각 메소드는 용도에 따라 적절한 ANSI 컬러로 표시됩니다.

콘솔에 정보 표시하기

$this->info('Display this on the screen');

콘솔에 에러 메세지 표시하기

$this->error('Something went wrong!');

질문하기

사용자 입력을 요청하는 ask와 confirm 메소드도 사용할 수 있습니다:

사용자에게 입력을 요구하기

$name = $this->ask('What is your name?');

사용자에게 비밀 문자열 입력을 요구하기

$password = $this->secret('What is the password?');

사용자에게 확인을 요구하기

if ($this->confirm('Do you wish to continue? [yes|no]'))
{
    //
}

confirm 메소드에 대한 기본값을 true와 false로 지정할 수 있습니다:

$this->confirm($question, true);

다른 명령어 호출하기

때로는 해당 명령어가 다른 명령어를 호출해야 할 때가 있습니다. 이 경우에 call 메소드를 사용하면 됩니다:

$this->call('command:name', ['argument' => 'foo', '--option' => 'bar']);

명령어 등록하기

아티즌 명령어 등록하기

명령어 작성이 완료되면 명령어를 사용가능하도록 아티즌에 등록해야 합니다. 이 작업은 일반적으로 app/Console/Kernel.php 파일에서 이루어 집니다. 이 파일에서 명령어들의 목록을 담고 있는 command 변수를 찾을 수 있을 것입니다. 여러분이 작성한 명령어를 등록하려면 해당 배열에 생성한 명령어 클래스를 추가하십시오.

protected $commands = [
    'App\Console\Commands\FooCommand'
];

아티즌이 구동되면서 변수 내의 모든 명령어의 목록을 참고하여 service container들이 자동으로 실행 가능한 상태로 아티즌에 등록됩니다.

Artisan Development

Introduction
Building A Command
Registering Commands

Introduction

In addition to the commands provided with Artisan, you may also build your own custom commands for working with your application. You may store your custom commands in the app/Console/Commands directory; however, you are free to choose your own storage location as long as your commands can be autoloaded based on your composer.json settings.

Building A Command

Generating The Class

To create a new command, you may use the make:console Artisan command, which will generate a command stub to help you get started:

Generate A New Command Class

php artisan make:console FooCommand

The command above would generate a class at app/Console/Commands/FooCommand.php.

When creating the command, the --command option may be used to assign the terminal command name:

php artisan make:console AssignUsers --command=users:assign

Writing The Command

Once your command is generated, you should fill out the name and description properties of the class, which will be used when displaying your command on the list screen.

The fire method will be called when your command is executed. You may place any command logic in this method.

Arguments & Options

The getArguments and getOptions methods are where you may define any arguments or options your command receives. Both of these methods return an array of commands, which are described by a list of array options.

When defining arguments, the array definition values represent the following:

[$name, $mode, $description, $defaultValue]

The argument mode may be any of the following: InputArgument::REQUIRED or InputArgument::OPTIONAL.

When defining options, the array definition values represent the following:

[$name, $shortcut, $mode, $description, $defaultValue]

For options, the argument mode may be: InputOption::VALUE_REQUIRED, InputOption::VALUE_OPTIONAL, InputOption::VALUE_IS_ARRAY, InputOption::VALUE_NONE.

The VALUE_IS_ARRAY mode indicates that the switch may be used multiple times when calling the command:

InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY

Would then allow for this command:

php artisan foo --option=bar --option=baz

The VALUE_NONE option indicates that the option is simply used as a "switch":

php artisan foo --option

Retrieving Input

While your command is executing, you will obviously need to access the values for the arguments and options accepted by your application. To do so, you may use the argument and option methods:

Retrieving The Value Of A Command Argument

$value = $this->argument('name');

Retrieving All Arguments

$arguments = $this->argument();

Retrieving The Value Of A Command Option

$value = $this->option('name');

Retrieving All Options

$options = $this->option();

Writing Output

To send output to the console, you may use the info, comment, question and error methods. Each of these methods will use the appropriate ANSI colors for their purpose.

Sending Information To The Console

$this->info('Display this on the screen');

Sending An Error Message To The Console

$this->error('Something went wrong!');

Asking Questions

You may also use the ask and confirm methods to prompt the user for input:

Asking The User For Input

$name = $this->ask('What is your name?');

Asking The User For Secret Input

$password = $this->secret('What is the password?');

Asking The User For Confirmation

if ($this->confirm('Do you wish to continue? [yes|no]'))
{
    //
}

You may also specify a default value to the confirm method, which should be true or false:

$this->confirm($question, true);

Calling Other Commands

Sometimes you may wish to call other commands from your command. You may do so using the call method:

$this->call('command:name', ['argument' => 'foo', '--option' => 'bar']);

Registering Commands

Registering An Artisan Command

Once your command is finished, you need to register it with Artisan so it will be available for use. This is typically done in the app/Console/Kernel.php file. Within this file, you will find a list of commands in the commands property. To register your command, simply add it to this list.

protected $commands = [
    'App\Console\Commands\FooCommand'
];

When Artisan boots, all the commands listed in this property will be resolved by the service container and registered with Artisan.

개요

이 문서의 번역에 기여해주신 분들

기여에 참여하기