Spec-Zone.ru › Laravel 5.7

DownCommand

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

Трейты

Взаимодействие со временем
Макроспособный

Свойства

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

Методы

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

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

из Macroable
static void mixin(object $mixin)

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

из Macroable
static bool hasMacro(string $name)

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

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

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

из Macroable
mixed __call(string $method, array $parameters)

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

из Macroable
void __construct()

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

из Command
void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

из Command
void specifyParameters()

Указать аргументы и параметры в команде.

из Command
int run(InputInterface $input, OutputInterface $output)

Запустить команду консоли.

из Command
mixed execute(InputInterface $input, OutputInterface $output)

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

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

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

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

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

из Command
ArrayInput createInputFromArguments(array $arguments)

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

из Command
bool hasArgument(string|int $name)

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

из Command
string|array|null argument(string|null $key = null)

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

из Command
array arguments()

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

из Command
bool hasOption(string $name)

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

из Command
string|array|null option(string|null $key = null)

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

из Command
array options()

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

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

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

из Command
mixed ask(string $question, string|null $default = null)

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

из Command
mixed anticipate(string $question, array $choices, string|null $default = null)

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

из Command
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

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

из Command
mixed secret(string $question, bool $fallback = true)

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

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

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

из Command
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

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

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

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

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

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

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

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

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

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

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

из Command
void warn(string $string, int|string|null $verbosity = null)

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

из Command
void alert(string $string)

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

from Command
void setVerbosity(string|int $level)

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

from Command
int parseVerbosity(string|int|null $level = null)

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

from Command
array getArguments()

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

from Command
array getOptions()

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

from Command
OutputStyle getOutput()

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

from Command
Application getLaravel()

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

from Command
void setLaravel(Container $laravel)

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

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

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

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

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

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

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

from InteractsWithTime
int currentTime()

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

from InteractsWithTime
void handle()

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

array getDownFilePayload()

Получить полезную нагрузку для размещения в файле «down».

int|null getRetryTime()

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

Details

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

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

Parameters

string $name
object|callable $macro

Return Value

void

static void mixin(object $mixin)

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

Parameters

object $mixin

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string $method
array $parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct()

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

Return Value

void

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

Return Value

void

protected void specifyParameters()

Указать аргументы и параметры команды.

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

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

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

string|array|null

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

Задать вопрос пользователю.

Parameters

string $question
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
bool $fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string

void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

Parameters

array $headers
Arrayable|array $rows
string $tableStyle
array $columnStyles

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Parameters

string $string
int|string|null $verbosity

Return Value

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $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

OutputStyle getOutput()

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

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

OutputStyle

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 = 0)

Получить отметку времени 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.7/Illuminate/Foundation/Console/DownCommand.html

Spec-Zone.ru

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