Spec-Zone.ru › Laravel 8

MigrateCommand

class MigrateCommand extends BaseCommand (View source)

Свойства

ConfirmableTrait
CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

Реализация интерфейса ввода.

 из InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

 из InteractsWithIO
protected int $verbosity

Уровень подробности вывода команд по умолчанию.

 из InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface.

 из InteractsWithIO
static protected array $macros

Зарегистрированные строковые макросы.

 из Macroable
protected Application $laravel

Экземпляр приложения Laravel.

 из Command
protected string $signature

Имя и сигнатура консольной команды.
protected string $name

Имя консольной команды.

 из Command
protected string $description

Описание консольной команды.
protected string $help

Текст справки консольной команды.

 из Command
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

 из 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 specifyParameters()

Указать аргументы и параметры команды.

 из HasParameters
массив getArguments()

Получить аргументы консольной команды.

 из HasParameters
массив getOptions()

Получить параметры консольной команды.

 из HasParameters
bool hasArgument(string|int $name)

Определить, присутствует ли данный аргумент.

 из InteractsWithIO
string|массив|null argument(string|null $key = null)

Получить значение аргумента команды.

 из InteractsWithIO
массив arguments()

Получить все аргументы, переданные команде.

 из InteractsWithIO
bool hasOption(string $name)

Определить, присутствует ли данный параметр.

 из InteractsWithIO
string|массив|bool|null option(string|null $key = null)

Получить значение параметра команды.

 из InteractsWithIO
массив options()

Получить все параметры, переданные команде.

 из InteractsWithIO
bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

 из InteractsWithIO
mixed ask(string $question, string|null $default = null)

Запросить ввод у пользователя.

 из InteractsWithIO
mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Запросить ввод у пользователя с автозавершением.

 из InteractsWithIO
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Запросить ввод у пользователя с автозавершением.

 из InteractsWithIO
mixed secret(string $question, bool $fallback = true)

Запросить ввод у пользователя, но скрыть ответ в консоли.

 из InteractsWithIO
string|массив choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предложить пользователю один вариант из списка ответов.

 из InteractsWithIO
void table(array $headers, Arrayable|array $rows, 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)

Вывести строку в окне предупреждения.

 из InteractsWithIO
void 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
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
int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

 из Command
int execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

 из Command
bool isHidden()

{@inheritdoc}

 из Command
Command setHidden(bool $hidden)

{@inheritdoc}

 из Command
Application getLaravel()

Получить экземпляр приложения Laravel.

 из Command
void setLaravel(Container $laravel)

Установить экземпляр приложения Laravel.

 из Command
array 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 prepareDatabase()

Подготовить базу данных миграции для запуска.
void loadSchemaState()

Загрузить состояние схемы для инициализации структуры схемы базы данных.
END_OF_DOCUMENT_MARKER
string schemaPath(Connection $connection)

Получить путь к сохранённой схеме для данного подключения.

Подробности

abstract protected Command resolveCommand(Command|string $command)

Разрешить экземпляр командной строки для данной команды.

Параметры

Command|string $command

Возвращаемое значение

Command

int call(Command|string $command, array $arguments = [])

Вызвать другую команду консоли.

Параметры

Command|string $command
array $arguments

Возвращаемое значение

int

int callSilent(Command|string $command, array $arguments = [])

Вызвать другую команду консоли без вывода.

Параметры

Command|string $command
array $arguments

Возвращаемое значение

int

int callSilently(Command|string $command, array $arguments = [])

Вызвать другую команду консоли без вывода.

Параметры

Command|string $command
array $arguments

Возвращаемое значение

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

Выполнить данную команду консоли.

Параметры

Command|string $command
array $arguments
OutputInterface $output

Возвращаемое значение

int

protected ArrayInput createInputFromArguments(array $arguments)

Создать экземпляр ввода из заданных аргументов.

Параметры

array $arguments

Возвращаемое значение

ArrayInput

protected array context()

Получить весь контекст, переданный команде.

Возвращаемое значение

array

protected void specifyParameters()

Указать аргументы и опции команды.

Возвращаемое значение

void

protected array getArguments()

Получить аргументы командной строки.

Возвращаемое значение

array

protected array getOptions()

Получить опции командной строки.

Возвращаемое значение

array

bool hasArgument(string|int $name)

Определить, присутствует ли данный аргумент.

Параметры

string|int $name

Возвращаемое значение

bool

string|array|null argument(string|null $key = null)

Получить значение аргумента команды.

Параметры

string|null $key

Возвращаемое значение

string|array|null

array arguments()

Получить все переданные команде аргументы.

Возвращаемое значение

array

bool hasOption(string $name)

Определить, присутствует ли данная опция.

Параметры

string $name

Возвращаемое значение

bool

string|array|bool|null option(string|null $key = null)

Получить значение опции команды.

Параметры

string|null $key

Возвращаемое значение

string|array|bool|null

array options()

Получить все переданные команде опции.

Возвращаемое значение

array

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Параметры

string $question
bool $default

Возвращаемое значение

bool

mixed ask(string $question, string|null $default = null)

Запросить у пользователя ввод.

Параметры

string $question
string|null $default

