Spec-Zone.ru › Laravel 5.6

RetryCommand

class RetryCommand 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

Методы

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

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

from Command
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 argument(string|null $key = null)

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

from Command
array arguments()

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

from Command
bool hasOption(string $name)

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

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

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

from Command
array options()

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

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

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

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

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

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

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

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

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

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

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

from Command
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $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 Команда
void setVerbosity(string|int $level)

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

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

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

from Команда
array getArguments()

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

from Команда
array getOptions()

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

from Команда
OutputInterface getOutput()

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

from Команда
Приложение getLaravel()

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

from Команда
void setLaravel(Контейнер $laravel)

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

from Команда
void handle()

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

array getJobIds()

Получить идентификаторы задач для повторной попытки.

void retryJob(stdClass $job)

Повторить задачу очереди.

string resetAttempts(string $payload)

Сбросить попытки обработки.

Подробности

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

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

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

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

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
END_OF_DOCUMENT_MARKER

строка|массив argument(строка|null $key = null)

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

Параметры

строка|null $key

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

строка|массив

массив arguments()

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

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

массив

bool hasOption(строка $name)

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

Параметры

строка $name

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

bool

строка|массив option(строка $key = null)

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

Параметры

строка $key

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

строка|массив

массив options()

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

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

массив

bool confirm(строка $question, bool $default = false)

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

Параметры

строка $question
bool $default

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

bool

строка ask(строка $question, строка $default = null)

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

Параметры

строка $question
строка $default

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

строка

строка anticipate(строка $question, массив $choices, строка $default = null)

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

Параметры

строка $question
массив $choices
строка $default

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

строка

строка askWithCompletion(строка $question, массив $choices, строка $default = null)

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

Параметры

строка $question
массив $choices
строка $default

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

строка

строка secret(строка $question, bool $fallback = true)

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

Параметры

строка $question
bool $fallback

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

строка

строка choice(строка $question, массив $choices, строка $default = null, смешанный $attempts = null, bool $multiple = null)

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

Параметры

строка $question
массив $choices
строка $default
смешанный $attempts
bool $multiple

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

строка

пустое table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

массив $headers
Arrayable|массив $rows
строка $tableStyle
массив $columnStyles

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

пустое

пустое info(строка $string, null|целое|строка $verbosity = null)

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

Параметры

строка $string
null|целое|строка $verbosity

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

пустое

пустое line(строка $string, строка $style = null, null|целое|строка $verbosity = null)

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

Параметры

строка $string
строка $style
null|целое|строка $verbosity

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

пустое

пустое comment(строка $string, null|целое|строка $verbosity = null)

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

Параметры

строка $string
null|целое|строка $verbosity

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

пустое

пустое question(строка $string, null|целое|строка $verbosity = null)

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

Параметры

строка $string
null|целое|строка $verbosity

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

пустое

пустое error(строка $string, null|целое|строка $verbosity = null)

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

Параметры

строка $string
null|целое|строка $verbosity

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

пустое

пустое warn(строка $string, null|целое|строка $verbosity = null)

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

Параметры

строка $string
null|целое|строка $verbosity

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

пустое

пустое alert(строка $string)

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

Параметры

строка $string

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

пустое

protected пустое setVerbosity(строка|целое $level)

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

Параметры

строка|целое $level

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

пустое

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

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

Параметры

string|int $level

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

int

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputInterface getOutput()

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

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

void handle()

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

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

void

protected array getJobIds()

Получить идентификаторы задач, которые нужно повторить.

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

array

protected void retryJob(stdClass $job)

Повторить задачу очереди.

Параметры

stdClass $job

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

void

protected string resetAttempts(string $payload)

Сбросить попытки обработки.

Применимо к задачам Redis, которые хранят попытки в их payload.

Параметры

string $payload

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

string

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

Spec-Zone.ru

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