Spec-Zone.ru › Laravel 10

EventGenerateCommand

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

Трейты

ВызовКоманд
НастройкаПодсказок
ИмеетПараметры
ВзаимодействиеВводомВыводом
ВзаимодействиеССигналами
ПодсказкиДляОтсутствующегоВвода
Макросовместимый

Свойства

protected Фабрика внутренний $components

Фабрика компонентов консоли.

 от ВзаимодействиеВводомВыводом
protected InputInterface $input

Реализация интерфейса ввода.

 от ВзаимодействиеВводомВыводом
protected СтильВывода $output

Реализация интерфейса вывода.

 от ВзаимодействиеВводомВыводом
protected int $verbosity

Уровень детализации вывода по умолчанию для команд.

 от ВзаимодействиеВводомВыводом
protected array $verbosityMap

Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.

 от ВзаимодействиеВводомВыводом
protected Сигналы|null $signals

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

 от ВзаимодействиеССигналами
static protected array $macros

Зарегистрированные макросы строк.

 от Макросовместимый
protected Приложение $laravel

Экземпляр приложения Laravel.

 от Команда
protected string $signature

Имя и сигнатура команды консоли.

 от Команда
protected string $name

Имя команды консоли.
protected string $description

Описание команды консоли.
protected string $help

Текст справки команды консоли.

 от Команда
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

 от Команда
protected bool $isolated

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

 от Команда
protected int $isolatedExitCode

Код выхода по умолчанию для изолированных команд.

 от Команда
protected array $aliases

Псевдонимы имени команды консоли.

 от Команда

Методы

Команда resolveCommand(Command|string $command)

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

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

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

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

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

 из CallsCommands
int callSilently(Command|string $command, array $arguments = [])

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

 из CallsCommands
int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

 из CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

 из CallsCommands
массив context()

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

 из CallsCommands
void configurePrompts(InputInterface $input)

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

 из ConfiguresPrompts
mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

 из ConfiguresPrompts
void restorePrompts()

Восстановить вывод запросов.

 из ConfiguresPrompts
void specifyParameters()

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

 из HasParameters
массив getArguments()

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

 из HasParameters
массив getOptions()

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

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

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

 из InteractsWithIO
массив|строка|bool|null argument(string|null $key = null)

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

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

 из InteractsWithIO
строка|массив|bool|null option(string|null $key = null)

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

 из InteractsWithIO
массив options()

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

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

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

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

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

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

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

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

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

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

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

 из InteractsWithIO
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

Форматировать входные данные в таблицу.

 из InteractsWithIO
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, продвигая полосу прогресса.

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

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

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

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

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

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

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

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

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

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

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

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

 from InteractsWithIO
void alert(string $string, int|string|null $verbosity = null)

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

 from InteractsWithIO
$this newLine(int $count = 1)

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

 from InteractsWithIO
void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

 from InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

 from InteractsWithIO
void setVerbosity(string|int $level)

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

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

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

 from InteractsWithIO
OutputStyle getOutput()

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

 from InteractsWithIO
Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

 from InteractsWithIO
trap($signals, $callback)

Без описания

 from InteractsWithSignals
void untrap()

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

 from InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

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

 from PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

 from PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

 from PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнение действий после запроса у пользователя отсутствующих аргументов.

 from PromptsForMissingInput
bool didReceiveOptions(InputInterface $input)

Ввод содержит какие-либо параметры, отличающиеся от значений по умолчанию.

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

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

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

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

 from Macroable
static bool hasMacro(string $name)

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

 from Macroable
static void flushMacros()

Очистка существующих макросов.

 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()

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

 from Command
void configureIsolation()

Настроить команду консоли для изоляции.

 from Command
int run(InputInterface $input, OutputInterface $output)

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

 from Command
int execute(InputInterface $input, OutputInterface $output)

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

 from Command
CommandMutex commandIsolationMutex()

Получить экземпляр мьютекса изоляции команды для команды.

 from Command
bool isHidden()

{@inheritdoc}

 from Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

 from Command
Application getLaravel()

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

 from Command
void setLaravel(Container $laravel)

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

 from Command
void handle()

Выполнить консольную команду.
void makeEventAndListeners(string $event, array $listeners)

Создать событие и обработчики для заданного события.
void makeListeners(string $event, array $listeners)

Создать обработчики для заданного события.

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

int callSilently(Command|string $command, array $arguments = [])

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

Parameters

Command|string $command
array $arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void configurePrompts(InputInterface $input)

Настроить падения подсказок.

Parameters

InputInterface $input

Return Value

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Parameters

Closure $prompt
bool|string $required
Closure|null $validate

Return Value

mixed

protected void restorePrompts()

Восстановить вывод подсказок.

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int $name

Return Value

bool

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

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

Parameters

string|null $key

Return Value

array|string|bool|null

array arguments()

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

Return Value

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|callable $choices, string|null $default = null)

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

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

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

Параметры

string $question
array|callable $choices
string|null $default

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

mixed

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

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

Параметры

string $question
bool $fallback

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

mixed

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

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

Параметры

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

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

string|array

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

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

Параметры

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

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

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

Выполнить заданный обратный вызов, продвигая полосу прогресса.

Параметры

iterable|int $totalSteps
Closure $callback

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

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

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

Параметры

string $string
int|string|null $verbosity

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

void

$this newLine(int $count = 1)

Написать пустую строку.

Параметры

int $count

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

$this

void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

Параметры

InputInterface $input

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

void

void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

Параметры

OutputStyle $output

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

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

OutputStyle getOutput()

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

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

OutputStyle

Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

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

Factory

trap($signals, $callback)

Описание отсутствует

Параметры

$signals
$callback

void untrap()

internal

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected array promptForMissingArgumentsUsing()

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

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнить действия после запроса у пользователя отсутствующих аргументов.

Параметры

InputInterface $input
OutputInterface $output

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

void

protected bool didReceiveOptions(InputInterface $input)

Является ли ввод содержащим какие-либо опции, отличающиеся от значений по умолчанию.

Параметры

InputInterface $input

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

bool

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 void flushMacros()

Очистить существующие макросы.

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

void

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()

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

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

void

protected void configureIsolation()

Настройка консольной команды для изоляции.

Значение возвращаемого значения

void

int run(InputInterface $input, OutputInterface $output)

Выполнение консольной команды.

Параметры

InputInterface $input
OutputInterface $output

Значение возвращаемого значения

int

protected int execute(InputInterface $input, OutputInterface $output)

Выполнение консольной команды.

Параметры

InputInterface $input
OutputInterface $output

Значение возвращаемого значения

int

protected CommandMutex commandIsolationMutex()

Получение экземпляра мьютекса изоляции команды.

Значение возвращаемого значения

CommandMutex

bool isHidden()

{@inheritdoc}

Значение возвращаемого значения

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool $hidden

Значение возвращаемого значения

Command

Application getLaravel()

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

Значение возвращаемого значения

Application

void setLaravel(Container $laravel)

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

Параметры

Container $laravel

Значение возвращаемого значения

void

void handle()

Выполнение консольной команды.

Значение возвращаемого значения

void

protected void makeEventAndListeners(string $event, array $listeners)

Создание события и слушателей для данного события.

Параметры

string $event
array $listeners

Значение возвращаемого значения

void

protected void makeListeners(string $event, array $listeners)

Создание слушателей для данного события.

Параметры

string $event
array $listeners

Значение возвращаемого значения

void

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

Spec-Zone.ru

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