StatusCommand
класс StatusCommand расширяет BaseCommand (View source)
Трейты
| 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 |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected bool | $isolated | Указывает, может ли выполняться только один экземпляр команды. | from Command |
| protected int | $isolatedExitCode | Код выхода по умолчанию для изолированных команд. | from Command |
| protected array | $aliases | Псевдонимы имени команды консоли. | from Command |
| protected Migrator | $migrator | Экземпляр мигратора. |
Методы
| Команда | resolveCommand(Команда|строка $command)
Разрешить экземпляр консольной команды для данной команды. | из CallsCommands |
| int | call(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду. | из CallsCommands |
| int | callSilent(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду без вывода. | из CallsCommands |
| int | callSilently(Команда|строка $command, массив $arguments = [])
Вызвать другую консольную команду без вывода. | из CallsCommands |
| int | runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)
Выполнить заданную консольную команду. | из CallsCommands |
| ArrayInput | createInputFromArguments(массив $arguments)
Создать экземпляр входных данных из заданных аргументов. | из CallsCommands |
| массив | context()
Получить весь контекст, переданный команде. | из CallsCommands |
| void | configurePrompts(InputInterface $input)
Настроить отступы подсказок. | из ConfiguresPrompts |
| смешанный | promptUntilValid(Closure $prompt, bool|строка $required, Closure|null $validate)
Запрашивать у пользователя данные до тех пор, пока не пройдет заданная функция проверки. | из ConfiguresPrompts |
| ?строка | validatePrompt(смешанный $value, смешанный $rules)
Проверить значение подсказки с помощью валидатора. | из ConfiguresPrompts |
| Validator | getPromptValidatorInstance(смешанный $field, смешанный $value, смешанный $rules, массив $messages = [], массив $attributes = [])
Получить экземпляр валидатора, который следует использовать для проверки подсказок. | из ConfiguresPrompts |
| массив | validationMessages()
Получить сообщения об ошибках валидации, которые следует использовать при проверке подсказок. | из ConfiguresPrompts |
| массив | validationAttributes()
Получить атрибуты валидации, которые следует использовать при проверке подсказок. | из ConfiguresPrompts |
| void | restorePrompts()
Восстановить вывод подсказок. | из ConfiguresPrompts |
| void | specifyParameters()
Указать аргументы и параметры команды. | из HasParameters |
| массив | getArguments()
Получить аргументы консольной команды. | из HasParameters |
| массив | getOptions()
Получить параметры консольной команды. | |
| bool | hasArgument(строка|int $name)
Определить, присутствует ли заданный аргумент. | из InteractsWithIO |
| массив|строка|bool|null | argument(строка|null $key = null)
Получить значение аргумента команды. | из InteractsWithIO |
| массив | arguments()
Получить все аргументы, переданные команде. | из InteractsWithIO |
| bool | hasOption(строка $name)
Определить, присутствует ли заданный параметр. | из InteractsWithIO |
| строка|массив|bool|null | option(строка|null $key = null)
Получить значение параметра команды. | из InteractsWithIO |
| массив | options()
Получить все параметры, переданные команде. | из InteractsWithIO |
| bool | confirm(строка $question, bool $default = false)
Подтвердить вопрос у пользователя. | из InteractsWithIO |
| смешанный | ask(строка $question, строка|null $default = null)
Запросить у пользователя данные. | из InteractsWithIO |
| смешанный | anticipate(строка $question, массив|вызываемая_функция $choices, строка|null $default = null)
Запросить у пользователя данные с автозаполнением. | из InteractsWithIO |
| смешанный | askWithCompletion(строка $question, массив|вызываемая_функция $choices, строка|null $default = null)
Запросить у пользователя данные с автозаполнением. | из InteractsWithIO |
| смешанный | secret(строка $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(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 |
| int|null | handle()
Выполнить консольную команду. | |
| Collection | getStatusFor(array $ran, array $batches)
Получить статус для заданных выполненных миграций. | |
| array | getAllMigrationFiles()
Получить массив всех файлов миграций. |
Подробности
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()
| внутренний |
Отменить обработчики сигналов, установленные в обработчике команды.
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}
Application getLaravel()
Получение экземпляра приложения Laravel.
void setLaravel(Container $laravel)
Установка экземпляра приложения Laravel.
protected string[] getMigrationPaths()
Получение всех путей миграций.
protected bool usingRealPath()
Определить, являются ли заданные пути предварительно разрешёнными "реальными" путями.
protected string getMigrationPath()
Получить путь к каталогу миграций.
int|null handle()
Выполнить командную строку.
protected Collection getStatusFor(array $ran, array $batches)
Получить состояние для заданных миграций.
protected array getAllMigrationFiles()
Получить массив всех файлов миграций.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/Migrations/StatusCommand.html
