Команда

класс Command наследуется от Command (Просмотреть исходный код)

Свойства

protected Application	$laravel	Экземпляр приложения Laravel.
protected InputInterface	$input	Реализация интерфейса ввода.
protected OutputStyle	$output	Реализация интерфейса вывода.
protected string	$signature	Имя и сигнатура команды консоли.
protected string	$name	Имя команды консоли.
protected string	$description	Описание команды консоли.
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.
protected int	$verbosity	Уровень подробности вывода по умолчанию для команд.
protected array	$verbosityMap	Сопоставление уровней подробности, понятных пользователю, и уровней Symfony's OutputInterface.

Методы

void

__construct()

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

void

configureUsingFluentDefinition()

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

void

specifyParameters()

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

int

run(InputInterface $input, OutputInterface $output)

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

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|null $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 $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)

Вывести строку в окне уведомления.

void

setVerbosity(string|int $level)

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

int

parseVerbosity(string|int $level = null)

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

array

getArguments()

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

array

getOptions()

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

OutputInterface

getOutput()

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

Application

getLaravel()

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

void

setLaravel(Container $laravel)

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

Подробности

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
array	$arguments

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

int

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

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

Параметры

string	$command
array	$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()

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

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

array

bool hasOption(string $name)

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

Параметры

string

$name

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

bool

string|array option(string $key = null)

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

Параметры

string

$key

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

string|array

array options()

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

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

array

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

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

Параметры

string	$question
bool	$default

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

bool

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

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

Параметры

string	$question
string	$default

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

string

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

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

Параметры

string	$question
array	$choices
string	$default

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

string

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

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

Параметры

string	$question
array	$choices
string	$default

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

string

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

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

Параметры

string	$question
bool	$fallback

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

string

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

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

Параметры

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

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

string

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

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

Параметры

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

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

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

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