ConsoleCommandEvent
class ConsoleCommandEvent extends ConsoleEvent
Позволяет выполнять действия перед выполнением команды, например, пропустить команду или изменить входные данные.
Постоянные значения
| RETURN_CODE_DISABLED | Код возврата для пропущенных команд, он также будет передан в событие завершения. |
Методы
| bool | isPropagationStopped() Возвращает, следует ли вызывать дополнительные обработчики событий. | из Event |
| stopPropagation() Останавливает распространение события к дополнительным обработчикам событий. | из Event | |
| setDispatcher(EventDispatcherInterface $dispatcher) устаревший Хранит EventDispatcher, который обрабатывает это событие. | из Event | |
| EventDispatcherInterface | getDispatcher() устаревший Возвращает EventDispatcher, который обрабатывает это событие. | из Event |
| string | getName() устаревший Получает имя события. | из Event |
| setName(string $name) устаревший Устанавливает свойство имени события. | из Event | |
| __construct(Command $command, InputInterface $input, OutputInterface $output) | из ConsoleEvent | |
| Command | getCommand() Получает выполняемую команду. | из ConsoleEvent |
| InputInterface | getInput() Получает экземпляр входных данных. | из ConsoleEvent |
| OutputInterface | getOutput() Получает экземпляр выходных данных. | из ConsoleEvent |
| bool | disableCommand() Отключает команду, чтобы она не выполнялась. | |
| bool | enableCommand() Включает команду. | |
| bool | commandShouldRun() Возвращает true, если команда может быть выполнена, и false в противном случае. |
Детали
bool isPropagationStopped()
Возвращает, следует ли вызывать дополнительные обработчики событий.
Возвращаемое значение
| bool | Результат того, было ли прекращено распространение события |
См. также
| Event::stopPropagation() |
stopPropagation()
Останавливает распространение события к дополнительным обработчикам событий.
Если к одному событию подключено несколько обработчиков событий, никакой дополнительный обработчик событий не будет вызван после того, как любой триггер вызовет stopPropagation().
setDispatcher(EventDispatcherInterface $dispatcher) устаревший
устаревший
Хранит EventDispatcher, который обрабатывает это событие.
Параметры
| EventDispatcherInterface | $dispatcher |
EventDispatcherInterface getDispatcher() устаревший
устаревший
Возвращает EventDispatcher, который обрабатывает это событие.
Возвращаемое значение
| EventDispatcherInterface |
string getName() устаревший
устаревший
Получает имя события.
Возвращаемое значение
| string |
setName(string $name) устаревший
устаревший
Устанавливает свойство имени события.
Параметры
| string | $name | Имя события |
__construct(Command $command, InputInterface $input, OutputInterface $output)
Параметры
| Command | $command | |
| InputInterface | $input | |
| OutputInterface | $output |
Command getCommand()
Получает выполняемую команду.
Возвращаемое значение
| Command | Экземпляр 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/2.7/Symfony/Component/Console/Event/ConsoleCommandEvent.html
