WorkCommand

class WorkCommand extends Command (View source)

Свойства

protected Application	$laravel	Экземпляр приложения Laravel.	из Command
protected InputInterface	$input	Реализация интерфейса ввода.	из Command
protected OutputStyle	$output	Реализация интерфейса вывода.	из Command
protected string	$signature	Имя и сигнатура командной строки.	из Command
protected string	$name	Имя командной строки.
protected string	$description	Описание командной строки.
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

string|array

argument(string $key = null)

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

из Command

string|array

option(string $key = null)

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

из 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)

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

из Command

void

line(string $string)

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

из Command

void

comment(string $string)

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

из Command

void

question(string $string)

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

из Command

void

error(string $string)

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

из Command

void

warn(string $string)

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

из Command

array

getArguments()

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

array

getOptions()

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

OutputInterface

getOutput()

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

из Command

Application

getLaravel()

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

из Command

void

setLaravel(Application $laravel)

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

из Command

void

fire()

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

array

runWorker(string $connection, string $queue, int $delay, int $memory, bool $daemon = false)

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

void

writeOutput(Job $job, bool $failed)

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

bool

downForMaintenance()

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

Details

void __construct(Worker $worker)

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

Parameters

Worker

$worker

Return Value

void

protected void configureUsingFluentDefinition()

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

Return Value

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

string|array argument(string $key = null)

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

Параметры

string

$key

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

string|array

string|array option(string $key = null)

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

Параметры

string

$key

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

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

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

Параметры

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)

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

Параметры

string

$string

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

void

void line(string $string)

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

Параметры

string

$string

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

void

void comment(string $string)

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

Параметры

string

$string

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

void

void question(string $string)

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

Параметры

string

$string

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

void

void error(string $string)

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

Параметры

string

$string

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

void

void warn(string $string)

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

Параметры

string

$string

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Application $laravel)

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

Параметры

Application

$laravel

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

void

void fire()

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

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

void

protected array runWorker(string $connection, string $queue, int $delay, int $memory, bool $daemon = false)

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

Параметры

string	$connection
string	$queue
int	$delay
int	$memory
bool	$daemon

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

array

protected void writeOutput(Job $job, bool $failed)

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

Параметры

Job	$job
bool	$failed

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

void

protected bool downForMaintenance()

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

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

bool

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