Команда

класс Команда расширяет 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)

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

bool

hasOption(string $name)

Определить, присутствует ли данная опция.

string|array

option(string $key = null)

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

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)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

mixed

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

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

Parameters

string	$command
array	$arguments

Return Value

int

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

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

Parameters

string	$command
array	$arguments

Return Value

int

bool hasArgument(string|int $name)

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

Parameters

string|int

$name

Return Value

bool

string|array argument(string $key = null)

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

Parameters

string

$key

Return Value

string|array

bool hasOption(string $name)

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

Parameters

string

$name

Return Value

bool

string|array option(string $key = null)

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

Parameters

string

$key

Return Value

string|array

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

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string	$default

Return Value

string

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

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

Parameters

string	$question
array	$choices
string	$default

Return Value

string

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

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

Parameters

string	$question
array	$choices
string	$default

Return Value

string

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

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

Parameters

string	$question
bool	$fallback

Return Value

string

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

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

Parameters

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

Return Value

string

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

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