Spec-Zone.ru › Laravel 5.8

ClosureCommand

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

Свойства

Macroable

Свойства

static protected array $macros Зарегистрированные строковые макросы. из Macroable
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 Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface. из Команда
protected Closure $callback Обратный вызов команды.

Методы

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

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

из Macroable
static void mixin(object $mixin, bool $replace = true)

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

из Macroable
static bool hasMacro(string $name)

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

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

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

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

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

из Macroable
void __construct(string $signature, Closure $callback)

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

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 = [])

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

из Команды
ArrayInput createInputFromArguments(array $arguments)

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

из Команды
array context()

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

из Команды
bool hasArgument(string|int $name)

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

из Команды
string|array|null argument(string|null $key = null)

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

из Команды
array arguments()

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

из Команды
bool hasOption(string $name)

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

из Команды
string|array|bool|null option(string|null $key = null)

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

из Команды
array options()

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

из Команды
bool confirm(string $question, bool $default = false)

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

из Команды
mixed ask(string $question, string|null $default = null)

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

из Команды
mixed anticipate(string $question, array $choices, string|null $default = null)

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

из Команды
mixed askWithCompletion(string $question, array $choices, string|null $default = null)

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

из Команды
mixed secret(string $question, bool $fallback = true)

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

из Команды
string choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

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

из Команды
void table(array $headers, Arrayable|array $rows, string $tableStyle = 'default', array $columnStyles = [])

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

из Команды
void info(string $string, int|string|null $verbosity = null)

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

из Команды
void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

из Команды
void comment(string $string, int|string|null $verbosity = null)

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

из Команды
void question(string $string, int|string|null $verbosity = null)

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

из Команды
void error(string $string, int|string|null $verbosity = null)

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

из Команды
void warn(string $string, int|string|null $verbosity = null)

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

из Команды
void alert(string $string)

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

из Команды
void setVerbosity(string|int $level)

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

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

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

из Команды
isHidden()

{@inheritdoc}

из Команды
setHidden($hidden)

{@inheritdoc}

из Команды
array getArguments()

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

из Команды
array getOptions()

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

из Команды
OutputStyle getOutput()

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

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

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

из Команды
void setLaravel(Контейнер $laravel)

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

из Команды
$this describe(string $description)

Установить описание для команды.

Подробности

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

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

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

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

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string $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(string $signature, Closure $callback)

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

Параметры

string $signature
Closure $callback

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

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

protected array context()

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

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

array

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|bool|null option(string|null $key = null)

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

Параметры

string|null $key

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

string|array|bool|null

array options()

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

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

array

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

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

Параметры

string $question
bool $default

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

bool

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

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

Параметры

string $question
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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, int|string|null $verbosity = null)

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

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

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

void

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

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

Параметры

string $string
int|string|null $verbosity

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

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)

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

Parameters

string $string

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int $level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

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

Parameters

string|int|null $level

Return Value

int

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Parameters

$hidden

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

OutputStyle getOutput()

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

Return Value

OutputStyle

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

$this describe(string $description)

Установить описание для команды.

Parameters

string $description

Return Value

$this

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

Spec-Zone.ru

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