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	Сопоставление удобочитаемых уровней подробности и уровней OutputInterface Symfony.	из 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 $tableStyle = 'default', array $columnStyles = []) Форматировать входные данные в текстовую таблицу.	из 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) Получить уровень детализации в терминах уровня Symfony's OutputInterface.	из Command
array	getArguments() Получить аргументы команды консоли.	из Command
array	getOptions() Получить опции команды консоли.	из Command
OutputInterface	getOutput() Получить реализацию вывода.	из Command

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команда
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команда
void	обработать() Выполнить команду консоли.
массив	runWorker(string $connection, string $queue) Запустить экземпляр обработчика.
WorkerOptions	gatherWorkerOptions() Собрать все параметры обработчика очереди в один объект.
void	listenForEvents() Прослушивать события очереди для обновления вывода консоли.
void	writeOutput(Задача $job, string $status) Вывести вывод статуса для обработчика очереди.
void	writeStatus(Задача $job, string $status, string $type) Форматировать вывод статуса для обработчика очереди.
void	logFailedJob(JobFailed $event) Сохранить событие о неудачной задаче.
строка	getQueue(string $connection) Получить имя очереди для обработчика.
логический	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 = [])

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

Параметры

string	$command
array	$arguments

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

int

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

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

Параметры

string	$command
array	$arguments

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

int

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

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

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

Параметры

string|null

$key

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

string|array

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

string|array option(string $key = null)

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

Параметры

string

$key

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

string|array

array options()

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

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

array

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

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

Параметры

string	$question
bool	$default

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

bool

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

Задать пользователю вопрос.

Параметры

string	$question
string	$default

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

string

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

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

Параметры

string	$question
array	$choices
string	$default

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

string

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

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

Parameters

string	$question
array	$choices
string	$default

Return Value

string

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

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

Parameters

string	$question
bool	$fallback

Return Value

string

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

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

Parameters

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

Return Value

string

void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

Parameters

array	$headers
Arrayable\|array	$rows
string	$tableStyle
array	$columnStyles

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

void alert(string $string)

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

Parameters

string

$string

Return Value

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Parameters

string|int

$level

Return Value

void

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

Получить уровень подробности с точки зрения уровня OutputInterface Symfony.

Parameters

string|int

$level

Return Value

int

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputInterface getOutput()

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

Return Value

OutputInterface

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container

$laravel

Return Value

void

void handle()

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

Return Value

void

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

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

Parameters

string	$connection
string	$queue

Return Value

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.5/Illuminate/Queue/Console/WorkCommand.html