WorkCommand

class WorkCommand extends Command (View source)

Свойства

protected Application	$laravel	Экземпляр приложения Laravel.	из Command
protected InputInterface	$input	Реализация интерфейса ввода.	из Command
protected OutputStyle	$output	Реализация интерфейса вывода.	из Command
protected string	$signature	Имя команды консоли.
protected string	$name	Имя команды консоли.	из Command
protected string	$description	Описание команды консоли.
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из Command
protected int	$verbosity	Уровень подробности вывода по умолчанию.	из Command
protected array	$verbosityMap	Сопоставление уровней подробности (человекопонятных) и уровней Symfony OutputInterface.	из Command
protected Worker	$worker	Экземпляр обработчика очереди.

Методы

void	__construct(Worker $worker) Создать новую команду обработки очереди.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	из Command
void	specifyParameters() Указать аргументы и параметры команды.	из Command
int	run(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
mixed	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
int	call(string $command, array $arguments = []) Вызвать другую команду консоли.	из Command
int	callSilent(string $command, array $arguments = []) Вызвать другую команду консоли без отображения вывода.	из Command
bool	hasArgument(string\|int $name) Определить, существует ли данный аргумент.	из Command
string\|array	argument(string\|null $key = null) Получить значение аргумента команды.	из Command
array	arguments() Получить все аргументы, переданные команде.	из Command
bool	hasOption(string $name) Определить, существует ли данный параметр.	из Command
string\|array	option(string $key = null) Получить значение параметра команды.	из Command
array	options() Получить все параметры, переданные команде.	из Command
bool	confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя.	из Command
string	ask(string $question, string $default = null) Задать вопрос пользователю и получить ответ.	из Command
string	anticipate(string $question, array $choices, string $default = null) Задать вопрос пользователю с автодополнением.	из Command
string	askWithCompletion(string $question, array $choices, string $default = null) Задать вопрос пользователю с автодополнением.	из Command
string	secret(string $question, bool $fallback = true) Задать вопрос пользователю, скрывая ответ в консоли.	из Command
string	choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null) Предложить пользователю выбрать один вариант из списка ответов.	из Command
void	table(array $headers, Arrayable\|array $rows, string $style = 'default') Форматировать входные данные в виде текстовой таблицы.	из Command
void	info(string $string, null\|int\|string $verbosity = null) Вывести строку в качестве информационного сообщения.	из Command
void	line(string $string, string $style = null, null\|int\|string $verbosity = null) Вывести строку в стандартный вывод.	из Command
void	comment(string $string, null\|int\|string $verbosity = null) Вывести строку в качестве комментария.	из Command
void	question(string $string, null\|int\|string $verbosity = null) Вывести строку в качестве вопроса.	из Command
void	error(string $string, null\|int\|string $verbosity = null) Вывести строку в качестве ошибки.	из Command
void	warn(string $string, null\|int\|string $verbosity = null) Вывести строку в качестве предупреждения.	из Command
void	alert(string $string) Вывести строку в виде предупреждения.	из Command
void	setVerbosity(string\|int $level) Установить уровень подробности.	из Command
int	parseVerbosity(string\|int $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	из Command
array	getArguments() Получить аргументы команды консоли.	из Command
array	getOptions() Получить параметры команды консоли.	из Command
OutputInterface	getOutput() Получить реализацию вывода.	из Command

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команда
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команда
void	fire() Выполнить консольную команду.
массив	runWorker(string $connection, string $queue) Запустить экземпляр обработчика.
ПараметрыОбработчика	gatherWorkerOptions() Собрать все параметры обработчика очереди в один объект.
void	listenForEvents() Прослушивать события очереди, чтобы обновлять вывод консоли.
void	writeOutput(Задача $job, string $status) Вывести вывод состояния для обработчика очереди.
void	writeStatus(Задача $job, string $status, string $type) Отформатировать вывод состояния для обработчика очереди.
void	logFailedJob(JobFailed $event) Сохранить событие о завершении задачи с ошибкой.
строка	getQueue(string $connection) Получить имя очереди для обработчика.
bool	downForMaintenance() Определить, должен ли обработчик работать в режиме технического обслуживания.

Подробности

void __construct(Обработчик $worker)

Создать новую команду работы с очередью.

Параметры

Обработчик

$worker

Возвращаемое значение

void

protected void configureUsingFluentDefinition()

Настроить консольную команду с помощью определения в стиле fluent.

Возвращаемое значение

void

protected void specifyParameters()

Указать аргументы и опции команды.

Возвращаемое значение

void

int run(InputInterface $input, OutputInterface $output)

Выполнить консольную команду.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

int

protected mixed execute(InputInterface $input, OutputInterface $output)

Выполнить консольную команду.

Параметры

InputInterface	$input
OutputInterface	$output

Возвращаемое значение

mixed

int call(string $command, array $arguments = [])

Вызвать другую консольную команду.

Параметры

строка	$command
массив	$arguments

Возвращаемое значение

int

int callSilent(string $command, array $arguments = [])

Вызвать другую консольную команду без вывода.

Параметры

строка	$command
массив	$arguments

Возвращаемое значение

int

bool hasArgument(string|int $name)

Определить, присутствует ли данный аргумент.

Параметры

строка|int

$name

Возвращаемое значение

bool

string|array argument(string|null $key = null)

Получить значение аргумента команды.

Параметры

строка|null

$key

Возвращаемое значение

строка|массив

array arguments()

Получить все переданные аргументы команды.

Возвращаемое значение

массив

bool hasOption(string $name)

Определить, присутствует ли данная опция.

Параметры

строка

$name

Возвращаемое значение

bool

string|array option(string $key = null)

Получить значение опции команды.

Параметры

строка

$key

Возвращаемое значение

строка|массив

array options()

Получить все переданные опции команды.

Возвращаемое значение

массив

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

строка	$question
bool	$default

Возвращаемое значение

bool

string ask(string $question, string $default = null)

Запросить ввод у пользователя.

Параметры

строка	$question
строка	$default

Возвращаемое значение

строка

string anticipate(string $question, array $choices, string $default = null)

Запросить ввод у пользователя с автодополнением.

Параметры

строка	$question
массив	$choices
строка	$default

Возвращаемое значение

строка

string askWithCompletion(string $question, array $choices, string $default = null)

Запросить у пользователя ввод с автодополнением.

Параметры

string	$question
array	$choices
string	$default

Возвращаемое значение

string

string secret(string $question, bool $fallback = true)

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

Параметры

string	$question
bool	$fallback

Возвращаемое значение

string

string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)

