Spec-Zone.ru › Laravel 5.7

WorkCommand

class WorkCommand extends Command (View source)

Свойства

Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
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 bool $hidden Указывает, должна ли команда отображаться в списке команд Artisan. from Command
protected int $verbosity Уровень детализации вывода по умолчанию. from Command
protected array $verbosityMap Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface. from Command
protected Worker $worker Экземпляр обработчика очереди.

Методы

static void macro(string $name, object|callable $macro)

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

 из Macroable
static void mixin(object $mixin)

Смешать другой объект в класс.

 из Macroable
static bool hasMacro(string $name)

Проверить, зарегистрирована ли макрокоманда.

 из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

 из Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

 из Macroable
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
ArrayInput createInputFromArguments(array $arguments)

Создать экземпляр ввода из заданных аргументов.

 из Command
bool hasArgument(string|int $name)

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

 из Command
string|array|null argument(string|null $key = null)

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

 из Command
array arguments()

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

 из Command
bool hasOption(string $name)

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

 из Command
string|array|null option(string|null $key = null)

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

 из Command
array options()

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

 из Command
bool confirm(string $question, bool $default = false)

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

 из Command
mixed ask(string $question, string|null $default = null)

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

 из Command
mixed anticipate(string $question, array $choices, string|null $default = null)

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

 из Command
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

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

 из Command
mixed secret(string $question, bool $fallback = true)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 из Command
void alert(string $string)

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

 из Command
void setVerbosity(string|int $level)

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

 из Command
int parseVerbosity(string|int|null $level = null)

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

 из Command
array getArguments()

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

 из Command
array getOptions()

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

 из Command
OutputStyle getOutput()

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

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
void handle()

Выполнить команду консоли.
array runWorker(string $connection, string $queue)

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

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

Прослушивать события очереди для обновления вывода в консоли.
void writeOutput(Job $job, string $status)

Вывести вывод состояния для обработчика очереди.
void writeStatus(Job $job, string $status, string $type)

Форматировать вывод состояния для обработчика очереди.
void logFailedJob(JobFailed $event)

Сохранить событие о сбое задания.
string getQueue(string $connection)

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

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

Подробности

static void macro(string $name, object|callable $macro)

Регистрация пользовательского макроса.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

Включение другого объекта в класс.

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверка наличия зарегистрированного макроса.

Parameters

string $name

Return Value

bool

static mixed __callStatic(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамическая обработка вызовов класса.

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(Worker $worker)

Создание новой команды обработки очереди.

Parameters

Worker $worker

Return Value

void

protected void configureUsingFluentDefinition()

Настройка команды консоли с помощью определения Fluent.

Return Value

void

protected void specifyParameters()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

Запуск команды консоли.

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

Выполнение команды консоли.

Parameters

InputInterface $input
OutputInterface $output

Return Value

mixed

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

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

Parameters

string $command
array $arguments

Return Value

int
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $command
array $arguments

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

string|array|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string|null $key

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

string|array|null

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string

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

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

Параметры

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

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Parameters

string $string
int|string|null $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|null $level = null)

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

Parameters

string|int|null $level

Return Value

int

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputStyle getOutput()

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

Return Value

OutputStyle

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()

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

Return Value

WorkerOptions

protected void listenForEvents()

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

Return Value

void

protected void writeOutput(Job $job, string $status)

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

Parameters

Job $job
string $status

Return Value

void

protected void writeStatus(Job $job, string $status, string $type)

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

Parameters

Job $job
string $status
string $type

Return Value

void

protected void logFailedJob(JobFailed $event)

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

Parameters

JobFailed $event

Return Value

void

protected string getQueue(string $connection)

Получить имя очереди для рабочего процесса.

Parameters

string $connection

Return Value

string

protected bool downForMaintenance()

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

Return Value

bool

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

Spec-Zone.ru

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