Команда

класс 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	Сопоставление удобочитаемых уровней подробности с уровнями 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|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 $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)

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

void

alert(string $string)

Вывод строки в виде всплывающего окна.

void

setVerbosity(string|int $level)

Установка уровня подробности.

int

parseVerbosity(string|int $level = null)

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

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

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