MigrationGeneratorCommand
абстрактный класс MigrationGeneratorCommand расширяет Command (View source)
Трейты
| 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's OutputInterface. | из InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | из InteractsWithSignals |
| static protected array | $macros | Зарегистрированные строковые макросы. | из Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected string | $signature | Имя и сигнатура консольной команды. | из Command |
| protected string | $name | Имя консольной команды. | из Command |
| protected string|null | $description | Описание консольной команды. | из Command |
| protected string | $help | Текст справки консольной команды. | из Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Command | |
| protected bool | $isolated | Указывает, может ли выполняться только одна инстанция команды в данный момент. | из Command |
| protected int | $isolatedExitCode | Код завершения по умолчанию для изолированных команд. | из Command |
| protected array | $aliases | Псевдонимы имен консольной команды. | из Command |
| protected Filesystem | $files | Экземпляр файловой системы. |
Методы
| Команда | 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()
Получить параметры консольной команды. | из HasParameters |
| 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 |
| строка|массив | 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(Filesystem $files)
Создать новый экземпляр команды генератора миграций. | |
| void | configureUsingFluentDefinition()
Настроить команду консоли с помощью определения fluent. | из Команды |
| void | configureIsolation()
Настроить команду консоли для изоляции. | из Команды |
| int | run(InputInterface $input, OutputInterface $output)
Запустить команду консоли. | из Команды |
| int | execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли. | из Команды |
| 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. | из Команды |
| string | migrationTableName()
Получить имя таблицы миграций. | |
| string | migrationStubFile()
Получить путь к файлу шаблона миграции. | |
| int | handle()
Выполнить команду консоли. | |
| string | createBaseMigration(string $table)
Создать базовый файл миграции для таблицы. | |
| void | replaceMigrationPlaceholders(string $path, string $table)
Заменить плацехолдеры в сгенерированном файле миграции. | |
| bool | migrationExists(string $table)
Определить, существует ли миграция для таблицы. |
Подробности
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(Filesystem $files)
Создать новый экземпляр команды генератора миграций.
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.
abstract protected string migrationTableName()
Получить имя таблицы миграций.
abstract protected string migrationStubFile()
Получить путь к файлу шаблона миграции.
int handle()
Выполнить команду консоли.
protected string createBaseMigration(string $table)
Создать базовый файл миграции для таблицы.
protected void replaceMigrationPlaceholders(string $path, string $table)
Заменить плейсхолдеры в сгенерированном файле миграции.
protected bool migrationExists(string $table)
Определить, существует ли миграция для таблицы.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Console/MigrationGeneratorCommand.html
