StatusCommand
класс StatusCommand расширяет BaseCommand (Просмотреть исходный код)
Трейты
| 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 | Имя и синтаксис команды консоли. | из Command |
| protected string | $name | Имя команды консоли. | |
| protected string | $description | Описание команды консоли. | |
| protected string | $help | Текст справки по команде консоли. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected bool | $isolated | Указывает, может ли в данный момент выполняться только один экземпляр команды. | из Command |
| protected int | $isolatedExitCode | Код выхода по умолчанию для изолированных команд. | из Command |
| protected array | $aliases | Псевдонимы имен команд консоли. | из Command |
| 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 |
| 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()
Получить все параметры, переданные команде. | |
| 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)
Вывести строку в стандартный вывод. | 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)
Получить уровень подробности с точки зрения уровня Symfony's OutputInterface. | 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()
Очистить существующие макросы. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters)
Динамически обработать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters)
Динамически обработать вызовы класса. | from Macroable |
| void | __construct(Migrator $migrator)
Создать новый экземпляр команды отката миграции. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | from Command |
| void | configureIsolation()
Настроить команду консоли для изоляции. | from Command |
| int | run(InputInterface $input, OutputInterface $output) Запустить консольную команду. | from Command |
| int | execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду. | from Command |
| CommandMutex | commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | from Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | from Command |
| array | getMigrationPaths() Получить все пути миграций. | from BaseCommand |
| bool | usingRealPath() Определить, являются ли заданные пути разрешенными «реальными» путями. | from BaseCommand |
| string | getMigrationPath() Получить путь к каталогу миграций. | from BaseCommand |
| int|null | handle() Выполнить консольную команду. | |
| Collection | getStatusFor(array $ran, array $batches) Получить состояние для заданных миграций. | |
| array | getAllMigrationFiles() Получить массив всех файлов миграций. |
Details
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 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)
Динамически обработать вызовы класса.
смешанный __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()
Получает экземпляр мьютекса изоляции команды для команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected массив getMigrationPaths()
Получить все пути к миграциям.
protected bool usingRealPath()
Определить, являются ли указанные путь(и) предопределёнными "реальными" путями.
protected строка getMigrationPath()
Получить путь к каталогу миграций.
int|null handle()
Выполнить команду консоли.
protected Collection getStatusFor(array $ran, array $batches)
Получить состояние для заданных миграций.
protected массив getAllMigrationFiles()
Получить массив всех файлов миграций.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Database/Console/Migrations/StatusCommand.html