Spec-Zone.ru › Symfony 3.3

ConsoleCommandEvent

class ConsoleCommandEvent extends ConsoleEvent

Позволяет выполнять действия перед выполнением команды, например, пропускать команду или изменять входные данные.

Постоянные значения

RETURN_CODE_DISABLED

Код возврата для пропущенных команд, он также будет передан в событие завершения.

Методы

bool isPropagationStopped()

Возвращает, следует ли вызывать дальнейшие слушатели событий.

from Event
stopPropagation()

Останавливает распространение события к дальнейшим слушателям событий.

from Event
__construct(Command $command = null, InputInterface $input, OutputInterface $output) from ConsoleEvent
Command|null getCommand()

Получает команду, которая выполняется.

from ConsoleEvent
InputInterface getInput()

Получает экземпляр ввода.

from ConsoleEvent
OutputInterface getOutput()

Получает экземпляр вывода.

from 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.3/Symfony/Component/Console/Event/ConsoleCommandEvent.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API