ConsoleCommandEvent
class ConsoleCommandEvent extends ConsoleEvent
Позволяет выполнять действия перед выполнением команды, например, пропускать команду или изменять входные данные.
Постоянные значения
| RETURN_CODE_DISABLED | Код возврата для пропущенных команд, он также будет передан в событие завершения. |
Методы
| bool | isPropagationStopped() Возвращает значение, показывающее, следует ли запускать дальнейшие обработчики событий. | из Event |
| stopPropagation() Останавливает распространение события к дальнейшим обработчикам событий. | из Event | |
| __construct(Command $command = null, InputInterface $input, OutputInterface $output) | из ConsoleEvent | |
| Command|null | getCommand() Получает команду, которая выполняется. | из ConsoleEvent |
| InputInterface | getInput() Получает экземпляр ввода. | из ConsoleEvent |
| OutputInterface | getOutput() Получает экземпляр вывода. | из ConsoleEvent |
| bool | disableCommand() Отключает команду, чтобы она не выполнялась. | |
| bool | enableCommand() Включает команду. | |
| bool | commandShouldRun() Возвращает true, если команда может выполняться, иначе false. |
Детали
bool isPropagationStopped()
Возвращает значение, показывающее, следует ли запускать дальнейшие обработчики событий.
Возвращаемое значение
| bool | Значение, указывающее, было ли уже остановлено распространение для этого события |
См. также
| Event::stopPropagation() |
stopPropagation()
Останавливает распространение события к дальнейшим обработчикам событий.
Если к одному событию подключено несколько обработчиков событий, никакой дальнейший обработчик событий не будет запущен, как только какой-либо обработчик вызовет stopPropagation().
__construct(Command $command = null, InputInterface $input, OutputInterface $output)
Параметры
| Command | $command | |
| InputInterface | $input | |
| OutputInterface | $output |
Command|null getCommand()
Получает команду, которая выполняется.
Возвращаемое значение
| Command|null | Экземпляр Command |
InputInterface getInput()
Получает экземпляр ввода.
Возвращаемое значение
| InputInterface | Экземпляр InputInterface |
OutputInterface getOutput()
Получает экземпляр вывода.
Возвращаемое значение
| OutputInterface | Экземпляр OutputInterface |
bool disableCommand()
Отключает команду, чтобы она не выполнялась.
Возвращаемое значение
| bool |
bool enableCommand()
Включает команду.
Возвращаемое значение
| bool |
bool commandShouldRun()
Возвращает true, если команда может выполняться, иначе false.
Возвращаемое значение
| bool |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.4/Symfony/Component/Console/Event/ConsoleCommandEvent.html