BaseCommand
class BaseCommand extends Command (View source)
Особенности
| Macroable |
Свойства
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected InputInterface | $input | Реализация интерфейса ввода. | from Command |
| protected OutputStyle | $output | Реализация интерфейса вывода. | from Command |
| protected string | $signature | Имя и сигнатура командной строки. | from Command |
| protected string | $name | Имя команды консоли. | from Command |
| protected string | $description | Описание команды консоли. | from Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected int | $verbosity | Уровень подробности вывода по умолчанию. | from Command |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности и OutputInterface Symfony. | from Command |
Методы
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макрос. | from Macroable |
| static void | mixin(object $mixin) Смешать другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name) Проверяет, зарегистрировано ли макрос. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы класса. | from Macroable |
| void | __construct() Создать новый экземпляр команды консоли. | from Command |
| void | configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent. | 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 |
| ArrayInput | createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов. | from Command |
| bool | hasArgument(string|int $name) Определить, присутствует ли заданный аргумент. | from Command |
| string|array|null | argument(string|null $key = null) Получить значение аргумента команды. | from Command |
| array | arguments() Получить все аргументы, переданные команде. | from Command |
| bool | hasOption(string $name) Определить, присутствует ли заданный параметр. | from Command |
| string|array|null | option(string|null $key = null) Получить значение параметра команды. | from Command |
| array | options() Получить все параметры, переданные команде. | from Command |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя. | from Command |
| string | ask(string $question, string|null $default = null) Задать вопрос пользователю и получить его ответ. | from Command |
| string | anticipate(string $question, array $choices, string|null $default = null) Задать вопрос пользователю с автозаполнением. | from Command |
| string | askWithCompletion(string $question, array $choices, string|null $default = null) Задать вопрос пользователю с автозаполнением. | from Command |
| string | secret(string $question, bool $fallback = true) Задать вопрос пользователю и скрыть ответ в консоли. | from Command |
| string | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null) Предложить пользователю выбор из массива ответов. | from Command |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу. | 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 |
| void | alert(string $string) Вывести строку в всплывающее окно. | из Command |
| void | setVerbosity(string|int $level) Установить уровень подробности. | из Command |
| int | parseVerbosity(string|int|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony. | из Command |
| array | getArguments() Получить аргументы команды консоли. | из Command |
| array | getOptions() Получить параметры команды консоли. | из Command |
| OutputInterface | getOutput() Получить реализацию вывода. | из Command |
| Application | getLaravel() Получить экземпляр приложения Laravel. | из Command |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | из Command |
| array | getMigrationPaths() Получить все пути к миграциям. | |
| bool | usingRealPath() Определить, являются ли заданные пути "реальными" путями, предварительно разрешенными. | |
| string | getMigrationPath() Получить путь к каталогу миграций. |
Подробности
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательский макрос.
static void mixin(object $mixin)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрирован ли макрос.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы класса.
void __construct()
Создать новый экземпляр команды консоли.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения с плавным изменением.
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 = [])
Вызвать другую команду консоли без отображения вывода.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
bool hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент.
string|array|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данный параметр.
string|array|null option(string|null $key = null)
Получить значение параметра команды.
array options()
Получить все параметры, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
string ask(string $question, string|null $default = null)
Запросить у пользователя ввод.
string anticipate(string $question, array $choices, string|null $default = null)
Запросить у пользователя ввод с автозаполнением.
string askWithCompletion(string $question, array $choices, string|null $default = null)
Запросить у пользователя ввод с автозаполнением.
string secret(string $question, bool $fallback = true)
Запросить у пользователя ввод, скрывая ответ в консоли.
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)
Предложить пользователю выбрать один вариант из массива ответов.
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])
Форматировать ввод в текстовую таблицу.
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)
Вывести строку как предупреждение.
void alert(string $string)
Вывести строку в диалоговом окне.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
protected array getArguments()
Получить аргументы командной строки.
protected array getOptions()
Получить опции командной строки.
OutputInterface getOutput()
Получить реализацию вывода.
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected array getMigrationPaths()
Получить все пути миграций.
protected bool usingRealPath()
Определить, являются ли заданные пути разрешенными "реальными" путями.
protected string getMigrationPath()
Получить путь к каталогу миграций.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.6/Illuminate/Database/Console/Migrations/BaseCommand.html
