ConsoleCommandEvent
class ConsoleCommandEvent extends ConsoleEvent
Позволяет выполнить действия перед выполнением команды, такие как пропуск команды или изменение входных данных.
Постоянные значения
| RETURN_CODE_DISABLED | Код возврата для пропущенных команд, он также будет передан в событие завершения. |
Свойства
| protected | $command | из ConsoleEvent |
Методы
| 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.
https://api.symfony.com/4.1/Symfony/Component/Console/Event/ConsoleCommandEvent.html