Предложить пользователю один вариант из массива ответов.

Параметры

string	$question
array	$choices
string	$default
mixed	$attempts
bool	$multiple

Возвращаемое значение

string

void table(array $headers, Arrayable|array $rows, string $style = 'default')

Форматировать ввод в текстовую таблицу.

Параметры

array	$headers
Arrayable\|array	$rows
string	$style

Возвращаемое значение

void

void info(string $string, null|int|string $verbosity = null)

Вывести строку как информацию.

Параметры

string	$string
null\|int\|string	$verbosity

Возвращаемое значение

void

void line(string $string, string $style = null, null|int|string $verbosity = null)

Вывести строку в стандартный вывод.

Параметры

string	$string
string	$style
null\|int\|string	$verbosity

Возвращаемое значение

void

void comment(string $string, null|int|string $verbosity = null)

Вывести строку как комментарий.

Параметры

string	$string
null\|int\|string	$verbosity

Возвращаемое значение

void

void question(string $string, null|int|string $verbosity = null)

Вывести строку как вопрос.

Параметры

string	$string
null\|int\|string	$verbosity

Возвращаемое значение

void

void error(string $string, null|int|string $verbosity = null)

Вывести строку как ошибку.

Параметры

string	$string
null\|int\|string	$verbosity

Возвращаемое значение

void

void warn(string $string, null|int|string $verbosity = null)

Вывести строку как предупреждение.

Параметры

string	$string
null\|int\|string	$verbosity

Возвращаемое значение

void

void alert(string $string)

Вывести строку в всплывающем окне.

Параметры

string

$string

Возвращаемое значение

void

protected void setVerbosity(string|int $level)

Установить уровень детализации.

Параметры

string|int

$level

Возвращаемое значение

void

protected int parseVerbosity(string|int $level = null)

Получить уровень детализации в терминах уровня OutputInterface Symfony.

Параметры

string|int

$level

Возвращаемое значение

int

protected array getArguments()

Получить аргументы команды консоли.

Возвращаемое значение

array

protected array getOptions()

Получить параметры команды консоли.

Возвращаемое значение

array

OutputInterface getOutput()

Получить реализацию вывода.

Возвращаемое значение

OutputInterface

Application getLaravel()

Получить экземпляр приложения Laravel.

Возвращаемое значение

Application

void setLaravel(Container $laravel)

Установить экземпляр приложения Laravel.

Параметры

Container

$laravel

Возвращаемое значение

void

void fire()

Выполнить команду консоли.

Возвращаемое значение

void

protected array runWorker(string $connection, string $queue)

Запустить экземпляр работника.

Параметры

string	$connection
string	$queue

Возвращаемое значение

array

protected WorkerOptions gatherWorkerOptions()

Собрать все параметры работника очереди в единый объект.

Возвращаемое значение

WorkerOptions

protected void listenForEvents()

Прослушивать события очереди для обновления вывода консоли.

Значение возврата

void

protected void writeOutput(Задача $job, string $status)

Вывести вывод состояния для обработчика очереди.

Параметры

Задача	$job
string	$status

Значение возврата

void

protected void writeStatus(Задача $job, string $status, string $type)

Форматировать вывод состояния для обработчика очереди.

Параметры

Задача	$job
string	$status
string	$type

Значение возврата

void

protected void logFailedJob(JobFailed $event)

Сохранить событие о сбое задачи.

Параметры

JobFailed

$event

Значение возврата

void

protected string getQueue(string $connection)

Получить имя очереди для обработчика.

Параметры

string

$connection

Значение возврата

string

protected bool downForMaintenance()

Определить, следует ли запустить обработчик в режиме технического обслуживания.

Значение возврата

bool

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.4/Illuminate/Queue/Console/WorkCommand.html