Spec-Zone.ru › Laravel 11

MonitorCommand

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

Трейты

CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
ЗапрашиваетПропущенныйВвод
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's OutputInterface.

 from InteractsWithIO
protected Signals|null $signals

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

 from InteractsWithSignals
static protected array $macros

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

 from Macroable
protected Application $laravel

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

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

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

Имя команды консоли.

 from Команда
protected string $description

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

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

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

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

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

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

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

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

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

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

 from Команда
protected Factory $manager

Экземпляр диспетчера очереди.
protected Dispatcher $events

Экземпляр диспетчера событий.

Методы

Команда 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
смешанный promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Подсказывать пользователю, пока не будет выполнено заданное условие валидации.

 из ConfiguresPrompts
?строка validatePrompt(mixed $value, mixed $rules)

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

 из ConfiguresPrompts
Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

 из ConfiguresPrompts
массив validationMessages()

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

 из ConfiguresPrompts
массив validationAttributes()

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

 из 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
смешанный ask(string $question, string|null $default = null)

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

 из InteractsWithIO
смешанный anticipate(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

 из InteractsWithIO
смешанный secret(string $question, bool $fallback = true)

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

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

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

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

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

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

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

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

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

 from 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
статический смешанный __callStatic(строка $метод, массив $параметры)

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

 из Macroable
смешанный __call(строка $метод, массив $параметры)

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

 из Macroable
void __construct(Factory $менеджер, Dispatcher $события)

Создаёт новую команду мониторинга очереди.
void configureUsingFluentDefinition()

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

 из Command
void configureIsolation()

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

 из Command
целое число run(InputInterface $ввод, OutputInterface $вывод)

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

 из Command
целое число execute(InputInterface $ввод, OutputInterface $вывод)

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

 из Command
CommandMutex commandIsolationMutex()

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

 из Command
void fail(Throwable|строка|null $исключение = null)

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

 из Command
bool isHidden()

{@inheritdoc}

 из Command
Command setHidden(bool $скрыто = true)

{@inheritdoc}

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
void handle()

Выполнить команду консоли.
Collection parseQueues(строка $очереди)

Разбирает очереди в массив соединений и очередей.
void displaySizes(Collection $очереди)

Отображает размеры очередей в консоли.
void dispatchEvents(Collection $очереди)

Отправляет события мониторинга.

Подробности

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

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

Параметры

Command|строка $команда

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

Command

целое число call(Command|строка $команда, массив $аргументы = [])

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

Параметры

Command|строка $команда
массив $аргументы

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

целое число

целое число callSilent(Command|строка $команда, массив $аргументы = [])

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

Параметры

Command|строка $команда
массив $аргументы

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

целое число

целое число callSilently(Command|строка $команда, массив $аргументы = [])

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

Параметры

Command|строка $команда
массив $аргументы

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

целое число

защищённый целое число runCommand(Command|строка $команда, массив $аргументы, OutputInterface $вывод)

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

Параметры

Command|строка $команда
массив $аргументы
OutputInterface $вывод

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

целое число

защищённый ArrayInput createInputFromArguments(массив $аргументы)

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

Параметры

массив $аргументы

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

ArrayInput

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

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

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

массив

защищённый void configurePrompts(InputInterface $ввод)

Настроить отступы запросов.

Параметры

InputInterface $ввод

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

void

защищённый смешанный promptUntilValid(Closure $запрос, bool|строка $требуется, Closure|null $валидировать)

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

Параметры

Closure $запрос
bool|строка $требуется
Closure|null $валидировать

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

смешанный

protected ?string validatePrompt(mixed $value, mixed $rules)

Проверить заданное значение приглашения с помощью валидатора.

Параметры

mixed $value
mixed $rules

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

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Параметры

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

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

Validator

protected array validationMessages()

Получить сообщения об ошибках валидации, которые следует использовать при проверке приглашений.

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

array

protected array validationAttributes()

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

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

array

protected void restorePrompts()

Восстановить вывод приглашений.

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

array|string|bool|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|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()

внутренний

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

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

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
END_OF_DOCUMENT_MARKER

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

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

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(Factory $manager, Dispatcher $events)

Создать новую команду мониторинга очереди.

Parameters

Factory $manager
Dispatcher $events

Return Value

void

protected void configureUsingFluentDefinition()

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

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)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

void fail(Throwable|string|null $exception = null)

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

Parameters

Throwable|string|null $exception

Return Value

void

Exceptions

Throwable

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container $laravel

Return Value

void

void handle()

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

Return Value

void

protected Collection parseQueues(string $queues)

Обработать очереди в массив подключений и очередей.

Параметры

строка $queues

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

Collection

protected void displaySizes(Collection $queues)

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

Параметры

Collection $queues

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

void

protected void dispatchEvents(Collection $queues)

Запустить события мониторинга.

Параметры

Collection $queues

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

void

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

Spec-Zone.ru

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