MonitorCommand

class MonitorCommand extends DatabaseInspectionCommand (View source)

Трейты

CallsCommands

ConfiguresPrompts

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	Фабрика компонентов консоли.	из InteractsWithIO
protected InputInterface	$input	Реализация интерфейса ввода.	из InteractsWithIO
protected OutputStyle	$output	Реализация интерфейса вывода.	из InteractsWithIO
protected int	$verbosity	Уровень подробности вывода команд по умолчанию.	из InteractsWithIO
protected array	$verbosityMap	Сопоставление удобочитаемых уровней подробности с уровнями OutputInterface Symfony.	из InteractsWithIO
protected Signals\|null	$signals	Инстанс регистратора сигналов.	из InteractsWithSignals
static protected array	$macros	Зарегистрированные макросы строк.	из Macroable
protected Application	$laravel	Инстанс приложения Laravel.	из Command
protected string	$signature	Название и сигнатура команды консоли.
protected string	$name	Название команды консоли.	из Command
protected string	$description	Описание команды консоли.
protected string	$help	Текст справки команды консоли.	из Command
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из Command
protected bool	$isolated	Указывает, может ли выполняться только одна инстанция команды в данный момент.	из Command
protected int	$isolatedExitCode	Код выхода по умолчанию для изолированных команд.	из Command
protected array	$aliases	Псевдонимы имени команды консоли.	из Command
protected array	$typeMappings	Карта типов столбцов базы данных.	из DatabaseInspectionCommand
protected Composer	$composer	Инстанс Composer.	из DatabaseInspectionCommand
protected ConnectionResolverInterface	$connection	Инстанс решателя соединения.
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
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) Вывести строку в стандартный вывод.	из 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) Получить уровень подробности в терминах уровня Symfony's OutputInterface.	из InteractsWithIO
OutputStyle	getOutput() Получить реализацию вывода.	из InteractsWithIO
Factory	outputComponents() Получить реализацию фабрики компонентов вывода.	из InteractsWithIO
trap($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(ConnectionResolverInterface $connection, Dispatcher $events, Composer $composer) Создать новый экземпляр команды.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения в стиле fluent.	из Command

void	configureIsolation() Настроить консольную команду для изоляции.	из команды
int	run(InputInterface $input, OutputInterface $output) Выполнить консольную команду.	из команды
int	execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду.	из команды
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	из команды
bool	isHidden() {@inheritdoc}	из команды
Command	setHidden(bool $hidden = true) {@inheritdoc}	из команды
Приложение	getLaravel() Получить экземпляр приложения Laravel.	из команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из команды
void	registerTypeMappings(AbstractPlatform $platform) Зарегистрировать пользовательские сопоставления типов Doctrine для команд проверки базы данных.	из команды проверки базы данных
string	getPlatformName(AbstractPlatform $platform, string $database) Получить удобочитаемое имя платформы для данной платформы.	из команды проверки базы данных
int\|null	getTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы в байтах.	из команды проверки базы данных
mixed	getMySQLTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы MySQL в байтах.	из команды проверки базы данных
mixed	getPostgresTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы Postgres в байтах.	из команды проверки базы данных
mixed	getSqliteTableSize(Интерфейс подключения $connection, string $table) Получить размер таблицы SQLite в байтах.	из команды проверки базы данных
int\|null	getConnectionCount(Интерфейс подключения $connection) Получить количество открытых подключений к базе данных.	из команды проверки базы данных
array	getConfigFromDatabase(string $database) Получить детали конфигурации подключения для данного подключения.	из команды проверки базы данных
bool	ensureDependenciesExist() Убедиться, что зависимости команд базы данных доступны.	из команды проверки базы данных
void	installDependencies() Установить зависимости команды.	из команды проверки базы данных
void	handle() Выполнить консольную команду.
Коллекция	parseDatabases(string $databases) Обработать базу данных в массив подключений.
void	displayConnections(Коллекция $databases) Отобразить базы данных и количество подключений в консоли.
void	dispatchEvents(Коллекция $databases) Отправить события мониторинга базы данных.

Подробности

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

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

Параметры

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

$command

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

Команда

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

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

Параметры

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

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

int

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

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

Параметры

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

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

int

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

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

Параметры

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

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

int

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

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

Параметры

Command\|string	$command
array	$arguments
OutputInterface	$output

Значение результата

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array

$arguments

Значение результата

ArrayInput

protected array context()

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

Значение результата

array

protected void configurePrompts(InputInterface $input)

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

Параметры

InputInterface

$input

Значение результата

void

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

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

Параметры

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

Значение результата

mixed

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

END_OF_DOCUMENT_MARKER

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(ConnectionResolverInterface $connection, Dispatcher $events, Composer $composer)

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

Параметры

ConnectionResolverInterface	$connection
Dispatcher	$events
Composer	$composer

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

void

protected void configureUsingFluentDefinition()

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

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

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

protected void registerTypeMappings(AbstractPlatform $platform)

Зарегистрировать пользовательские отображения типов Doctrine для команд проверки.

Parameters

AbstractPlatform

$platform

Return Value

void

protected string getPlatformName(AbstractPlatform $platform, string $database)

Получить удобочитаемое имя платформы для данной платформы.

Parameters

AbstractPlatform	$platform
string	$database

Return Value

string

protected int|null getTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы в байтах.

Parameters

ConnectionInterface	$connection
string	$table

Return Value

int|null

protected mixed getMySQLTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы MySQL в байтах.

Parameters

ConnectionInterface	$connection
string	$table

Return Value

mixed

protected mixed getPostgresTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы Postgres в байтах.

Parameters

ConnectionInterface	$connection
string	$table

Return Value

mixed

protected mixed getSqliteTableSize(ConnectionInterface $connection, string $table)

Получить размер таблицы SQLite в байтах.

Parameters

ConnectionInterface	$connection
string	$table

Return Value

mixed

protected int|null getConnectionCount(ConnectionInterface $connection)

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

Parameters

ConnectionInterface

$connection

Return Value

int|null

protected array getConfigFromDatabase(string $database)

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

Parameters

string

$database

Return Value

array

protected bool ensureDependenciesExist()

Убедиться, что зависимости для команд базы данных доступны.

Return Value

bool

protected void installDependencies()

Установить зависимости команды.

Return Value

void

Exceptions

ProcessSignaledException

void handle()

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

Return Value

void

protected Collection parseDatabases(string $databases)

Разбор базы данных в массив подключений.

Parameters

string

$databases

Return Value

Collection

protected void displayConnections(Collection $databases)

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

Parameters

Collection

$databases

Return Value

void

protected void dispatchEvents(Collection $databases)

Отправить события мониторинга базы данных.

Parameters

Collection

$databases

Return Value

void

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