BatchesTableCommand
class BatchesTableCommand 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 | Текст справки командной консоли. | из Команда |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | из Команда | |
| static protected string|null устарело | $defaultName | Имя командной консоли. | |
| protected ФайловаяСистема | $files | Экземпляр файловой системы. | |
| protected Композитор | $composer |
Методы
| Команда | 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)
Получить уровень подробности в терминах уровня Symfony's OutputInterface. | 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(Filesystem $files, Composer $composer)
Создать новый экземпляр команды для обработки задач очереди в пакетном режиме. | |
| 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 |
| Команда | setHidden(bool $hidden = true) {@inheritdoc} | из Команды |
| Приложение | getLaravel() Получить экземпляр приложения Laravel. | из Команды |
| void | setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel. | из Команды |
| void | handle() Выполнить консольную команду. | |
| string | createBaseMigration(string $table = 'job_batches') Создать файл базовой миграции для таблицы. | |
| void | replaceMigration(string $path, string $table) Заменить сгенерированную миграцию на шаблон таблицы задач обработки. |
Подробности
abstract protected Command resolveCommand(Command|string $command)
Разрешить экземпляр консольной команды для заданной команды.
int call(Command|string $command, array $arguments = [])
Вызвать другую консольную команду.
int callSilent(Command|string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
int callSilently(Command|string $command, array $arguments = [])
Вызвать другую консольную команду без вывода.
protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)
Выполнить заданную консольную команду.
protected ArrayInput createInputFromArguments(array $arguments)
Создать экземпляр ввода из заданных аргументов.
protected array context()
Получить весь контекст, переданный команде.
protected void specifyParameters()
Указать аргументы и опции для команды.
protected array getArguments()
Получить аргументы консольной команды.
protected array getOptions()
Получить опции консольной команды.
bool hasArgument(string|int $name)
Определить, присутствует ли данный аргумент.
array|string|bool|null argument(string|null $key = null)
Получить значение аргумента команды.
array arguments()
Получить все аргументы, переданные команде.
bool hasOption(string $name)
Определить, присутствует ли данная опция.
string|array|bool|null option(string|null $key = null)
Получить значение опции команды.
array options()
Получить все опции, переданные команде.
bool confirm(string $question, bool $default = false)
Подтвердить вопрос у пользователя.
mixed ask(string $question, string|null $default = null)
Задать вопрос пользователю для ввода.
mixed anticipate(string $question, array|callable $choices, string|null $default = null)
Задать вопрос пользователю для ввода с автодополнением.
mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)
Запросить у пользователя ввод с автозаполнением.
mixed secret(string $question, bool $fallback = true)
Запросить у пользователя ввод, но скрыть ответ из консоли.
string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)
Предложить пользователю один выбор из массива ответов.
void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])
Форматирование ввода в текстовую таблицу.
mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)
Выполнить заданный обратный вызов, одновременно продвигая полосу прогресса.
void info(string $string, int|string|null $verbosity = null)
Записать строку в качестве информационного вывода.
void line(string $string, string|null $style = null, int|string|null $verbosity = null)
Записать строку в стандартный вывод.
void comment(string $string, int|string|null $verbosity = null)
Записать строку как вывод комментария.
void question(string $string, int|string|null $verbosity = null)
Записать строку как вывод вопроса.
void error(string $string, int|string|null $verbosity = null)
Записать строку как вывод ошибки.
void warn(string $string, int|string|null $verbosity = null)
Записать строку как предупреждение.
void alert(string $string, int|string|null $verbosity = null)
Записать строку в поле с предупреждением.
$this newLine(int $count = 1)
Написать пустую строку.
void setInput(InputInterface $input)
Установить реализацию интерфейса ввода.
void setOutput(OutputStyle $output)
Установить реализацию интерфейса вывода.
protected void setVerbosity(string|int $level)
Установить уровень подробности.
protected int parseVerbosity(string|int|null $level = null)
Получить уровень подробности с точки зрения уровня OutputInterface Symfony.
OutputStyle getOutput()
Получить реализацию вывода.
void trap(iterable<array-key,int>|int $signals, $callback)
Определить обратный вызов, который будет выполнен при возникновении данного сигнала(ов).
void untrap()
| internal |
Обработка сигналов, установленных в обработчике команды.
protected void interact(InputInterface $input, OutputInterface $output)
Взаимодействие с пользователем перед валидацией ввода.
protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)
Запрос у пользователя отсутствующих аргументов.
protected array promptForMissingArgumentsUsing()
Запрос отсутствующих аргументов ввода с использованием полученных вопросов.
protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)
Выполнение действий после запроса у пользователя отсутствующих аргументов.
protected bool didReceiveOptions(InputInterface $input)
Указывает, содержит ли ввод опции, отличающиеся от значений по умолчанию.
static void macro(string $name, object|callable $macro)
Регистрация пользовательской макрокоманды.
static void mixin(object $mixin, bool $replace = true)
Добавление другого объекта в класс.
static bool hasMacro(string $name)
Проверка наличия зарегистрированной макрокоманды.
static void flushMacros()
Очистка существующих макрокоманд.
static mixed __callStatic(string $method, array $parameters)
Динамическая обработка вызовов класса.
mixed __call(string $method, array $parameters)
Динамическая обработка вызовов класса.
void __construct(Filesystem $files, Composer $composer)
Создание нового экземпляра команды пакетных задач очереди.
protected void configureUsingFluentDefinition()
Настройка команды консоли с помощью определения fluent.
protected void configureIsolation()
Настройка команды консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запуск команды консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнение команды консоли.
protected CommandMutex commandIsolationMutex()
Получение экземпляра мьютекса изоляции команды для команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Приложение getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Контейнер $laravel)
Установить экземпляр приложения Laravel.
void handle()
Выполнить команду консоли.
protected string createBaseMigration(string $table = 'job_batches')
Создать файл миграции по умолчанию для таблицы.
protected void replaceMigration(string $path, string $table)
Заменить сгенерированную миграцию на шаблон таблицы для задач обработки очереди.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Queue/Console/BatchesTableCommand.html
