WorkCommand
class WorkCommand extends Command (View source)
Свойства
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected InputInterface | $input | Реализация интерфейса ввода. | from Command |
| protected OutputStyle | $output | Реализация интерфейса вывода. | from Command |
| protected string | $signature | Имя команды консоли. | |
| protected string | $name | Имя команды консоли. | from Command |
| protected string | $description | Описание команды консоли. | |
| protected int | $verbosity | Уровень подробности вывода по умолчанию для команд. | from Command |
| protected array | $verbosityMap | Сопоставление уровней подробности, читаемых человеком, и уровней OutputInterface Symfony. | from Command |
| protected Worker | $worker | Экземпляр обработчика очереди. |
Методы
| void | __construct(Worker $worker) Создать новую команду для прослушивания очереди. | |
| void | configureUsingFluentDefinition() Настроить консольную команду с помощью определения fluent. | from Command |
| void | specifyParameters() Указать аргументы и параметры команды. | from Command |
| int | run(InputInterface $input, OutputInterface $output) Выполнить консольную команду. | from Command |
| mixed | execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду. | from Command |
| int | call(string $command, array $arguments = []) Вызвать другую консольную команду. | from Command |
| int | callSilent(string $command, array $arguments = []) Вызвать другую консольную команду в беззвучном режиме. | from Command |
| bool | hasArgument(string|int $name) Определить, присутствует ли данный аргумент. | from Command |
| string|array | argument(string $key = null) Получить значение аргумента команды. | from Command |
| array | arguments() Получить все аргументы, переданные команде. | from Command |
| bool | hasOption(string $name) Определить, присутствует ли данный параметр. | from Command |
| string|array | option(string $key = null) Получить значение параметра команды. | from Command |
| array | options() Получить все параметры, переданные команде. | from Command |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя. | from Command |
| string | ask(string $question, string $default = null) Задать вопрос пользователю. | from Command |
| string | anticipate(string $question, array $choices, string $default = null) Задать вопрос пользователю с автодополнением. | from Command |
| string | askWithCompletion(string $question, array $choices, string $default = null) Задать вопрос пользователю с автодополнением. | from Command |
| string | secret(string $question, bool $fallback = true) Задать вопрос пользователю, но скрыть ответ из консоли. | from Command |
| string | choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null) Предложить пользователю единственный выбор из массива ответов. | from Command |
| void | table(array $headers, Arrayable|array $rows, string $style = 'default') Форматирование входных данных в текстовую таблицу. | from Command |
| void | info(string $string, null|int|string $verbosity = null) Вывести строку как информацию. | from Command |
| void | line(string $string, string $style = null, null|int|string $verbosity = null) Вывести строку как стандартный вывод. | from Command |
| void | comment(string $string, null|int|string $verbosity = null) Вывести строку как комментарий. | from Command |
| void | question(string $string, null|int|string $verbosity = null) Вывести строку как вопрос. | from Command |
| void | error(string $string, null|int|string $verbosity = null) Вывести строку как ошибку. | from Command |
| void | warn(string $string, null|int|string $verbosity = null) Вывести строку как предупреждение. | from Command |
| int | parseVerbosity(string|int $level = null) Получить уровень подробности в терминах уровня Symfony's OutputInterface. | from Command |
| void | setVerbosity(string|int $level) Установить уровень подробности. | from Command |
| array | getArguments() Получить аргументы консольной команды. | from Command |
| array | getOptions() Получить параметры консольной команды. | from Command |
| OutputInterface | getOutput() Получить реализацию вывода. | from Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | из Command |
| void | fire() Выполнить консольную команду. | |
| array | runWorker(string $connection, string $queue) Запустить экземпляр обработчика. | |
| WorkerOptions | gatherWorkerOptions() Собрать все параметры обработчика очереди в один объект. | |
| void | listenForEvents() Прослушивать события очереди для обновления вывода консоли. | |
| void | writeOutput(Job $job, bool $failed) Вывести выходной статус обработчика очереди. | |
| void | logFailedJob(JobFailed $event) Сохранить событие о неудачной задаче. | |
| string | getQueue(string $connection) Получить имя очереди для обработчика. | |
| bool | downForMaintenance() Определить, должен ли обработчик работать в режиме технического обслуживания. |
Подробности
void __construct(Worker $worker)
Создать новую команду для прослушивания очереди.
protected void configureUsingFluentDefinition()
Настроить консольную команду с помощью определения fluent.
protected void specifyParameters()
Указать аргументы и параметры команды.
int run(InputInterface $input, OutputInterface $output)
Запустить консольную команду.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить консольную команду.
int call(string $command, array $arguments = [])
Вызвать другую консольную команду.
int callSilent(string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
bool hasArgument(string|int $name)
Определить, присутствует ли указанный аргумент.
string|array argument(string $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли указанный параметр.
string|array option(string $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
string ask(string $question, string $default = null)
Задать вопрос пользователю и получить ответ.
string anticipate(string $question, array $choices, string $default = null)
Задать вопрос пользователю с автодополнением.
string askWithCompletion(string $question, array $choices, string $default = null)
Задать вопрос пользователю с автодополнением.
string secret(string $question, bool $fallback = true)
Запросить у пользователя входные данные, но скрыть ответ от консоли.
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)
Предложить пользователю единственный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, string $style = 'default')
Форматировать входные данные в текстовую таблицу.
void info(string $string, null|int|string $verbosity = null)
Вывести строку как информацию.
void line(string $string, string $style = null, null|int|string $verbosity = null)
Вывести строку как стандартный вывод.
void comment(string $string, null|int|string $verbosity = null)
Вывести строку как комментарий.
void question(string $string, null|int|string $verbosity = null)
Вывести строку как вопрос.
void error(string $string, null|int|string $verbosity = null)
Вывести строку как ошибку.
void warn(string $string, null|int|string $verbosity = null)
Вывести строку как предупреждение.
protected int parseVerbosity(string|int $level = null)
Получить уровень подробности с точки зрения уровня OutputInterface Symfony.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить параметры команды консоли.
OutputInterface getOutput()
Получить реализацию вывода.
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
void fire()
Выполнить команду консоли.
protected array runWorker(string $connection, string $queue)
Выполнить экземпляр работника.
protected WorkerOptions gatherWorkerOptions()
Собрать все параметры работника очереди как единый объект.
protected void listenForEvents()
Прослушивать события очереди, чтобы обновить вывод в консоли.
protected void writeOutput(Job $job, bool $failed)
Записать вывод состояния для работника очереди.
protected void logFailedJob(JobFailed $event)
Сохранить событие о завершении задачи с ошибкой.
protected string getQueue(string $connection)
Получить имя очереди для работника.
protected bool downForMaintenance()
Определить, должен ли работник работать в режиме технического обслуживания.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Queue/Console/WorkCommand.html
