Spec-Zone.ru › Laravel 5.8

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 Сопоставление удобочитаемых уровней детализации с уровнями OutputInterface Symfony. from Command
protected Worker $worker Экземпляр обработчика очереди.

Методы

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

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

 from Macroable
static void mixin(object $mixin, bool $replace = true)

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

 from Macroable
static bool hasMacro(string $name)

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

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

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

 from Macroable
mixed __call(string $method, array $parameters)

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

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

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

 from Command
array context()

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

 from Command
bool hasArgument(string|int $name)

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

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

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

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

 from Command
string|array|bool|null option(string|null $key = null)

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 из Команды
void alert(string $string)

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

 из Команды
void setVerbosity(string|int $level)

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

 из Команды
int parseVerbosity(string|int|null $level = null)

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

 из Команды
isHidden()

{@inheritdoc}

 из Команды
setHidden($hidden)

{@inheritdoc}

 из Команды
array getArguments()

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

 из Команды
array getOptions()

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

 из Команды
OutputStyle getOutput()

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

 из Команды
Application getLaravel()

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

 из Команды
void setLaravel(Container $laravel)

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

 из Команды
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)

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $name

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

bool

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

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(Worker $worker)

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

Параметры

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

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

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|bool|null option(string|null $key = null)

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

Параметры

string|null $key

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

string|array|bool|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|null $style = null, int|string|null $verbosity = null)

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

Параметры

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

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

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

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

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Parameters

$hidden

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

Spec-Zone.ru

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