FactoryMakeCommand
class FactoryMakeCommand extends GeneratorCommand (View source)
Трейты
| CallsCommands | |
| ConfiguresPrompts | |
| HasParameters | |
| InteractsWithIO | |
| InteractsWithSignals | |
| PromptsForMissingInput | |
| Macroable |
Свойства
| protected Factory internal | $components | Фабрика компонентов консоли. | from InteractsWithIO |
| protected InputInterface | $input | Реализация интерфейса ввода. | from InteractsWithIO |
| protected OutputStyle | $output | Реализация интерфейса вывода. | from InteractsWithIO |
| protected int | $verbosity | Уровень подробности вывода команд по умолчанию. | from InteractsWithIO |
| protected array | $verbosityMap | Сопоставление удобочитаемых уровней подробности с уровнями Symfony OutputInterface. | from InteractsWithIO |
| protected Signals|null | $signals | Экземпляр регистратора сигналов. | from InteractsWithSignals |
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected Application | $laravel | Экземпляр приложения Laravel. | from Command |
| protected string | $signature | Имя и сигнатура консольной команды. | from Command |
| protected string | $name | Имя консольной команды. | |
| protected string | $description | Описание консольной команды. | |
| protected string | $help | Текст справки консольной команды. | from Command |
| $hidden | Указывает, должна ли команда отображаться в списке команд Artisan. | from Command | |
| protected bool | $isolated | Указывает, может ли выполняться только одна копия команды в данный момент. | from Command |
| protected int | $isolatedExitCode | Код возврата по умолчанию для изолированных команд. | from Command |
| protected array | $aliases | Псевдонимы имен консольной команды. | from Command |
| protected Filesystem | $files | Экземпляр файловой системы. | from GeneratorCommand |
| protected string | $type | Тип генерируемого класса. | |
| protected string[] | $reservedNames | Зарезервированные имена, которые нельзя использовать для генерации. | from GeneratorCommand |
Методы
| Команда | 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 |
| ?string | 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() Получить аргументы консольной команды. | из HasParameters |
| массив | 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 |
| 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)
Предоставьте пользователю единственный выбор из массива ответов. | 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(Filesystem $files)
Создать новый экземпляр команды генератора. | из GeneratorCommand |
| 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 |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | из GeneratorCommand |
| string | qualifyClass(string $name)
Проанализировать имя класса и отформатировать его в соответствии с корневым пространством имен. | из GeneratorCommand |
| string | qualifyModel(string $model)
Квалифицировать предоставленное имя модели по умолчанию. | из GeneratorCommand |
| array<int,string> | possibleModels()
Получить список возможных имен моделей. | из GeneratorCommand |
| array<int,string> | possibleEvents()
Получить список возможных имен событий. | из GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace)
Получить пространство имен по умолчанию для класса. | из GeneratorCommand |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | из GeneratorCommand |
| string | getPath(string $name)
Получить путь к классу назначения. | |
| string | makeDirectory(string $path)
Создать каталог для класса, если необходимо. | из GeneratorCommand |
| string | buildClass(string $name)
Сгенерировать класс с заданным именем. | |
| $this | replaceNamespace(string $stub, string $name)
Заменить пространство имен для данного шаблона. | из GeneratorCommand |
| string | getNamespace(string $name)
Получить полное пространство имен для данного класса без имени класса. | из GeneratorCommand |
| string | replaceClass(string $stub, string $name)
Заменить имя класса для данного шаблона. | из GeneratorCommand |
| string | sortImports(string $stub)
Сортирует импорты по алфавиту для данного шаблона. | из GeneratorCommand |
| string | getNameInput()
Получить желаемое имя класса из входных данных. | из GeneratorCommand |
| string | rootNamespace()
Получить корневое пространство имен для класса. | из GeneratorCommand |
| string|null | userProviderModel()
Получить модель для поставщика пользователей по умолчанию. | из GeneratorCommand |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | из GeneratorCommand |
| string | viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения. | из GeneratorCommand |
| string | resolveStubPath(string $stub)
Разрешить полностью квалифицированный путь к шаблону. | |
| string | guessModelName(string $name)
Определить имя модели по имени фабрики или вернуть имя модели по умолчанию. |
Подробности
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 configurePrompts(InputInterface $input)
Настроить подсказки для сброса.
protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)
Предложить пользователю ввести данные до тех пор, пока не будет выполнено заданное условие валидации.
protected ?string validatePrompt(mixed $value, mixed $rules)
Проверить заданное значение подсказки с помощью валидатора.
protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])
Получить экземпляр валидатора, который должен использоваться для проверки подсказок.
protected array validationMessages()
Получить сообщения об ошибках валидации, которые должны использоваться при проверке подсказок.
protected array validationAttributes()
Получить атрибуты валидации, которые должны использоваться при проверке подсказок.
protected void restorePrompts()
Восстановить вывод подсказок.
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()
Получить реализацию вывода.
Factory outputComponents()
Получить реализацию фабрики компонентов вывода.
trap($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)
Создать новый экземпляр команды генератора.
protected void configureUsingFluentDefinition()
Настроить команду консоли с помощью определения с плавным изменением.
protected void configureIsolation()
Настроить команду консоли для изоляции.
int run(InputInterface $input, OutputInterface $output)
Запустить команду консоли.
protected int execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
protected CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды.
void fail(Throwable|string|null $exception = null)
Принудительно завершить выполнение команды.
bool isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
void setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
protected string getStub()
Получить шаблонный файл для генератора.
bool|null handle()
Выполнить команду консоли.
protected string qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства.
protected string qualifyModel(string $model)
Отформатировать заданный базовый класс модели.
protected array<int,string> possibleModels()
Получить список возможных имен моделей.
protected array<int,string> possibleEvents()
Получить список возможных имён событий.
protected string getDefaultNamespace(string $rootNamespace)
Получить имя пространства по умолчанию для класса.
protected bool alreadyExists(string $rawName)
Определить, существует ли класс.
protected string getPath(string $name)
Получить путь к целевому классу.
protected string makeDirectory(string $path)
Создать директорию для класса, если необходимо.
protected string buildClass(string $name)
Сгенерировать класс с заданным именем.
protected $this replaceNamespace(string $stub, string $name)
Заменить имя пространства имён для заданного шаблона.
protected string getNamespace(string $name)
Получить полное имя пространства имён для заданного класса, без имени класса.
protected string replaceClass(string $stub, string $name)
Заменить имя класса для заданного шаблона.
protected string sortImports(string $stub)
Сортирует импорты по алфавиту для заданного шаблона.
protected string getNameInput()
Получить желаемое имя класса из входных данных.
protected string rootNamespace()
Получить корневое пространство имён для класса.
protected string|null userProviderModel()
Получить модель для провайдера пользователей по умолчанию.
protected bool isReservedName(string $name)
Проверяет, является ли заданное имя зарезервированным.
protected string viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения.
protected string resolveStubPath(string $stub)
Получить полный путь к шаблону.
protected string guessModelName(string $name)
Предположить имя модели по имени фабрики или вернуть имя модели по умолчанию.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Database/Console/Factories/FactoryMakeCommand.html
