Spec-Zone.ru › Laravel 5.8

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

Методы

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

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

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

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

from Команда
void alert(string $string)

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

from Команда
void setVerbosity(string|int $level)

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

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

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

from Команда
isHidden()

{@inheritdoc}

from Команда
setHidden($hidden)

{@inheritdoc}

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

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

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

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

from Команда
OutputStyle 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, bool $replace = true)

Вставить другой объект в класс.

Parameters

object $mixin
bool $replace

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

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

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
END_OF_DOCUMENT_MARKER

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)

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

Параметры

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)

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

Параметры

string $string
int|string|null $verbosity

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

void

void alert(string $string)

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

Параметры

string $string

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

void

protected void setVerbosity(string|int $level)

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

Параметры

string|int $level

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

void

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

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

Параметры

string|int|null $level

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

int

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

$hidden

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputStyle getOutput()

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

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

OutputStyle

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, которые хранят попытки в своем содержимом.

Параметры

string $payload

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

string

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

Spec-Zone.ru

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