ResetCommand
class ResetCommand extends BaseCommand (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 | Сопоставление удобочитаемых уровней детализации с уровнями 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 |
| $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 |
| protected Migrator | $migrator | Экземпляр мигратора. |
Методы
| Команда | 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 |
| ?строка | 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)
Дайте пользователю единственный выбор из массива ответов. | из 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(Migrator $migrator)
Создать новый экземпляр команды отката миграции. | |
| 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 |
| string[] | getMigrationPaths()
Получить все пути к миграциям. | из BaseCommand |
| bool | usingRealPath()
Определить, являются ли заданные пути разрешёнными "реальными" путями. | из BaseCommand |
| string | getMigrationPath()
Получить путь к директории миграций. | из BaseCommand |
| 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()
Выполнить команду консоли. |
Подробности
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр команды консоли для данной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
int callSilently(Command|string $command, array $arguments = [])
Вызвать другую команду консоли без вывода.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Запустить заданную команду консоли.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
protected void configurePrompts(InputInterface $input)
Настроить резервные варианты запросов.
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Запрашивать у пользователя данные до тех пор, пока не будет выполнено заданное условие валидации.
protected ?string validatePrompt(mixed $value, mixed $rules)
Проверить заданное значение запроса с использованием валидатора.
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки запросов.
protected array validationMessages()
Получить сообщения об ошибках валидации, которые должны использоваться при проверке запросов.
protected array validationAttributes()
Получить атрибуты валидации, которые следует использовать при проверке запросов.
protected void restorePrompts()
Восстановить вывод запросов.
protected void specifyParameters()
Указать аргументы и параметры команды.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить параметры команды консоли.
bool hasArgument(string|int $name)
Определить, присутствует ли данный аргумент.
array|string|bool|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данный параметр.
string|array|bool|null option(string|null $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
mixed ask(string $question, string|null $default = null)
Задать вопрос пользователю и получить его ответ.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автозаполнением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю с автозаполнением.
mixed secret(string $question, bool $fallback = true)
Запросить у пользователя данные, но скрыть ответ от консоли.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю выбрать один вариант из массива ответов.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматировать входные данные в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов с продвижением полосы прогресса.
void info(string $string, int|string|null $verbosity = null)
Вывести строку как информационное сообщение.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Вывести строку в стандартный вывод.
void comment(string $string, int|string|null $verbosity = null)
Вывести строку как комментарий.
void question(string $string, int|string|null $verbosity = null)
Вывести строку как вопрос.
void error(string $string, int|string|null $verbosity = null)
Вывести строку как сообщение об ошибке.
void warn(string $string, int|string|null $verbosity = null)
Вывести строку как предупреждение.
void alert(string $string, int|string|null $verbosity = null)
Вывести строку в окне с предупреждением.
$this newLine(int $count = 1)
Напечатать пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
Factory outputComponents()
Получить реализацию фабрики компонентов вывода.
trap($signals, $callback)
Нет описания
void untrap()
| internal |
Обработка сигналов, установленных в обработчике команды.
protected void interact(InputInterface $input, OutputInterface $output)
Взаимодействие с пользователем перед валидацией ввода.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запрос у пользователя пропущенных аргументов.
protected array promptForMissingArgumentsUsing()
Запрос пропущенных аргументов ввода с использованием заданных вопросов.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнение действий после запроса у пользователя пропущенных аргументов.
protected bool didReceiveOptions(InputInterface $input)
Определяет, содержит ли ввод параметры, отличающиеся от значений по умолчанию.
static void macro(string $name, object|callable $macro)
Регистрация пользовательской макрокоманды.
static void mixin(object $mixin, bool $replace = true)
Включение другого объекта в класс.
static bool hasMacro(string $name)
Проверка регистрации макроса.
static void flushMacros()
Очистка существующих макросов.
static mixed __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса.
mixed __call(string $method, array $parameters)
Динамическая обработка вызовов класса.
void __construct(Migrator $migrator)
Создание нового экземпляра команды отката миграции.
protected void configureUsingFluentDefinition()
Настройка команды консоли с помощью определения fluent.
protected void configureIsolation()
Настройка команды консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запуск команды консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнение команды консоли.
protected CommandMutex commandIsolationMutex()
Получение экземпляра мьютекса изоляции команды.
void fail(Throwable|string|null $exception = null)
Принудительное завершение команды с ошибкой.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Приложение getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Контейнер $laravel)
Установить экземпляр приложения Laravel.
protected string[] getMigrationPaths()
Получить все пути миграций.
protected bool usingRealPath()
Определить, являются ли указанные пути разрешёнными "полными" путями.
protected string getMigrationPath()
Получить путь к каталогу миграций.
bool confirmToProceed(string $warning = 'Приложение в производстве', Closure|bool|null $callback = null)
Подтвердить выполнение действия перед продолжением.
Этот метод запрашивает подтверждение только в производственной среде.
protected Closure getDefaultConfirmCallback()
Получить стандартный обратный вызов подтверждения.
static void prohibit(bool $prohibit = true)
Указать, запрещено ли выполнение команды.
protected bool isProhibited(bool $quiet = false)
Определить, запрещено ли выполнение команды, и вывести предупреждение, если это так.
int handle()
Выполнить консольную команду.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/Migrations/ResetCommand.html