Spec-Zone.ru › Laravel 10

ScheduleWorkCommand

класс ScheduleWorkCommand расширяет Command (Просмотреть исходный код)

Трейты

CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

Фабрика консольных компонентов.

 из InteractsWithIO
protected InputInterface $input

Реализация интерфейса ввода.

 из InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

 из InteractsWithIO
protected int $verbosity

Уровень детализации вывода команд по умолчанию.

 из InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.

 из InteractsWithIO
protected Signals|null $signals

Экземпляр регистратора сигналов.

 из InteractsWithSignals
static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected Application $laravel

Экземпляр приложения Laravel.

 из Command
protected string $signature

Имя и синтаксис консольной команды.
protected string $name

Имя консольной команды.

 из Command
protected string $description

Описание консольной команды.
protected string $help

Текст справки консольной команды.

 из Command
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

 из Command
protected bool $isolated

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

 из Command
protected int $isolatedExitCode

Код выхода по умолчанию для изолированных команд.

 из Command
protected array $aliases

Псевдонимы имен консольной команды.

 из Command

Методы

Команда resolveCommand(Command|string $command)

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

 из CallsCommands
int call(Command|string $command, array $arguments = [])

Вызвать другую консольную команду.

 из CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilently(Command|string $command, array $arguments = [])

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

 из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

 из CallsCommands
массив context()

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

 из CallsCommands
void configurePrompts(InputInterface $input)

Настроить отступы подсказок.

 из ConfiguresPrompts
смешанный promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

 из ConfiguresPrompts
void restorePrompts()

Восстановить вывод подсказок.

 из ConfiguresPrompts
void specifyParameters()

Указать аргументы и параметры команды.

 из HasParameters
массив getArguments()

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

 из HasParameters
массив getOptions()

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

 из HasParameters
bool hasArgument(string|int $name)

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

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

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

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

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

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

 из InteractsWithIO
массив options()

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

 из InteractsWithIO
bool confirm(string $question, bool $default = false)

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

 из InteractsWithIO
смешанный ask(string $question, string|null $default = null)

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

 из InteractsWithIO
