BaseCommand
class BaseCommand extends Command (View source)
Свойства
| protected Application | $laravel | Экземпляр приложения Laravel. | из Command |
| protected InputInterface | $input | Реализация интерфейса ввода. | из Command |
| protected OutputStyle | $output | Реализация интерфейса вывода. | из Command |
| protected string | $signature | Имя и сигнатура команды консоли. | из Command |
| protected string | $name | Имя команды консоли. | из Command |
| protected string | $description | Описание команды консоли. | из Command |
| protected int | $verbosity | Уровень детализации вывода по умолчанию. | из Command |
| protected array | $verbosityMap | Сопоставление уровней детализации для удобочитаемых значений и OutputInterface Symfony. | из Command |
Методы
| void | __construct() Создать новый экземпляр консольной команды. | from Command |
| void | configureUsingFluentDefinition() Настроить консольную команду с помощью гибкого определения. | from Command |
| void | specifyParameters() Указать аргументы и параметры в команде. | from Command |
| int | run(InputInterface $input, OutputInterface $output) Запустить консольную команду. | from Command |
| mixed | execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду. | from Command |
| int | call(string $command, array $arguments = []) Вызвать другую консольную команду. | from Command |
| int | callSilent(string $command, array $arguments = []) Вызвать другую консольную команду без вывода. | from Command |
| bool | hasArgument(string|int $name) Определить, присутствует ли данный аргумент. | from Command |
| string|array | argument(string $key = null) Получить значение аргумента команды. | from Command |
| array | arguments() Получить все аргументы, переданные в команду. | from Command |
| bool | hasOption(string $name) Определить, присутствует ли данная опция. | from Command |
| string|array | option(string $key = null) Получить значение опции команды. | from Command |
| array | options() Получить все опции, переданные в команду. | from Command |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос с пользователем. | from Command |
| string | ask(string $question, string $default = null) Запросить у пользователя ввод. | from Command |
| string | anticipate(string $question, array $choices, string $default = null) Запросить у пользователя ввод с автодополнением. | from Command |
| string | askWithCompletion(string $question, array $choices, string $default = null) Запросить у пользователя ввод с автодополнением. | from Command |
| string | secret(string $question, bool $fallback = true) Запросить у пользователя ввод, но скрыть ответ от консоли. | from Command |
| string | choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null) Предоставить пользователю выбор одного варианта из массива ответов. | from Command |
| void | table(array $headers, Arrayable|array $rows, string $style = 'default') Форматировать ввод в текстовую таблицу. | from Command |
| void | info(string $string, null|int|string $verbosity = null) Вывести строку как информационное сообщение. | from Command |
| void | line(string $string, string $style = null, null|int|string $verbosity = null) Вывести строку как стандартный вывод. | from Command |
| void | comment(string $string, null|int|string $verbosity = null) Вывести строку как комментарий. | from Command |
| void | question(string $string, null|int|string $verbosity = null) Вывести строку как вопрос. | from Command |
| void | error(string $string, null|int|string $verbosity = null) Вывести строку как сообщение об ошибке. | from Command |
| void | warn(string $string, null|int|string $verbosity = null) Вывести строку как предупреждение. | from Command |
| int | parseVerbosity(string|int $level = null) Получить уровень подробности в терминах уровня Symfony's OutputInterface. | from Command |
| void | setVerbosity(string|int $level) Установить уровень подробности. | from Command |
| array | getArguments() Получить аргументы консольной команды. | from Command |
| array | getOptions() Получить опции консольной команды. | from Command |
| OutputInterface | getOutput() Получить реализацию вывода. | from Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | из Command |
| string | getMigrationPath() Получить путь к каталогу миграций. | |
| array | getMigrationPaths() Получить все пути к каталогам миграций. |
Подробности
void __construct()
Создать новый экземпляр команды консоли.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения Fluent.
protected void specifyParameters()
Указать аргументы и параметры команды.
int run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected mixed execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
int call(string $command, array $arguments = [])
Вызвать другую команду консоли.
int callSilent(string $command, array $arguments = [])
Вызвать другую команду консоли без отображения вывода.
bool hasArgument(string|int $name)
Определить, присутствует ли данный аргумент.
string|array argument(string $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данный параметр.
string|array option(string $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
string ask(string $question, string $default = null)
Запросить у пользователя ввод.
string anticipate(string $question, array $choices, string $default = null)
Запросить у пользователя ввод с автозавершением.
string askWithCompletion(string $question, array $choices, string $default = null)
Запросить у пользователя ввод с автозавершением.
string secret(string $question, bool $fallback = true)
Запросить у пользователя ввод, скрывая ответ в консоли.
string choice(string $question, array $choices, string $default = null, mixed $attempts = null, bool $multiple = null)
Предложить пользователю единственный выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, string $style = 'default')
Форматировать входные данные в текстовую таблицу.
void info(string $string, null|int|string $verbosity = null)
Вывести строку в качестве информационного сообщения.
void line(string $string, string $style = null, null|int|string $verbosity = null)
Вывести строку в стандартный вывод.
void comment(string $string, null|int|string $verbosity = null)
Вывести строку как комментарий.
void question(string $string, null|int|string $verbosity = null)
Вывести строку в качестве вопроса.
void error(string $string, null|int|string $verbosity = null)
Вывести строку как сообщение об ошибке.
void warn(string $string, null|int|string $verbosity = null)
Вывести строку как предупреждение.
protected int parseVerbosity(string|int $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected array getArguments()
Получить аргументы команды консоли.
protected array getOptions()
Получить опции команды консоли.
OutputInterface getOutput()
Получить реализацию вывода.
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected string getMigrationPath()
Получить путь к каталогу миграций.
protected array getMigrationPaths()
Получить все пути к миграциям.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Database/Console/Migrations/BaseCommand.html
