ScheduleListCommand

class ScheduleListCommand extends Command (View source)

Свойства

CallsCommands

HasParameters

InteractsWithIO

InteractsWithSignals

PromptsForMissingInput

Macroable

Свойства

protected Factory internal	$components	The console components factory.	from InteractsWithIO
protected InputInterface	$input	The input interface implementation.	from InteractsWithIO
protected OutputStyle	$output	The output interface implementation.	from InteractsWithIO
protected int	$verbosity	The default verbosity of output commands.	from InteractsWithIO
protected array	$verbosityMap	The mapping between human readable verbosity levels and Symfony's OutputInterface.	from InteractsWithIO
protected Signals\|null	$signals	The signal registrar instance.	from InteractsWithSignals
static protected array	$macros	The registered string macros.	from Macroable
protected Application	$laravel	The Laravel application instance.	from Command
protected string	$signature	The console command name.
protected string	$name	The console command name.	from Command
protected string	$description	The console command description.
protected string	$help	The console command help text.	from Command
protected bool	$hidden	Indicates whether the command should be shown in the Artisan command list.	from Command
static protected string\|null deprecated	$defaultName	The name of the console command.
static protected Closure\|null	$terminalWidthResolver	The terminal width resolver callback.

Методы

Команда	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) Вывести строку как ошибку.	из 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() Создать новый экземпляр консольной команды.	from Command
void	configureUsingFluentDefinition() Настроить консольную команду с помощью гибкого определения.	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
Command	setHidden(bool $hidden = true) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command

void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from Команда
void	handle(Расписание $schedule) Выполнить консольную команду.
static int	getTerminalWidth() Получить ширину терминала.
static void	resolveTerminalWidthUsing(Closure\|null $resolver) Установить обратный вызов, который следует использовать при определении ширины терминала.

Подробности

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

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

Параметры

Команда|string

$command

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

Команда

int call(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

int callSilent(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

int callSilently(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

protected int runCommand(Команда|string $command, array $arguments, OutputInterface $output)

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

Параметры

Команда\|string	$command
array	$arguments
OutputInterface	$output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array

$arguments

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

ArrayInput

protected array context()

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

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

array

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

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов для выполнения при появлении заданного(ых) сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

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

void

void untrap()

internal

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

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

void

END_OF_DOCUMENT_MARKER

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(Schedule $schedule)

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

Параметры

Schedule

$schedule

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

void

Исключения

Exception

static int getTerminalWidth()

Получить ширину терминала.

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

int

static void resolveTerminalWidthUsing(Closure|null $resolver)

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

Параметры

Closure|null

$resolver

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

void

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