PruneBatchesCommand

class PruneBatchesCommand extends Команда (View source)

Трейты

ВызываетКоманды

НастраиваетПодсказки

ИмеетПараметры

ВзаимодействуетСВводомВыводом

ВзаимодействуетССигналами

ЗапрашиваетОтсутствующийВвод

Макроспособный

Свойства

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

Методы

Команда	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

array\|string\|bool\|null	argument(string\|null $key = null) Получить значение аргумента команды.	из InteractsWithIO
array	arguments() Получить все переданные аргументы команды.	из InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли указанный параметр.	из InteractsWithIO
string\|array\|bool\|null	option(string\|null $key = null) Получить значение параметра команды.	из InteractsWithIO
array	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
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) Вывести строку как информационное сообщение.	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) Описание отсутствует	из InteractsWithSignals
void	untrap() Отменить обработчики сигналов, установленные в обработчике команды.	из InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействие с пользователем перед валидацией ввода.	из PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запросить у пользователя отсутствующие аргументы.	из PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запросить отсутствующие аргументы ввода, используя возвращаемые вопросы.	из PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Выполнить действия после запроса отсутствующих аргументов у пользователя.	из PromptsForMissingInput
bool	didReceiveOptions(InputInterface $input) Содержит ли ввод какие-либо опции, отличающиеся от значений по умолчанию?	из PromptsForMissingInput
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	из Macroable
static void	flushMacros() Очистить существующие макросы.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывать вызовы класса.	из Macroable
void	__construct() Создать новый экземпляр команды консоли.	из Command

void	настроитьСПомощьюПоточногоОпределения() Настройка команды консоли с помощью поточного определения.	из команды
void	настроитьИзоляцию() Настройка команды консоли для изоляции.	из команды
int	выполнить(InputInterface $input, OutputInterface $output) Выполнение команды консоли.	из команды
int	выполнитьКоманду(InputInterface $input, OutputInterface $output) Выполнение команды консоли.	из команды
CommandMutex	замокИзоляцииКоманды() Получить экземпляр замка изоляции команды для команды.	из команды
bool	скрытая() {@inheritdoc}	из команды
Команда	установитьСкрытость(bool $hidden = true) {@inheritdoc}	из команды
Приложение	получитьLaravel() Получить экземпляр приложения Laravel.	из команды
void	установитьLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из команды
void	обработать() Выполнить команду консоли.

Подробности

abstract protected Команда разрешитьКоманду(Команда|строка $command)

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

Параметры

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

$command

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

Команда

int вызвать(Команда|строка $command, массив $arguments = [])

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

Параметры

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

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

int

int вызватьБезВывода(Команда|строка $command, массив $arguments = [])

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

Параметры

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

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

int

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

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

Параметры

Command\|string	$command
array	$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)

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

Параметры

строка	$question
массив	$choices
строка\|целое число\|null	$default
смешанный тип\|null	$attempts
булево	$multiple

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

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

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

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

Параметры

массив	$headers
Arrayable\|массив	$rows
TableStyle\|строка	$tableStyle
массив	$columnStyles

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

void

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

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

Параметры

iterable\|целое число	$totalSteps
Closure	$callback

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

смешанный тип|void

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

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

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

void

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

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

Параметры

строка	$string
строка\|null	$style
целое число\|строка\|null	$verbosity

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

void

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

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

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

void

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

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

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

void

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

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

Параметры

строка	$string
целое число\|строка\|null	$verbosity

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

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

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

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

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

void

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