PruneCommand

class PruneCommand 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
смешанный	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя данные до тех пор, пока обратный вызов проверки не пройдет.	из ConfiguresPrompts
?string	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) Предложите пользователю единственный выбор из массива ответов.	из 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
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

статический смешанный	__callStatic(строка $метод, массив $параметры) Динамически обрабатывает вызовы к классу.	из Macroable
смешанный	__call(строка $метод, массив $параметры) Динамически обрабатывает вызовы к классу.	из Macroable
пустое	__construct() Создает новый экземпляр команды консоли.	из Command
пустое	configureUsingFluentDefinition() Настраивает команду консоли с помощью определения fluent.	из Command
пустое	configureIsolation() Настраивает команду консоли для изоляции.	из Command
целое	run(InputInterface $input, OutputInterface $output) Выполняет команду консоли.	из Command
целое	execute(InputInterface $input, OutputInterface $output) Выполняет команду консоли.	из Command
CommandMutex	commandIsolationMutex() Получает экземпляр мьютекса изоляции команды для команды.	из Command
пустое	fail(Throwable\|строка\|null $исключение = null) Принудительно завершить команду с ошибкой.	из Command
логическое	isHidden() {@inheritdoc}	из Command
Command	setHidden(логическое $скрыто = true) {@inheritdoc}	из Command
Application	getLaravel() Получить экземпляр приложения Laravel.	из Command
пустое	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	из Command
пустое	handle(Dispatcher $events) Выполнить команду консоли.
пустое	pruneModel(строка $модель) Удалить заданную модель.
Collection	models() Определить модели, которые следует удалить.
строка[]\|строка	getPath() Получить путь, где расположены модели.
логическое	isPrunable(строка $модель) Определить, является ли заданный класс модели удаляемым.
пустое	pretendToPrune(строка $модель) Отобразить количество моделей, которые будут удалены.

Подробности

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

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

Параметры

Command|строка

$команда

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

Command

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

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

Параметры

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

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

целое

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

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

Параметры

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

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

целое

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

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

Параметры

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

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

целое

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

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

Параметры

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

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

целое

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

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

Параметры

массив

$аргументы

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

ArrayInput

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

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

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

массив

защищенный пустое configurePrompts(InputInterface $ввод)

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

Параметры

InputInterface

$ввод

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

пустое

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

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

Параметры

Closure	$запрос
логическое\|строка	$обязательно
Closure\|null	$валидация

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

смешанный

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

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

Parameters

mixed	$value
mixed	$rules

Return Value

?string

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

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

Parameters

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

Return Value

Validator

protected array validationMessages()

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

Return Value

array

protected array validationAttributes()

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

Return Value

array

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)

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

Parameters

string

$name

Return Value

bool

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

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

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

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

Return Value

array

bool confirm(string $question, bool $default = false)

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

Parameters

string	$question
bool	$default

Return Value

bool

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

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

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

Return Value

mixed

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

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

mixed|void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

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

Factory outputComponents()

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

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

	$signals
	$callback

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

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct()

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

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

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

Parameters

Dispatcher

$events

Return Value

void

protected void pruneModel(string $model)

Удалить указанную модель.

Parameters

string

$model

Return Value

void

protected Collection models()

Определить модели, которые должны быть удалены.

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

Collection

protected string[]|string getPath()

Получить путь, где находятся модели.

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

string[]|string

protected bool isPrunable(string $model)

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

Параметры

string

$model

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

bool

protected void pretendToPrune(string $model)

Показать, сколько моделей будет удалено.

Параметры

string

$model

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

void

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