Spec-Zone.ru › Laravel 11

SeedCommand

класс SeedCommand расширяет Command (View source)

Трейты

ConfirmableTrait
CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

Фабрика компонентов консоли.

из InteractsWithIO
protected InputInterface $input

Реализация интерфейса ввода.

из InteractsWithIO
protected OutputStyle $output

Реализация интерфейса вывода.

из InteractsWithIO
protected int $verbosity

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

из InteractsWithIO
protected array $verbosityMap

Сопоставление удобочитаемых уровней детализации с уровнями Symfony OutputInterface.

из InteractsWithIO
protected Signals|null $signals

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

из InteractsWithSignals
static protected array $macros

Зарегистрированные макросы строк.

из Macroable
protected Application $laravel

Экземпляр приложения Laravel.

из Command
protected string $signature

Имя и сигнатура команды консоли.

из Command
protected string $name

Имя команды консоли.

protected string $description

Описание команды консоли.

protected string $help

Текст справки команды консоли.

из Command
protected bool $hidden

Указывает, должна ли команда отображаться в списке команд Artisan.

из Command
protected bool $isolated

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

из Command
protected int $isolatedExitCode

Код завершения по умолчанию для изолированных команд.

из Command
protected array $aliases

Псевдонимы имени команды консоли.

из Command
protected ConnectionResolverInterface $resolver

Экземпляр решателя соединений.

Методы

Команда 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
?строка 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()

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

массив getOptions()

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

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)

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

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

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

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

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

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

Без описания

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

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

из Macroable
static mixed __callStatic(string $method, array $parameters)

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

из Macroable
mixed __call(string $method, array $parameters)

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

из Macroable
void __construct(ConnectionResolverInterface $resolver)

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

void configureUsingFluentDefinition()

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

из Command
void configureIsolation()

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

из Command
int run(InputInterface $input, OutputInterface $output)

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

из Command
int execute(InputInterface $input, OutputInterface $output)

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

из Command
CommandMutex commandIsolationMutex()

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

из Command
void fail(Throwable|string|null $exception = null)

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

из Command
bool isHidden()

{@inheritdoc}

из Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

из Command
Application getLaravel()

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

из Command
void setLaravel(Container $laravel)

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

из Command
bool confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)

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

из ConfirmableTrait
Closure getDefaultConfirmCallback()

Получить стандартный обратный вызов подтверждения.

из ConfirmableTrait
int handle()

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

Seeder getSeeder()

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

string getDatabase()

Получить имя подключения к базе данных для использования.

Подробности

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
END_OF_DOCUMENT_MARKER

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

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

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

Параметры

mixed $value
mixed $rules

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

?string

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

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

Параметры

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

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

Validator

protected array validationMessages()

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

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

array

protected array validationAttributes()

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

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

array

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
END_OF_DOCUMENT_MARKER

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

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

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(ConnectionResolverInterface $resolver)

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

Параметры

ConnectionResolverInterface $resolver

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

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

void fail(Throwable|string|null $exception = null)

Ручное прерывание выполнения команды.

Параметры

Throwable|string|null $exception

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

void

Исключения

Throwable

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

bool confirmToProceed(string $warning = 'Application In Production', Closure|bool|null $callback = null)

Подтверждение перед продолжением действия.

Этот метод запрашивает подтверждение только в режиме производства.

Параметры

string $warning
Closure|bool|null $callback

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

bool

protected Closure getDefaultConfirmCallback()

Получить обратный вызов подтверждения по умолчанию.

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

Closure

int handle()

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

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

int

protected Seeder getSeeder()

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

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

Seeder

protected string getDatabase()

Получить имя подключения к базе данных для использования.

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

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API