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 | Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface. | from Command |
Методы
| 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 mixed | __callStatic(string $method, array $parameters) Динамически обработать вызовы к классу. | из Macroable |
| mixed | __call(string $method, array $parameters) Динамически обработать вызовы к классу. | из Macroable |
| void | __construct() Создать новый экземпляр команды консоли. | из Command |
| void | configureUsingFluentDefinition() Настроить команду консоли с помощью определения Fluent. | из Command |
| void | specifyParameters() Указать аргументы и параметры команды. | из Command |
| int | run(InputInterface $input, OutputInterface $output) Выполнить команду консоли. | из Command |
| mixed | execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли. | из Command |
| int | call(string $command, array $arguments = []) Вызвать другую команду консоли. | из Command |
| int | callSilent(string $command, array $arguments = []) Вызвать другую команду консоли без отображения вывода. | из Command |
| ArrayInput | createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов. | из Command |
| array | context() Получить весь контекст, переданный команде. | из Command |
| bool | hasArgument(string|int $name) Определить, присутствует ли заданный аргумент. | из Command |
| string|array|null | argument(string|null $key = null) Получить значение аргумента команды. | из Command |
| array | arguments() Получить все аргументы, переданные команде. | из Command |
| bool | hasOption(string $name) Определить, присутствует ли заданный параметр. | из Command |
| string|array|bool|null | option(string|null $key = null) Получить значение параметра команды. | из Command |
| array | options() Получить все параметры, переданные команде. | из Command |
| bool | confirm(string $question, bool $default = false) Подтвердить вопрос у пользователя. | из Command |
| mixed | ask(string $question, string|null $default = null) Задать вопрос пользователю и получить ответ. | из Command |
| mixed | anticipate(string $question, array $choices, string|null $default = null) Задать вопрос пользователю с автодополнением. | из Command |
| mixed | askWithCompletion(string $question, array $choices, string|null $default = null) Задать вопрос пользователю с автодополнением. | из Command |
| mixed | secret(string $question, bool $fallback = true) Задать вопрос пользователю, скрывая ответ в консоли. | из Command |
| string | choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null) Предложить пользователю выбрать один вариант из списка. | из Command |
| void | table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = []) Форматировать входные данные в таблицу. | из Command |
| void | info(string $string, int|string|null $verbosity = null) Вывести строку как информацию. | из Command |
| void | line(string $string, string|null $style = null, int|string|null $verbosity = null) Вывести строку в стандартный вывод. | из Command |
| void | comment(string $string, int|string|null $verbosity = null) Вывести строку как комментарий. | из Command |
| void | question(string $string, int|string|null $verbosity = null) Вывести строку как вопрос. | из Command |
| void | error(string $string, int|string|null $verbosity = null) Вывести строку как ошибку. | from Команда |
| void | warn(string $string, int|string|null $verbosity = null) Вывести строку как предупреждение. | from Команда |
| void | alert(string $string) Вывести строку в окне оповещения. | from Команда |
| void | setVerbosity(string|int $level) Установить уровень подробности. | from Команда |
| int | parseVerbosity(string|int|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony. | from Команда |
| isHidden() {@inheritdoc} | from Команда | |
| setHidden($hidden) {@inheritdoc} | from Команда | |
| array | getArguments() Получить аргументы командной строки. | from Команда |
| array | getOptions() Получить параметры командной строки. | from Команда |
| OutputStyle | getOutput() Получить реализацию вывода. | from Команда |
| Application | getLaravel() Получить экземпляр приложения Laravel. | from Команда |
| void | setLaravel(Container $laravel) Установить экземпляр приложения Laravel. | from Команда |
| array | getMigrationPaths() Получить все пути к миграциям. | |
| bool | usingRealPath() Определить, являются ли заданные пути «реальными» путями, предварительно разрешёнными. | |
| string | getMigrationPath() Получить путь к директории миграций. |
Details
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
mixed __call(string $method, array $parameters)
Динамически обрабатывать вызовы к классу.
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 = [])
Вызвать другую команду консоли без отображения вывода.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
bool hasArgument(string|int $name)
Определить, присутствует ли заданный аргумент.
string|array|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 $choices, string|null $default = null)
Задать пользователю вопрос с автозаполнением.
mixed askWithCompletion(string $question, array $choices, string|null $default = null)
Задать пользователю вопрос с автозаполнением.
mixed 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, 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)
Вывести строку в окне оповещения.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности в терминах уровня OutputInterface Symfony.
isHidden()
{@inheritdoc}
setHidden($hidden)
{@inheritdoc}
protected array getArguments()
Получить аргументы командной строки.
protected array getOptions()
Получить опции командной строки.
OutputStyle 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.8/Illuminate/Database/Console/Migrations/BaseCommand.html
