Spec-Zone.ru › Laravel 5.6

DownCommand

class DownCommand extends Команда (Просмотреть исходный код)

Атрибуты

Взаимодействие со временем
Возможность макросов

Свойства

static protected array $macros Зарегистрированные строковые макросы. from Macroable
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

Методы

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макро.

 from Macroable
static void mixin(object $mixin)

Смешать другой объект в класс.

 from Macroable
static bool hasMacro(string $name)

Проверить, зарегистрировано ли макро.

 from Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы класса.

 from Macroable
mixed __call(string $method, array $parameters)

Динамически обработать вызовы класса.

 from Macroable
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
ArrayInput createInputFromArguments(array $arguments)

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

 from Command
bool hasArgument(string|int $name)

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

 from Command
string|array|null argument(string|null $key = null)

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

 from Command
array arguments()

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

 from Command
bool hasOption(string $name)

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

 from Command
string|array|null option(string|null $key = null)

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

 from Command
array options()

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

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

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

 from Command
string ask(string $question, string|null $default = null)

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

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

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

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

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

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

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

 from Command
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $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 Команда
void alert(string $string)

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

 from Команда
void setVerbosity(string|int $level)

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

 from Команда
int parseVerbosity(string|int|null $level = null)

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

 from Команда
array getArguments()

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

 from Команда
array getOptions()

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

 from Команда
OutputInterface getOutput()

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

 from Команда
Приложение getLaravel()

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

 from Команда
void setLaravel(Container $laravel)

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

 from Command
int secondsUntil(DateTimeInterface|DateInterval|int $delay)

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

 from InteractsWithTime
int availableAt(DateTimeInterface|DateInterval|int $delay)

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

 from InteractsWithTime
DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

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

 from InteractsWithTime
int currentTime()

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

 from InteractsWithTime
void handle()

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

Получить содержимое, которое нужно поместить в файл "down".
int|null getRetryTime()

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

Подробности

static void macro(string $name, object|callable $macro)

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

Параметры

строка $name
объект|вызываемый объект $macro

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

void

static void mixin(object $mixin)

Добавить другой объект в класс.

Параметры

объект $mixin

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрирована ли макрокоманда.

Параметры

строка $name

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

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы к классу.

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

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

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

string|array|null argument(string|null $key = null)

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

Параметры

string|null $key

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

string|array|null

array arguments()

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

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

array

bool hasOption(string $name)

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

Параметры

string $name

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

bool

string|array|null option(string|null $key = null)

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

Параметры

string|null $key

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

string|array|null

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

string

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

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

Параметры

string $question
array $choices
string|null $default

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

string

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

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

Параметры

string $question
array $choices
string|null $default

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

string

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

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

Параметры

string $question
bool $fallback

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

string

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

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

Параметры

string $question
array $choices
string|null $default
mixed|null $attempts
bool|null $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|null $level = null)

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

Параметры

string|int|null $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.6/Illuminate/Foundation/Console/DownCommand.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API