Spec-Zone.ru › Laravel 9

FactoryMakeCommand

класс FactoryMakeCommand расширяет GeneratorCommand (Просмотреть исходный код)

Трейты

CallsCommands
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's 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 Filesystem $files

Экземпляр файловой системы.

из GeneratorCommand
protected string $type

Тип генерируемого класса.

protected string[] $reservedNames

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

из GeneratorCommand
static protected string|null deprecated $defaultName

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

Методы

Команда 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()

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

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
строка|массив 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
смешанный|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(Filesystem $files)

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

from GeneratorCommand
void configureUsingFluentDefinition()

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

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
Приложение getLaravel()

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

из Команды
void setLaravel(Контейнер $laravel)

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

из Команды
строка getStub()

Получить шаблонный файл для генератора.

bool|null handle()

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

из Команды генерации
строка qualifyClass(строка $name)

Обработать имя класса и отформатировать его согласно корневому пространству имён.

из Команды генерации
строка qualifyModel(строка $model)

Обработать имя заданного класса модели.

из Команды генерации
массив<int,строка> possibleModels()

Получить список возможных имён моделей.

из Команды генерации
массив<int,строка> possibleEvents()

Получить список возможных имён событий.

из Команды генерации
строка getDefaultNamespace(строка $rootNamespace)

Получить пространство имён по умолчанию для класса.

из Команды генерации
bool alreadyExists(строка $rawName)

Определить, существует ли класс.

из Команды генерации
строка getPath(строка $name)

Получить путь к целевому классу.

строка makeDirectory(строка $path)

Создать директорию для класса, если необходимо.

из Команды генерации
строка buildClass(строка $name)

Сгенерировать класс с заданным именем.

$this replaceNamespace(строка $stub, строка $name)

Заменить пространство имён в данном шаблоне.

из Команды генерации
строка getNamespace(строка $name)

Получить полное пространство имён для данного класса, без имени класса.

из Команды генерации
строка replaceClass(строка $stub, строка $name)

Заменить имя класса в данном шаблоне.

из Команды генерации
строка sortImports(строка $stub)

Сортировать импорты в алфавитном порядке для данного шаблона.

из Команды генерации
строка getNameInput()

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

из Команды генерации
строка rootNamespace()

Получить корневое пространство имён для класса.

из Команды генерации
строка|null userProviderModel()

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

из Команды генерации
bool isReservedName(строка $name)

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

из Команды генерации
строка viewPath(строка $path = '')

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

из Команды генерации
строка resolveStubPath(строка $stub)

Получить полный путь к шаблону.

строка guessModelName(строка $name)

Определить имя модели по имени фабрики или вернуть имя модели по умолчанию.

Подробности

абстрактный защищенный Команда resolveCommand(Команда|строка $command)

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

Параметры

Команда|строка $command

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

Команда

целое число call(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

целое число callSilent(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

целое число callSilently(Команда|строка $command, массив $arguments = [])

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

Параметры

Команда|строка $command
массив $arguments

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

целое число

защищенный целое число runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

Команда|строка $command
массив $arguments
OutputInterface $output

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

целое число
END_OF_DOCUMENT_MARKER

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
END_OF_DOCUMENT_MARKER

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

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
END_OF_DOCUMENT_MARKER

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(Filesystem $files)

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

Parameters

Filesystem $files

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

protected string getStub()

Получить шаблонный файл для генератора.

Return Value

string

bool|null handle()

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

Return Value

bool|null

Exceptions

FileNotFoundException

protected string qualifyClass(string $name)

Обработать имя класса и отформатировать его в соответствии с корневым пространством имен.

Parameters

string $name

Return Value

string

protected string qualifyModel(string $model)

Определить данное базовое имя класса модели.

Parameters

string $model

Return Value

string

protected array<int,string> possibleModels()

Получить список возможных имен моделей.

Return Value

array<int,string>

protected array<int,string> possibleEvents()

Получить список возможных имен событий.

Return Value

array<int,string>

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string $rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

Определить, существует ли класс.

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

Получить путь к целевому классу.

Параметры

string $name

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

string

protected string makeDirectory(string $path)

Создать директорию для класса, если необходимо.

Параметры

string $path

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

string

protected string buildClass(string $name)

Создать класс с заданным именем.

Параметры

string $name

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

string

protected $this replaceNamespace(string $stub, string $name)

Заменить имя пространства имён для данного шаблона.

Параметры

string $stub
string $name

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

$this

protected string getNamespace(string $name)

Получить полное имя пространства имён для данного класса, без имени класса.

Параметры

string $name

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

string

protected string replaceClass(string $stub, string $name)

Заменить имя класса для данного шаблона.

Параметры

string $stub
string $name

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

string

protected string sortImports(string $stub)

Сортирует импорты по алфавиту для данного шаблона.

Параметры

string $stub

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

string

protected string getNameInput()

Получить желаемое имя класса из ввода.

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

string

protected string rootNamespace()

Получить корневое пространство имён для класса.

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

string

protected string|null userProviderModel()

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

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

string|null

protected bool isReservedName(string $name)

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

Параметры

string $name

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

bool

protected string viewPath(string $path = '')

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

Параметры

string $path

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

string

protected string resolveStubPath(string $stub)

Разрешить полностью квалифицированный путь к шаблону.

Параметры

string $stub

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

string

protected string guessModelName(string $name)

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

Параметры

string $name

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

string

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

Spec-Zone.ru

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