EventListCommand

class EventListCommand extends Command (View source)

Трейты

CallsCommands

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	from InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	from InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	from InteractsWithIO
protected int	$verbosity	Уровень подробности вывода команд по умолчанию.	from InteractsWithIO
protected array	$verbosityMap	Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface.	from InteractsWithIO
protected Signals\|null	$signals	Экземпляр регистратора сигналов.	from InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	from Macroable
protected Application	$laravel	Экземпляр приложения Laravel.	from Command
protected string	$signature	Имя и сигнатура консольной команды.
protected string	$name	Имя консольной команды.	from Command
protected string	$description	Описание консольной команды.
protected string	$help	Текст справки консольной команды.	from Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	from Command
static protected string\|null deprecated	$defaultName	Имя консольной команды.
static protected Closure\|null	$eventsResolver	Обратный вызов для разрешения диспетчера событий.

Методы

Команда	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	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) Вывести строку в стандартный вывод.	из InteractsWithIO
void	comment(string $string, int\|string\|null $verbosity = null) Вывести строку как комментарий.	из InteractsWithIO
void	question(string $string, int\|string\|null $verbosity = null) Вывести строку как вопрос.	из InteractsWithIO

void	error(string $string, int\|string\|null $verbosity = null) Вывести строку как ошибку.	из InteractsWithIO
void	warn(string $string, int\|string\|null $verbosity = null) Вывести строку как предупреждение.	из InteractsWithIO
void	alert(string $string, int\|string\|null $verbosity = null) Вывести строку в окне оповещения.	из InteractsWithIO
$this	newLine(int $count = 1) Напечатать пустую строку.	из InteractsWithIO
void	setInput(InputInterface $input) Установить реализацию интерфейса ввода.	из InteractsWithIO
void	setOutput(OutputStyle $output) Установить реализацию интерфейса вывода.	из InteractsWithIO
void	setVerbosity(string\|int $level) Установить уровень подробности.	из InteractsWithIO
int	parseVerbosity(string\|int\|null $level = null) Получить уровень подробности в терминах уровня OutputInterface Symfony.	из InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	из InteractsWithIO
void	trap(iterable<array-key,int>\|int $signals, $callback) Определить обратный вызов, который будет выполнен при возникновении заданного сигнала(ов).	из InteractsWithSignals
void	untrap() Снять обработчики сигналов, заданные в обработчике команды.	из InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействовать с пользователем перед проверкой ввода.	из PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запросить у пользователя отсутствующие аргументы.	из PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запросить отсутствующие аргументы ввода, используя возвращенные вопросы.	из PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Выполнить действия после запроса у пользователя отсутствующих аргументов.	из PromptsForMissingInput
bool	didReceiveOptions(InputInterface $input) Содержит ли входные данные какие-либо параметры, отличные от значений по умолчанию.	из PromptsForMissingInput
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 void	flushMacros() Очистить существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
void	__construct() Создать новый экземпляр команды консоли.	из Command
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	из Command
void	configureIsolation() Настроить команду консоли для изоляции.	из Command
int	run(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	из Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	из Command
bool	isHidden() {@inheritdoc}	из Command

Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команды
Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
void	handle() Выполнить консольную команду.
Коллекция	getEvents() Получить все события и слушатели, настроенные для приложения.
массив	getListenersOnDispatcher() Получить события/слушателей из объекта диспетчера.
строка	appendEventInterfaces(string $event) Добавить реализованные интерфейсы событий в вывод.
строка	appendListenerInterfaces(string $listener) Добавить реализованные интерфейсы слушателей в вывод.
строка	stringifyClosure(Closure $rawListener) Получить отображаемую строковую представление слушателя Closure.
Коллекция	filterEvents(Коллекция $events) Отфильтровать заданные события с использованием заданного фильтра имени события.
bool	filteringByEvent() Определить, фильтрует ли пользователь по имени события.
массив	getRawListeners() Получить необработанный вариант слушателей событий из диспетчера событий.
Диспетчер	getEventsDispatcher() Получить диспетчер событий.
статический void	resolveEventsUsing(Closure\|null $resolver) Установить обратный вызов, который следует использовать при разрешении диспетчера событий.

Подробности

абстрактный защищённый Команда resolveCommand(Команда|строка $command)

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

Параметры

Команда|строка

$command

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

Команда

целое число call(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда\|строка	$command
массив	$arguments

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

целое число

целое число callSilent(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда\|строка	$command
массив	$arguments

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

целое число

целое число callSilently(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда\|строка	$command
массив	$arguments

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

целое число

защищённый целое число runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

Команда\|строка	$command
массив	$arguments
OutputInterface	$output

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

целое число

защищённый ArrayInput createInputFromArguments(массив $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

защищённый массив context()

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

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

массив

защищённый void specifyParameters()

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

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

void

защищённый массив getArguments()

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

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

массив

защищённый массив getOptions()

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

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

массив

bool hasArgument(строка|целое число $name)

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

Параметры

строка|целое число

$name

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

bool

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

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

Параметры

строка|null

$key

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

массив|строка|bool|null

массив arguments()

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

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

массив

bool hasOption(строка $name)

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

Параметры

строка

$name

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

bool

END_OF_DOCUMENT_MARKER

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)

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

Parameters

OutputStyle

$output

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

OutputStyle getOutput()

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

Return Value

OutputStyle

void trap(iterable<array-key,int>|int $signals, $callback)

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

Parameters

iterable<array-key,int>\|int	$signals
	$callback

Return Value

void

void untrap()

internal

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

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

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

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Return Value

void

protected void configureIsolation()

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

Return Value

void

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

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

Получить все события и слушатели, настроенные для приложения.

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

Collection

protected array getListenersOnDispatcher()

Получить событие/слушателей из объекта диспетчера.

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

array

protected string appendEventInterfaces(string $event)

Добавить реализованные интерфейсы событий в вывод.

Параметры

string

$event

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

string

protected string appendListenerInterfaces(string $listener)

Добавить реализованные интерфейсы слушателей в вывод.

Параметры

string

$listener

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

string

protected string stringifyClosure(Closure $rawListener)

Получить отображаемую строковую форму слушателя Closure.

Параметры

Closure

$rawListener

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

string

protected Collection filterEvents(Collection $events)

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

Параметры

Collection

$events

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

Collection

protected bool filteringByEvent()

Определяет, фильтрует ли пользователь по имени события.

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

bool

protected array getRawListeners()

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

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

array

Dispatcher getEventsDispatcher()

Получить диспетчер событий.

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

Dispatcher

static void resolveEventsUsing(Closure|null $resolver)

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

Параметры

Closure|null

$resolver

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

void

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