Команда

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

Свойства

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

Методы

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 $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, Массив|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)

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

int

parseVerbosity(string|int $level = null)

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

void

setVerbosity(string|int $level)

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

array

getArguments()

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

array

getOptions()

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

OutputInterface

getOutput()

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

Приложение

getLaravel()

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

void

setLaravel(Контейнер $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 $key = null)

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

Параметры

string

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

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

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

Параметры

string|int

$level

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

int

protected void setVerbosity(string|int $level)

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

Параметры

string|int

$level

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

void

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.3/Illuminate/Console/Command.html