Spec-Zone.ru › Laravel 10

RefreshCommand

class RefreshCommand extends Command (View source)

Трейты

ConfirmableTrait
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

Сопоставление между уровнями подробности, читаемыми человеком, и уровнями OutputInterface Symfony.

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

Методы

Команда 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
mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

из 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
mixed ask(string $question, string|null $default = null)

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

из InteractsWithIO
mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

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

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

из InteractsWithIO
mixed 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
mixed|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()

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

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

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void configurePrompts(InputInterface $input)

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

Parameters

InputInterface $input

Return Value

void

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

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

Parameters

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

Return Value

mixed

protected void restorePrompts()

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

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array
END_OF_DOCUMENT_MARKER

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)

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

$this newLine(int $count = 1)

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

Parameters

int $count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface $input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle $output

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int $level

Return Value

void

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

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

Parameters

string|int|null $level

Return Value

int

OutputStyle getOutput()

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

Return Value

OutputStyle

Factory outputComponents()

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

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

$signals
$callback

void untrap()

internal

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

Return Value

void

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
END_OF_DOCUMENT_MARKER

смешанный __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

смешанный

Исключения

BadMethodCallException

void __construct()

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

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

void

защищен void configureUsingFluentDefinition()

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

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

void

защищен void configureIsolation()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

защищен int execute(InputInterface $input, OutputInterface $output)

Выполнение команды консоли.

Параметры

InputInterface $input
OutputInterface $output

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

int

защищен CommandMutex commandIsolationMutex()

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

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool $hidden

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

Command

Приложение getLaravel()

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

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

Приложение

void setLaravel(Контейнер $laravel)

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

Параметры

Контейнер $laravel

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

void

bool confirmToProceed(string $warning = 'Приложение В Производственной Среде', Closure|bool|null $callback = null)

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

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

Параметры

string $warning
Closure|bool|null $callback

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

bool

защищен Closure getDefaultConfirmCallback()

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

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

Closure

int handle()

Выполнение команды консоли.

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

int

защищен void runRollback(string $database, string $path, int $step)

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

Параметры

string $database
string $path
int $step

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

void

защищен void runReset(string $database, string $path)

Запуск команды сброса.

Параметры

string $database
string $path

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

void

защищен bool needsSeeding()

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

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

bool

защищен 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/10.x/Illuminate/Database/Console/Migrations/RefreshCommand.html

Spec-Zone.ru

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