MailMakeCommand
class MailMakeCommand extends GeneratorCommand (View source)
Свойства
| CreatesMatchingTest | |
| 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 | Сопоставление уровней подробности, читаемых человеком, с уровнями OutputInterface Symfony. | 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 |
| смешанный | 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 |
| смешанный | 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)
Предложите пользователю выбрать один вариант из массива ответов. | из 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 |
| Factory | outputComponents()
Получить реализацию фабрики компонентов вывода. | из InteractsWithIO |
| trap($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)
Динамически обрабатывает вызовы к классу. | 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 |
| void | fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой. | from Command |
| bool | isHidden() {@inheritdoc} | from Command |
| Command | setHidden(bool $hidden = true) {@inheritdoc} | from Command |
| Application | getLaravel()
Получить экземпляр приложения Laravel. | from Command |
| void | setLaravel(Container $laravel)
Установить экземпляр приложения Laravel. | from Command |
| string | getStub()
Получить шаблонный файл для генератора. | |
| bool|null | handle()
Выполнить команду консоли. | |
| string | qualifyClass(string $name)
Обработать имя класса и отформатировать его в соответствии с корневым именем пространства имён. | from GeneratorCommand |
| string | qualifyModel(string $model)
Определить заданный базовый класс модели. | from GeneratorCommand |
| array<int,string> | possibleModels()
Получить список возможных имён моделей. | from GeneratorCommand |
| array<int,string> | possibleEvents()
Получить список возможных имён событий. | from GeneratorCommand |
| string | getDefaultNamespace(string $rootNamespace)
Получить имя пространства имён по умолчанию для класса. | |
| bool | alreadyExists(string $rawName)
Определить, существует ли класс. | from GeneratorCommand |
| string | getPath(string $name)
Получить путь к классу назначения. | from GeneratorCommand |
| string | makeDirectory(string $path)
Создать директорию для класса, если необходимо. | from GeneratorCommand |
| string | buildClass(string $name)
Создать класс с заданным именем. | |
| $this | replaceNamespace(string $stub, string $name)
Заменить имя пространства имён в данном шаблоне. | from GeneratorCommand |
| string | getNamespace(string $name)
Получить полное имя пространства имён для заданного класса без имени класса. | from GeneratorCommand |
| string | replaceClass(string $stub, string $name)
Заменить имя класса в данном шаблоне. | from GeneratorCommand |
| string | sortImports(string $stub)
Сортирует импорты в алфавитном порядке для данного шаблона. | from GeneratorCommand |
| string | getNameInput()
Получить желаемое имя класса из ввода. | from GeneratorCommand |
| string | rootNamespace()
Получить корневое имя пространства имён для класса. | from GeneratorCommand |
| string|null | userProviderModel()
Получить модель для поставщика пользователей по умолчанию. | from GeneratorCommand |
| bool | isReservedName(string $name)
Проверяет, является ли данное имя зарезервированным. | from GeneratorCommand |
| string | viewPath(string $path = '')
Получить путь к первому каталогу представлений из конфигурации приложения. | из GeneratorCommand |
| void | addTestOptions()
Добавить стандартные параметры команды для генерации соответствующих тестов. | из CreatesMatchingTest |
| bool | handleTestCreation(string $path)
Создать соответствующий тестовый случай, если это запрошено. | из CreatesMatchingTest |
| void | writeMarkdownTemplate()
Записать шаблон Markdown для mailable. | |
| void | writeView()
Записать шаблон Blade для mailable. | |
| string | getView()
Получить имя представления. | |
| string | resolveStubPath(string $stub)
Определить полный путь к шаблону. |
Подробности
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)
Динамически обрабатывать вызовы к классу.
смешанный __call(string $method, array $parameters)
Динамически обрабатывает вызовы к классу.
пустое __construct(Filesystem $files)
Создаёт новый экземпляр команды генератора.
защищённый пустое configureUsingFluentDefinition()
Настройка команды консоли с помощью определения в стиле fluent.
защищённый пустое configureIsolation()
Настройка команды консоли для изоляции.
целое число run(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
защищённый целое число execute(InputInterface $input, OutputInterface $output)
Выполнить команду консоли.
защищённый CommandMutex commandIsolationMutex()
Получить экземпляр мьютекса изоляции команды для команды.
пустое fail(Throwable|string|null $exception = null)
Принудительно завершить команду с ошибкой.
булево isHidden()
{@inheritdoc}
Command setHidden(bool $hidden = true)
{@inheritdoc}
Application getLaravel()
Получить экземпляр приложения Laravel.
пустое setLaravel(Container $laravel)
Установить экземпляр приложения Laravel.
защищённый строка getStub()
Получить шаблонный файл для генератора.
булево|null handle()
Выполнить команду консоли.
защищённый строка qualifyClass(string $name)
Разбор имени класса и форматирование согласно корневому пространству имён.
защищённый строка qualifyModel(string $model)
Уточнить заданный базовый класс модели.
защищённый массив<int,строка> possibleModels()
Получить список возможных имён моделей.
защищённый массив<int,строка> possibleEvents()
Получить список возможных имён событий.
защищённый строка getDefaultNamespace(string $rootNamespace)
Получить стандартное пространство имён для класса.
защищённый булево alreadyExists(string $rawName)
Определить, существует ли класс.
защищённый строка getPath(string $name)
Получить путь к классу назначения.
защищённый строка 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 void addTestOptions()
Добавить стандартные параметры команды для генерации соответствующих тестов.
protected bool handleTestCreation(string $path)
Создать соответствующий тест-кейс, если запрошено.
protected void writeMarkdownTemplate()
Записать шаблон Markdown для mailable.
protected void writeView()
Записать шаблон Blade для mailable.
protected string getView()
Получить имя представления.
protected string resolveStubPath(string $stub)
Разрешить полное квалифицированное имя пути к шаблону.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/11.x/Illuminate/Foundation/Console/MailMakeCommand.html
