BatchesTableCommand

class BatchesTableCommand extends MigrationGeneratorCommand (View source)

Свойства

CallsCommands

ConfiguresPrompts

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 name and signature of the console command.	from Command
protected string	$name	The console command name.
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
protected bool	$isolated	Indicates whether only one instance of the command can run at any given time.	from Command
protected int	$isolatedExitCode	The default exit code for isolated commands.	from Command
protected array	$aliases	The console command name aliases.	from Command
protected Filesystem	$files	The filesystem instance.	from MigrationGeneratorCommand
protected Composer deprecated	$composer	The Composer instance.	from MigrationGeneratorCommand

Методы

Команда	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
массив\|строка\|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) Вывести строку в стандартный вывод.	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) Нет описания	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) Создать новый экземпляр команды генератора миграций.	from MigrationGeneratorCommand
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	from Command

void	configureIsolation() Настроить консольную команду для изоляции.	из Command
int	run(InputInterface $input, OutputInterface $output) Запустить консольную команду.	из Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду.	из Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	из Command
bool	isHidden() {@inheritdoc}	из Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	из Command
Application	getLaravel() Получить экземпляр приложения Laravel.	из Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	из Command
string	migrationTableName() Получить имя таблицы миграций.
string	migrationStubFile() Получить путь к файлу шаблона миграции.
int	handle() Выполнить консольную команду.	из MigrationGeneratorCommand
string	createBaseMigration(string $table) Создать базовый файл миграции для таблицы.	из MigrationGeneratorCommand
void	replaceMigrationPlaceholders(string $path, string $table) Заменить плейсхолдеры в сгенерированном файле миграции.	из MigrationGeneratorCommand
bool	migrationExists(string $table) Определить, существует ли миграция для таблицы.	из MigrationGeneratorCommand

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string

$command

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

Command

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

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

Параметры

Command\|string	$command
array	$arguments

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

int

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

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

Параметры

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

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

Параметры

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

END_OF_DOCUMENT_MARKER

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

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Нет описания.

Параметры

	$signals
	$callback

void untrap()

internal

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед проверкой ввода.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

Запросить отсутствующие аргументы ввода, используя возвращенные вопросы.

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Выполнить действия после того, как пользователя попросили о недостающих аргументах.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

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

Параметры

InputInterface

$input

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

bool

static void macro(string $name, object|callable $macro)

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

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверяет, зарегистрирован ли макрос.

Параметры

string

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

void __construct(Filesystem $files, Composer $composer)

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

Параметры

Filesystem	$files
Composer	$composer

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

void

protected void configureUsingFluentDefinition()

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

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

void

protected void configureIsolation()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

protected int execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

protected CommandMutex commandIsolationMutex()

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

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool

$hidden

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

Command

Application getLaravel()

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

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

Application

void setLaravel(Container $laravel)

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

Параметры

Container

$laravel

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

void

protected string migrationTableName()

Получить имя таблицы миграций.

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

string

protected string migrationStubFile()

Получить путь к файлу шаблона миграции.

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

string

int handle()

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

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

int

protected string createBaseMigration(string $table)

Создаёт базовый файл миграции для таблицы.

Параметры

string

$table

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

string

protected void replaceMigrationPlaceholders(string $path, string $table)

Заменяет плейсхолдеры в сгенерированном файле миграции.

Параметры

string	$path
string	$table

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

void

protected bool migrationExists(string $table)

Определяет, существует ли миграция для таблицы.

Параметры

string

$table

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

bool

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