смешанный anticipate(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный secret(string $question, bool $fallback = true)

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

 из InteractsWithIO
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

 из InteractsWithIO
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

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

 из InteractsWithIO
смешанный|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов с прогресс-баром.

 из InteractsWithIO
void info(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

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

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

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

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

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

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

 из InteractsWithIO
void warn(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
void alert(string $string, int|string|null $verbosity = null)

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

 из InteractsWithIO
$this newLine(int $count = 1)

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

 из InteractsWithIO
void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

 из InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

 из InteractsWithIO
void setVerbosity(string|int $level)

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

 из InteractsWithIO
int parseVerbosity(string|int|null $level = null)

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

 из InteractsWithIO
OutputStyle getOutput()

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

 из InteractsWithIO
Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

 из InteractsWithIO
trap($signals, $callback)

Без описания

 из InteractsWithSignals
void untrap()

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

 из InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед валидацией ввода.

 из PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

 из PromptsForMissingInput
array promptForMissingArgumentsUsing()

Запрашивать отсутствующие аргументы ввода, используя возвращенные вопросы.

 из PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнить действия после запроса у пользователя отсутствующих аргументов.

 из PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

Ввод содержит ли какие-либо параметры, отличающиеся от значений по умолчанию.

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

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

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

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

 из Macroable
static bool hasMacro(string $name)

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

 из Macroable
static void flushMacros()

Очистить существующие макросы.

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

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

 из Macroable
mixed __call(string $method, array $parameters)

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

 из Macroable
void __construct()

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

 из Command
void configureUsingFluentDefinition()

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

 из Command
void configureIsolation()

Настроить команду консоли для изоляции.

 из Command
int run(InputInterface $input, OutputInterface $output)

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

 из Command
int execute(InputInterface $input, OutputInterface $output)

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

 из Command
CommandMutex commandIsolationMutex()

Получить экземпляр мьютекса изоляции команд для команды.

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

{@inheritdoc}

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

{@inheritdoc}

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

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

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

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

 из Команды
void handle()

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

Подробности

abstract protected Команда resolveCommand(Команда|string $command)

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

Параметры

Команда|строка $command

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

Команда

int call(Команда|строка $command, array $arguments = [])

Вызвать другую консольную команду.

Параметры

Команда|строка $command
массив $arguments

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

int

int callSilent(Команда|строка $command, array $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

int

int callSilently(Команда|строка $command, array $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

int

protected int runCommand(Команда|строка $command, array $arguments, OutputInterface $output)

Запустить заданную консольную команду.

Параметры

Команда|строка $command
массив $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив $arguments

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

ArrayInput

protected массив context()

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

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

массив

protected void configurePrompts(InputInterface $input)

Настроить параметры подсказок.

Параметры

InputInterface $input

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

void

protected смешанный promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|строка $required
Closure|null $validate

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

смешанный

protected void restorePrompts()

Восстановить вывод подсказок.

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

void

protected void specifyParameters()

Указать аргументы и параметры команды.

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

void

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

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

массив arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка $name

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

bool

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

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

Параметры

string|null $key

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

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

массив options()

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

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

массив

булево confirm(строка $question, булево $default = false)

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

Параметры

строка $question
булево $default

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

булево

смешанный тип ask(строка $question, строка|null $default = null)

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

Параметры

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

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

смешанный тип

смешанный тип anticipate(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызов $choices
строка|null $default

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

смешанный тип

смешанный тип askWithCompletion(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызов $choices
строка|null $default

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

смешанный тип

смешанный тип secret(строка $question, булево $fallback = true)

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

Параметры

строка $question
булево $fallback

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

смешанный тип

строка|массив choice(строка $question, массив $choices, строка|целое|null $default = null, смешанный тип|null $attempts = null, булево $multiple = false)

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

Параметры

строка $question
массив $choices
строка|целое|null $default
смешанный тип|null $attempts
булево $multiple

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

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

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

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

Параметры

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

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

пусто

смешанный тип|пусто withProgressBar(перечисляемый|целое $totalSteps, Closure $callback)

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

Параметры

перечисляемый|целое $totalSteps
Closure $callback

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

смешанный тип|пусто

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

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

Параметры

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

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

пусто

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

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

Параметры

строка $string
строка|null $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, целое|строка|null $verbosity = null)

Вывести строку в диалоговом окне.

Параметры

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

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

пусто

$this newLine(целое $count = 1)

Вставить пустую строку.

Параметры

целое $count

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

$this

пусто setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface $input

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

пусто

пусто setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle $output

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

пусто

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

OutputStyle getOutput()

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

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

OutputStyle

Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Описание отсутствует

Параметры

$signals
$callback

void untrap()

internal

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействие с пользователем перед валидацией ввода.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected array promptForMissingArgumentsUsing()

Запрос отсутствующих аргументов ввода с использованием возвращенных вопросов.

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнение действий после запроса отсутствующих аргументов у пользователя.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected bool didReceiveOptions(InputInterface $input)

Содержит ли ввод какие-либо опции, отличающиеся от значений по умолчанию.

Параметры

InputInterface $input

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

bool

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

Очистка существующих макросов.

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

void

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

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

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

void

protected void configureUsingFluentDefinition()

Настройка команды консоли с помощью определения fluent.

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

void

protected void configureIsolation()

Настройка команды консоли для изоляции.

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

void

int run(InputInterface $input, OutputInterface $output)

Запуск команды консоли.

Параметры

InputInterface $input
OutputInterface $output

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

int

protected int execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected CommandMutex commandIsolationMutex()

Получить экземпляр мьютекса изоляции команд для команды.

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool $hidden

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

Command

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

void handle()

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

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

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Console/Scheduling/ScheduleWorkCommand.html

Spec-Zone.ru

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