MigrateCommand
класс MigrateCommand расширяет BaseCommand и реализует Isolatable (Посмотреть исходный код)
Трейты
| ConfirmableTrait | |
| 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 | Имя и сигнатура команды консоли. | |
| protected string | $name | Имя команды консоли. | из Command |
| 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 | Экземпляр мигратора. | |
| protected Dispatcher | $dispatcher | Экземпляр диспетчера событий. |
Методы
| Команда | 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() Получить параметры консольной команды. | из 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 |
| 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, Dispatcher $dispatcher)
Создать новый экземпляр команды миграции. | |
| 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 |
| int | handle()
Выполнить консольную команду. | |
| void | runMigrations()
Выполнить ожидающие миграции. | |
| void | prepareDatabase()
Подготовить базу данных миграций для выполнения. | |
| bool | repositoryExists()
Определить, существует ли репозиторий мигратора. | |
| bool | createMissingSqliteDatabase(string $path)
Создать отсутствующую базу данных SQLite. | |
| bool | createMissingMysqlDatabase($connection)
Создать отсутствующую базу данных MySQL. | |
| void | loadSchemaState()
Загрузить состояние схемы для инициализации структуры базы данных. | |
| string | schemaPath(Connection $connection)
Получить путь к сохраненному состоянию схемы для данного подключения. |
Подробности
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, Dispatcher $dispatcher)
Создание нового экземпляра команды миграции.
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}
Команда 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()
Получить стандартный обратный вызов подтверждения.
int handle()
Выполнить командную строку.
protected void runMigrations()
Выполнить ожидающие миграции.
protected void prepareDatabase()
Подготовить базу данных миграций для выполнения.
protected bool repositoryExists()
Определить, существует ли хранилище миграций.
protected bool createMissingSqliteDatabase(string $path)
Создать отсутствующую базу данных SQLite.
protected bool createMissingMysqlDatabase($connection)
Создать отсутствующую базу данных MySQL.
protected void loadSchemaState()
Загрузить состояние схемы для заполнения начальной структуры схемы базы данных.
protected string schemaPath(Соединение $connection)
Получить путь к сохраненному состоянию схемы для данного соединения.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/Migrations/MigrateCommand.html
