Spec-Zone.ru › Laravel 5.6

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)

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

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

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

 from Command
array options()

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

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

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

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

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

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

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

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

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

 from Command
string 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, 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
void alert(string $string)

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

 from Command
void setVerbosity(string|int $level)

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

 from Command
int parseVerbosity(string|int|null $level = null)

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

 from Command
array getArguments()

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

 from Command
array getOptions()

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

 from Command
OutputInterface getOutput()

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

 from Command
Application getLaravel()

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

 from Command
void setLaravel(Container $laravel)

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

 from 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 = [])

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

Parameters

string $command
array $arguments

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|null

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

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

Parameters

string $question
string|null $default

Return Value

string

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

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

Parameters

string $question
array $choices
string|null $default

Return Value

string

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

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

Parameters

string $question
array $choices
string|null $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|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

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

Parameters

string $question
array $choices
string|null $default
mixed|null $attempts
bool|null $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|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

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

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

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

Spec-Zone.ru

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