MonitorCommand

класс MonitorCommand расширяет DatabaseInspectionCommand (View source)

Трейты

CallsCommands

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	Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.	из 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 array	$typeMappings	Карта типов столбцов базы данных.	из DatabaseInspectionCommand
protected Composer	$composer	Экземпляр Composer.	из DatabaseInspectionCommand
static protected string\|null deprecated	$defaultName	Имя команды консоли.
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	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) Вывести строку как сообщение об ошибке.	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
void	trap(iterable<array-key,int>\|int $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(ConnectionResolverInterface $connection, Dispatcher $events, Composer $composer) Создать новый экземпляр команды.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	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

Команда	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(Команда|string $command)

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

Параметры

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

$command

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

Команда

int call(Команда|строка $command, array $arguments = [])

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

Параметры

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

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

int

int callSilent(Команда|строка $command, array $arguments = [])

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

Параметры

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

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

int

int callSilently(Команда|строка $command, array $arguments = [])

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

Параметры

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

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

int

protected int runCommand(Команда|строка $command, array $arguments, OutputInterface $output)

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

Параметры

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

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

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

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

массив

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)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

Вывести строку в всплывающее окно.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

$this newLine(int $count = 1)

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

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

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)

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

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

END_OF_DOCUMENT_MARKER

смешанный __call(string $method, array $parameters)

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

Параметры

строка	$method
массив	$parameters

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

смешанный

Исключения

BadMethodCallException

пустое значение __construct(ConnectionResolverInterface $connection, Dispatcher $events, Composer $composer)

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

Параметры

ConnectionResolverInterface	$connection
Dispatcher	$events
Composer	$composer

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

пустое значение

защищенный пустое значение configureUsingFluentDefinition()

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

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

пустое значение

защищенный пустое значение configureIsolation()

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

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

пустое значение

целое число run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищенный целое число execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищенный CommandMutex commandIsolationMutex()

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

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

CommandMutex

булево значение isHidden()

{@inheritdoc}

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

булево значение

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

булево значение

$hidden

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

Command

Application getLaravel()

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

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

Application

пустое значение setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

пустое значение

защищенный пустое значение registerTypeMappings(AbstractPlatform $platform)

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

Параметры

AbstractPlatform

$platform

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

пустое значение

защищенный строка getPlatformName(AbstractPlatform $platform, string $database)

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

Параметры

AbstractPlatform	$platform
строка	$database

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

строка

защищенный целое число|null getTableSize(ConnectionInterface $connection, string $table)

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

Параметры

ConnectionInterface	$connection
строка	$table

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

целое число|null

защищенный смешанный getMySQLTableSize(ConnectionInterface $connection, string $table)

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

Параметры

ConnectionInterface	$connection
строка	$table

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

смешанный

защищенный смешанный getPostgresTableSize(ConnectionInterface $connection, string $table)

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

Параметры

ConnectionInterface	$connection
строка	$table

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

смешанный

защищенный смешанный getSqliteTableSize(ConnectionInterface $connection, string $table)

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

Параметры

ConnectionInterface	$connection
строка	$table

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

смешанный

защищенный целое число|null getConnectionCount(ConnectionInterface $connection)

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

Параметры

ConnectionInterface

$connection

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

целое число|null

END_OF_DOCUMENT_MARKER

protected array getConfigFromDatabase(string $database)

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

Параметры

string

$database

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

array

protected bool ensureDependenciesExist()

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

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

bool

protected void installDependencies()

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

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

void

Исключения

ProcessSignaledException

void handle()

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

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

void

protected Collection parseDatabases(string $databases)

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

Параметры

string

$databases

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

Collection

protected void displayConnections(Collection $databases)

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

Параметры

Collection

$databases

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

void

protected void dispatchEvents(Collection $databases)

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

Параметры

Collection

$databases

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

void

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