Spec-Zone.ru › Laravel 9

ModelMakeCommand

class ModelMakeCommand extends GeneratorCommand (View source)

Свойства

CreatesMatchingTest
CallsCommands
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
protected bool $hidden

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

from Command
protected Filesystem $files

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

from GeneratorCommand
protected string $type

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

protected string[] $reservedNames

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

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

Вывести строку как сообщение об ошибке.

из InteractsWithIO
void warn(string $string, int|string|null $verbosity = null)

Вывести строку как предупреждение.

из InteractsWithIO
void alert(string $string, int|string|null $verbosity = null)

Вывести строку в окне оповещения.

из InteractsWithIO
$this newLine(int $count = 1)

Вывести пустую строку.

из InteractsWithIO
void setInput(InputInterface $input)

Установить реализацию интерфейса ввода.

из InteractsWithIO
void setOutput(OutputStyle $output)

Установить реализацию интерфейса вывода.

из InteractsWithIO
void setVerbosity(string|int $level)

Установить уровень подробности.

из InteractsWithIO
int parseVerbosity(string|int|null $level = null)

Получить уровень подробности в терминах уровня OutputInterface Symfony.

из InteractsWithIO
OutputStyle getOutput()

Получить реализацию вывода.

из InteractsWithIO
void trap(iterable<array-key,int>|int $signals, $callback)

Определить обратный вызов, который будет выполняться при возникновении заданного сигнала(ов).

из InteractsWithSignals
void untrap()

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

из InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

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

из PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

из PromptsForMissingInput
array promptForMissingArgumentsUsing()

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

из PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

bool didReceiveOptions(InputInterface $input)

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

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

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

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

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

из Macroable
static bool hasMacro(string $name)

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

из 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
bool isHidden()

{@inheritdoc}

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

{@inheritdoc}

из Command
Приложение getLaravel()

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

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

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

из Команды
string getStub()

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

bool|null handle()

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

string qualifyClass(string $name)

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

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

Указать полное имя заданной модели.

из Команды генерации
array<int,string> possibleModels()

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

из Команды генерации
array<int,string> possibleEvents()

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

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

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

bool alreadyExists(string $rawName)

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

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

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

из Команды генерации
string makeDirectory(string $path)

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

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

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

из Команды генерации
$this replaceNamespace(string $stub, string $name)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

из Команды генерации
void addTestOptions()

Добавить стандартные параметры команды для генерации соответствующих тестов.

из СоздаётСоответствующиеТесты
bool handleTestCreation(string $path)

Создать соответствующий тест-кейс, если запрошено.

из СоздаётСоответствующиеТесты
void createFactory()

Создать фабрику моделей для модели.

void createMigration()

Создать файл миграции для модели.

void createSeeder()

Создать файл сидера для модели.

void createController()

Создать контроллер для модели.

void createPolicy()

Создать файл политики для модели.

string resolveStubPath(string $stub)

Определить полный путь к шаблону.

Подробности

abstract protected Команда resolveCommand(Команда|string $command)

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

Параметры

Команда|string $command

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

Команда

int call(Команда|string $command, array $arguments = [])

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

Параметры

Команда|string $command
array $arguments

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

int

int callSilent(Команда|string $command, array $arguments = [])

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

Параметры

Команда|string $command
array $arguments

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

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void specifyParameters()

Указать аргументы и параметры команды.

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

Определить, присутствует ли данный аргумент.

Parameters

string|int $name

Return Value

bool

array|string|bool|null argument(string|null $key = null)

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

Parameters

string|null $key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

Определить, присутствует ли данный параметр.

Parameters

string $name

Return Value

bool

string|array|bool|null option(string|null $key = null)

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

Parameters

string|null $key

Return Value

string|array|bool|null

array options()

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

Return Value

array

bool confirm(string $question, bool $default = false)

Подтвердить вопрос у пользователя.

Parameters

string $question
bool $default

Return Value

bool

mixed ask(string $question, string|null $default = null)

Задать пользователю вопрос и получить ответ.

Parameters

string $question
string|null $default

Return Value

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

mixed secret(string $question, bool $fallback = true)

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

Parameters

string $question
bool $fallback

Return Value

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Parameters

string $question
array $choices
string|int|null $default
mixed|null $attempts
bool $multiple

Return Value

string|array

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

Форматирование ввода в текстовую таблицу.

Parameters

array $headers
Arrayable|array $rows
TableStyle|string $tableStyle
array $columnStyles

Return Value

void

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

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

Parameters

iterable|int $totalSteps
Closure $callback

Return Value

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

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

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

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

Параметры

Filesystem $files

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

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

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

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

string

bool|null handle()

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

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

bool|null

protected string qualifyClass(string $name)

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

Параметры

string $name

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

string

protected string qualifyModel(string $model)

Квалифицировать заданный базовый класс модели.

Параметры

string $model

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

string

protected array<int,string> possibleModels()

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

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

array<int,string>

protected array<int,string> possibleEvents()

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

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

array<int,string>

protected string getDefaultNamespace(string $rootNamespace)

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

Параметры

string $rootNamespace

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

string

protected bool alreadyExists(string $rawName)

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

Параметры

string $rawName

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

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

Исключения

FileNotFoundException

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

Добавить стандартные опции команды для генерации соответствующих тестов.

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

void

protected bool handleTestCreation(string $path)

Создать соответствующий тестовый случай, если запрошено.

Параметры

string $path

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

bool

protected void createFactory()

Создать фабрику моделей для модели.

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

void

protected void createMigration()

Создать файл миграции для модели.

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

void

protected void createSeeder()

Создать файл седера для модели.

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

void

protected void createController()

Создать контроллер для модели.

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

void

protected void createPolicy()

Создать файл политики для модели.

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

void

protected string resolveStubPath(string $stub)

Определить полный путь к шаблону.

Параметры

string $stub

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

string

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

Spec-Zone.ru

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