Возвращаемое значение

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

Запросить у пользователя ввод с автодополнением.

Параметры

string $question
array|callable $choices
string|null $default

Возвращаемое значение

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

Запросить у пользователя ввод с автодополнением.

Параметры

string $question
array|callable $choices
string|null $default

Возвращаемое значение

mixed

mixed secret(string $question, bool $fallback = true)

Запросить у пользователя ввод, но скрыть ответ в консоли.

Параметры

string $question
bool $fallback

Возвращаемое значение

mixed

string|array choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

Предоставьте пользователю единственный выбор из массива ответов.

Parameters

string $question
array $choices
string|null $default
mixed|null $attempts
bool $multiple

Return Value

string|array

void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

Форматирует входные данные в текстовую таблицу.

Parameters

array $headers
Arrayable|array $rows
string $tableStyle
array $columnStyles

Return Value

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполняет заданный обратный вызов, одновременно продвигая полосу прогресса.

Parameters

iterable|int $totalSteps
Closure $callback

Return Value

mixed|void

void info(string $string, int|string|null $verbosity = null)

Выводит строку как информационное сообщение.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Выводит строку в стандартный вывод.

Parameters

string $string
string|null $style
int|string|null $verbosity

Return Value

void

void comment(string $string, int|string|null $verbosity = null)

Выводит строку как комментарий.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void question(string $string, int|string|null $verbosity = null)

Выводит строку как вопрос.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void error(string $string, int|string|null $verbosity = null)

Выводит строку как ошибку.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void warn(string $string, int|string|null $verbosity = null)

Выводит строку как предупреждение.

Parameters

string $string
int|string|null $verbosity

Return Value

void

void alert(string $string)

Выводит строку в окне оповещения.

Parameters

string $string

Return Value

void

void newLine(int $count = 1)

Выводит пустую строку.

Parameters

int $count

Return Value

void

void setInput(InputInterface $input)

Устанавливает реализацию интерфейса ввода.

Parameters

InputInterface $input

Return Value

void

void setOutput(OutputStyle $output)

Устанавливает реализацию интерфейса вывода.

Parameters

OutputStyle $output

Return Value

void

protected void setVerbosity(string|int $level)

Устанавливает уровень подробности.

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

Возвращает уровень подробности в терминах уровня Symfony's OutputInterface.

Parameters

string|int|null $level

Return Value

int

OutputStyle getOutput()

Возвращает реализацию вывода.

Return Value

OutputStyle

static void macro(string $name, object|callable $macro)

Регистрирует пользовательское макро.

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin, bool $replace = true)

Добавляет другой объект в класс.

Parameters

object $mixin
bool $replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрировано ли макро.

Parameters

string $name

Return Value

bool

static void flushMacros()

Очистить существующие макросы.

Возвращаемое значение

void

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы к классу.

Параметры

string $method
array $parameters

Возвращаемое значение

mixed

Исключения

BadMethodCallException

void __construct(Migrator $migrator, Dispatcher $dispatcher)

Создать новый экземпляр команды миграции.

Параметры

Migrator $migrator
Dispatcher $dispatcher

Возвращаемое значение

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

Возвращаемое значение

void

int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

Параметры

InputInterface $input
OutputInterface $output

Возвращаемое значение

int

protected int execute(InputInterface $input, OutputInterface $output)

Выполнить команду консоли.

Параметры

InputInterface $input
OutputInterface $output

Возвращаемое значение

int

bool isHidden()

{@inheritdoc}

Возвращаемое значение

bool

Command setHidden(bool $hidden)

{@inheritdoc}

Параметры

bool $hidden

Возвращаемое значение

Command

Application getLaravel()

Получить экземпляр приложения Laravel.

Возвращаемое значение

Application

void setLaravel(Container $laravel)

Установить экземпляр приложения Laravel.

Параметры

Container $laravel

Возвращаемое значение

void

protected array getMigrationPaths()

Получить все пути к миграциям.

Возвращаемое значение

array

protected bool usingRealPath()

Определить, являются ли заданные путь(и) предварительно разрешенными "реальными" путями.

Возвращаемое значение

bool

protected string getMigrationPath()

Получить путь к каталогу миграций.

Возвращаемое значение

string

bool confirmToProceed(string $warning = 'Application In Production!', Closure|bool|null $callback = null)

Подтвердить перед продолжением действия.

Этот метод запрашивает подтверждение только в рабочей среде.

Параметры

string $warning
Closure|bool|null $callback

Возвращаемое значение

bool

protected Closure getDefaultConfirmCallback()

Получить обратный вызов по умолчанию для подтверждения.

Возвращаемое значение

Closure

int handle()

Выполнить команду консоли.

Возвращаемое значение

int

protected void prepareDatabase()

Подготовить базу данных миграции для запуска.

Возвращаемое значение

void

protected void loadSchemaState()

Загрузить состояние схемы для инициализации структуры схемы базы данных.

Возвращаемое значение

void

protected string schemaPath(Connection $connection)

Получить путь к сохраненной схеме для данного подключения.

Параметры

Connection $connection

Возвращаемое значение

string

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Database/Console/Migrations/MigrateCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API