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 bool	$hidden	Указывает, следует ли отображать команду в списке команд Artisan.	из Command
protected int	$verbosity	Уровень подробности вывода команд по умолчанию.	из Command
protected array	$verbosityMap	Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface.	из Command

Методы

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
bool	hasArgument(string\|int $name) Определить, существует ли указанный аргумент.	from Command
string\|array	argument(string\|null $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
void	alert(string $string) Вывести строку в виде всплывающего сообщения.	from Command
void	setVerbosity(string\|int $level) Установить уровень детализации.	from Command
int	parseVerbosity(string\|int $level = null) Получить уровень детализации в терминах уровня OutputInterface Symfony.	from Command
array	getArguments() Получить аргументы команды консоли.	from Command
array	getOptions() Получить параметры команды консоли.	from Command
OutputInterface	getOutput() Получить реализацию вывода.	from Command

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команда
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команда
массив	getMigrationPaths() Получить все пути миграций.
строка	getMigrationPath() Получить путь к каталогу миграций.

Подробности

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void specifyParameters()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

mixed

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

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

Параметры

string	$command
массив	$arguments

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

int

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

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

Параметры

string	$command
массив	$arguments

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

int

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

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

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

Параметры

string|null

$key

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

string|array

array arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

string|array option(string $key = null)

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

Параметры

string

$key

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

string|array

array options()

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

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

массив

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

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

Параметры

string	$question
bool	$default

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

bool

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

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

Параметры

string	$question
string	$default

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

строка

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

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

Параметры

string	$question
массив	$choices
string	$default

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

строка

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

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

Параметры

string	$question
массив	$choices
string	$default

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

строка

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

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

Параметры

string	$question
bool	$fallback

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

строка

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

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

Параметры

string	$question
массив	$choices
string	$default
mixed	$attempts
bool	$multiple

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

строка

END_OF_DOCUMENT_MARKER

void table(array $headers, Arrayable|array $rows, string $style = 'default')

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

Параметры

array	$headers
Arrayable\|array	$rows
string	$style

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

void

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

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

Параметры

string	$string
null\|int\|string	$verbosity

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string	$string
null\|int\|string	$verbosity

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

void

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

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

Параметры

string	$string
null\|int\|string	$verbosity

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

void

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

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

Параметры

string	$string
null\|int\|string	$verbosity

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

void

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

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

Параметры

string	$string
null\|int\|string	$verbosity

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

void

void alert(string $string)

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

Параметры

string

$string

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

void

protected void setVerbosity(string|int $level)

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

Параметры

string|int

$level

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

void

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

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

Параметры

string|int

$level

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

int

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

OutputInterface getOutput()

Получить реализацию вывода.

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

OutputInterface

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

protected array getMigrationPaths()

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

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

array

protected string getMigrationPath()

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

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

string

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