Spec-Zone.ru › Laravel 11

RefreshCommand

class RefreshCommand extends Command (View source)

Трейты

ConfirmableTrait
Prohibitable
CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

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

 from InteractsWithIO
protected InputInterface $input

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

 from InteractsWithIO
protected OutputStyle $output

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

 from InteractsWithIO
protected int $verbosity

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

 from InteractsWithIO
protected array $verbosityMap

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

 from InteractsWithIO
protected Signals|null $signals

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

 from InteractsWithSignals
static protected array $macros

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

 from Macroable
protected Application $laravel

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

 from Command
protected string $signature

Имя и сигнатура команды консоли.

 from Command
protected string $name

Имя команды консоли.
protected string $description

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

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

 from Command
protected bool $hidden

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

 from Command
protected bool $isolated

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

 from Command
protected int $isolatedExitCode

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

 from Command
protected array $aliases

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

 from Command
static protected bool $prohibitedFromRunning

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

 from Prohibitable

Методы

Команда 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
?string validatePrompt(mixed $value, mixed $rules)

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

 из ConfiguresPrompts
Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

 из ConfiguresPrompts
массив validationMessages()

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

 из ConfiguresPrompts
массив validationAttributes()

Получить атрибуты валидации, которые следует использовать при проверке запросов.

 из ConfiguresPrompts
void restorePrompts()

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

 из ConfiguresPrompts
void specifyParameters()

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

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

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

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

Получить параметры консольной команды.
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
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

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

 from InteractsWithIO
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

 from InteractsWithIO
$this newLine(int $count = 1)

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

 from InteractsWithIO
void setInput(InputInterface $input)

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

 from InteractsWithIO
void setOutput(OutputStyle $output)

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

 from InteractsWithIO
void setVerbosity(string|int $level)

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

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

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

 from InteractsWithIO
OutputStyle getOutput()

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

 from InteractsWithIO
Factory outputComponents()

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

 from InteractsWithIO
trap($signals, $callback)

Без описания

 from InteractsWithSignals
void untrap()

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

 from InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

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

 from PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

 from PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

 from PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

 from PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

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

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

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

 из Command
void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

 из Command
bool isHidden()

{@inheritdoc}

 из Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
bool confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)

Подтвердить перед выполнением действия.

 из ConfirmableTrait
Closure getDefaultConfirmCallback()

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

 из ConfirmableTrait
static void prohibit(bool $prohibit = true)

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

 из Prohibitable
bool isProhibited(bool $quiet = false)

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

 из Prohibitable
int handle()

Выполнить команду консоли.
void runRollback(string $database, string $path, int $step)

Запустить команду отката.
void runReset(string $database, string $path)

Запустить команду сброса.
bool needsSeeding()

Определить, потребовалось ли разработчику запуск посева базы данных.
void runSeeder(string $database)

Запустить команду посева базы данных.

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string $command

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

Command

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput
END_OF_DOCUMENT_MARKER

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

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

Параметры

InputInterface $input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

protected ?string validatePrompt(mixed $value, mixed $rules)

Проверить предоставленное значение подсказки с помощью валидатора.

Параметры

mixed $value
mixed $rules

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

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Параметры

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

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

Validator

protected array validationMessages()

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

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

array

protected array validationAttributes()

Получить атрибуты валидации, которые следует использовать при проверке подсказок.

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

array

protected void restorePrompts()

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

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

array|string|bool|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|callable $choices, string|null $default = null)

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

mixed secret(string $question, bool $fallback = true)

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

Параметры

string $question
bool $fallback

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

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Параметры

string $question
array $choices
string|int|null $default
mixed|null $attempts
bool $multiple

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

string|array

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

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

Параметры

array $headers
Arrayable|array $rows
TableStyle|string $tableStyle
array $columnStyles

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

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable|int $totalSteps
Closure $callback

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

mixed|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, int|string|null $verbosity = null)

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

Параметры

string $string
int|string|null $verbosity

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

void

$this newLine(int $count = 1)

Напечатать пустую строку.

Параметры

int $count

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

$this

void setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

void

void setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

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

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

OutputStyle getOutput()

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

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

OutputStyle

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Без описания

Параметры

$signals
$callback

void untrap()

internal

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

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

void
END_OF_DOCUMENT_MARKER

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

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

Parameters

InputInterface $input

Return Value

bool

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

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

Return Value

void

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

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

Parameters

Throwable|string|null $exception

Return Value

void

Exceptions

Throwable

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

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

void

bool confirmToProceed(string $warning = 'Приложение в режиме работы', Closure|bool|null $callback = null)

Подтвердить перед выполнением действия.

Этот метод запрашивает подтверждение только в режиме производства.

Параметры

string $warning
Closure|bool|null $callback

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

bool

protected Closure getDefaultConfirmCallback()

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

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

Closure

static void prohibit(bool $prohibit = true)

Указать, запрещено ли выполнение команды.

Параметры

bool $prohibit

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

void

protected bool isProhibited(bool $quiet = false)

Определить, запрещено ли выполнение команды, и отобразить предупреждение, если это так.

Параметры

bool $quiet

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

bool

int handle()

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

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

int

protected void runRollback(string $database, string $path, int $step)

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

Параметры

string $database
string $path
int $step

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

void

protected void runReset(string $database, string $path)

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

Параметры

string $database
string $path

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

void

protected bool needsSeeding()

Определить, запросил ли разработчик посев базы данных.

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

bool

protected void runSeeder(string $database)

Выполнить команду посева базы данных.

Параметры

string $database

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

void

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/Migrations/RefreshCommand.html

Spec-Zone.ru

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