DownCommand

класс DownCommand расширяет Command (View source)

Свойства

Методы

protected Application	$laravel	Экземпляр приложения Laravel.	from Command
protected InputInterface	$input	Реализация интерфейса ввода.	from Command
protected OutputStyle	$output	Реализация интерфейса вывода.	from Command
protected string	$signature	Подпись команды консоли.
protected string	$name	Имя команды консоли.	from Command
protected string	$description	Описание команды консоли.
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
protected int	$verbosity	Уровень детализации вывода по умолчанию.	from Command
protected array	$verbosityMap	Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.	from 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 $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу.	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 Команда
Приложение	getLaravel() Получить экземпляр приложения Laravel.	from Команда
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	from Команда
int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до указанной даты и времени.	from Взаимодействие со временем
int	availableAt(DateTimeInterface\|DateInterval\|int $delay) Получить отметку времени "доступно в" в формате Unix timestamp.	from Взаимодействие со временем
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение представляет интервал, преобразовать его в экземпляр DateTime.	from Взаимодействие со временем

int	currentTime() Получить текущее системное время в формате UNIX timestamp.	из InteractsWithTime
void	handle() Выполнить консольную команду.
array	getDownFilePayload() Получить данные, которые должны быть помещены в файл "down".
int\|null	getRetryTime() Получить количество секунд, которое клиент должен ждать перед повторной попыткой запроса.

Подробности

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

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay)

Получить метку времени UNIX "доступно в".

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

Получить текущее системное время в формате метки времени Unix.

Значение возврата

int

void handle()

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

Значение возврата

void

protected array getDownFilePayload()

Получить полезную нагрузку для файла "down".

Значение возврата

array

protected int|null getRetryTime()

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

Значение возврата

int|null

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