Php artisan command create

Создание команд Artisan

Этот перевод актуален для англоязычной документации на 31.07.2015 (ветка 5.0). Опечатка? Выдели и нажми Ctrl+Enter.

Данная статья документации актуальна только для версии 5.0 и была удалена в версии 5.1. Описание процесса создания команд перенесено в статью Консоль Artisan.

Введение

В дополнение к стандартным командам Artisan вы можете также создавать свои собственные команды для работы с приложением. Вы можете поместить их в папку app/Console/Commands , либо в любое другое место, в котором их сможет найти автозагрузчик в соответствии с вашим файлом composer.json .

Создание команды

Создание класса

Для создания новой команды можно использовать Artisan-команду sh make:console , которая создаст заглушку, с которой вы можете начать работать.

Генерация нового класса команды

shphp artisan make:console FooCommand

Эта команда создаст класс в app/Console/Commands/FooCommand.php .

При создании команды может быть использован параметр sh —command для назначения имени команды в терминале:

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

Написание команды

Когда вы сгенерировали класс команды, вам нужно заполнить его свойства name и description , которые используются при отображении вашей команды в списке команд ( sh artisan list ).

Метод PHP fire будет вызван при вызове вашей команды. В него вы можете поместить любую нужную логику.

Параметры и ключи

Методы PHP getArguments () и PHP getOptions () служат для определения параметров и ключей, которые ваша команда принимает на вход. Оба эти метода могут возвращать массив команд, которые описываются как массив ключей.

При определении PHP arguments массив имеет такой вид:

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

Параметр PHP mode может быть объектом PHP InputArgument :: REQUIRED или PHP InputArgument :: OPTIONAL .

При определении PHP options , массив выглядит так:

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

Параметр PHP mode для ключей может быть любым из этих объектов: PHP InputOption :: VALUE_REQUIRED , PHP InputOption :: VALUE_OPTIONAL , PHP InputOption :: VALUE_IS_ARRAY , PHP InputOption :: VALUE_NONE .

Режим PHP VALUE_IS_ARRAY указывает, что ключ может быть использован несколько раз при вызове команды:

InputOption::VALUE_REQUIRED | InputOption::VALUE_IS_ARRAY

Что позволит выполнить такую команду:

shphp artisan foo --option=bar --option=baz

Режим PHP VALUE_NONE указывает, что ключ является простым переключателем:

Чтение ввода

Во время выполнения команды вам, конечно, потребуется доступ к параметрам и ключам, которые были переданы ей на вход. Для этого вы можете использовать методы PHP argument () и PHP option () .

Чтение параметра команды

Чтение всех параметров

Чтение ключа команды

Чтение всех ключей

Вывод

Для вывода сообщений вы можете использовать методы PHP info () , PHP comment () , PHP question () и PHP error () . Каждый из них будет использовать подходящие по смыслу цвета ANSI для отображении текста.

Вывод сообщения в консоль

$this->info('Вывести это на экран');

Вывод сообщения об ошибке

$this->error('Что-то пошло не так!');

Запрос ввода

Вы можете также использовать методы PHP ask () и PHP confirm () для получение ввода от пользователя.

Запрос ввода от пользователя

$name = $this->ask('Как вас зовут?');

Запрос скрытого ввода

$password = $this->secret('Какой у вас пароль?');

Запрос подтверждения

 if ($this->confirm('Вы хотите продолжить? [да|нет]')) 
// >

Вы можете также передать значение по умолчанию в метод PHP confirm () , которое должно быть либо true, либо false:

Вызов других команд

Иногда необходимо вызвать другую команду из своей. Для этого используйте метод PHP call :

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

Регистрация команд

Регистрация команды Artisan
Как только ваша команда написана, вам нужно зарегистрировать её в Artisan, чтобы она стала доступна для использования. Это обычно делается в файле app/Console/Kernel.php . В нём вы найдёте список команд в свойстве conf commands . Чтобы зарегистрировать свою команду, просто добавьте её в этот список:

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

Когда Artisan загружается, все перечисленные в этом свойстве команды будут включены в сервис-контейнер и зарегистрированы в Artisan.

1. Аутентификация
2. Авторизация (5.1+)
3. Оплата (биллинг)
4. Кэш
5. Коллекции
6. Командная шина
7. Расширение фреймворка
8. Elixir
9. Шифрование
10. Envoy
11. Scout
12. Ошибки и журнал
13. События
14. Файловая система и облака
15. API Authentication (Passport)
16. Хэширование
17. Функции
18. Локализация
19. Работа с e-mail
20. Разработка пакетов
21. Страничный вывод
22. Очереди
23. Сессии
24. Шаблоны Blade (5.1+)
25. Шаблоны (5.0)
26. Планировщик
27. Юнит-тесты
28. Проверка ввода
29. JavaScript и CSS
30. Сброс пароля

Статистика: Символов — 4 566/3 883 без пробелов (2 892/2 459 без кода):, слов — 434

Наверх Опечатка? Выдели и нажми Ctrl+Enter (Orphus.ru)

Источник

Artisan Development

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»:

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

Retrieving All Arguments

Retrieving The Value Of A Command Option

Retrieving All Options

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 :

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.

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in most web projects.

Источник