Spec-Zone.ru › Laravel 7

MailMakeCommand

класс MailMakeCommand расширяет GeneratorCommand (View source)

Трейты

CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

 из InteractsWithIO
protected OutputStyle $output

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

 из InteractsWithIO
protected int $verbosity

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

 из InteractsWithIO
protected array $verbosityMap

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

 из InteractsWithIO
static protected array $macros

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

 из Macroable
protected Application $laravel

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

 из Command
protected string $signature

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

 из Command
protected string $name

Имя консольной команды.
protected string $description

Описание консольной команды.
protected string|null $help

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

 из Command
protected bool $hidden

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

 из Command
protected Filesystem $files

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

 из GeneratorCommand
protected string $type

Тип генерируемого класса.
protected array $reservedNames

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

 из GeneratorCommand

Методы

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

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

 из CallsCommands
int call(Command|string $command, array $arguments = [])

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

 из CallsCommands
int callSilent(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
string|массив|null argument(string|null $key = null)

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

 из InteractsWithIO
массив arguments()

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

 из InteractsWithIO
bool hasOption(string $name)

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

 из InteractsWithIO
string|массив|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|массив choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

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

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

 из 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)

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

 из 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
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 mixed __callStatic(string $method, array $parameters)

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

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

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

 из Macroable
void __construct(Filesystem $files)

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

 из GeneratorCommand
void configureUsingFluentDefinition()

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

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

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

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

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

 из Command
isHidden()

{@inheritdoc}

 из Command
setHidden(bool $hidden)

{@inheritdoc}

 из Command
Application getLaravel()

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

 из Command
void setLaravel(Container $laravel)

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

 из Command
string getStub()

Получить шаблонный файл для генератора.
bool|null handle()

Выполнить команду консоли.
string qualifyClass(string $name)

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

 из GeneratorCommand
string getDefaultNamespace(string $rootNamespace)

Получить стандартное пространство имен для класса.
bool alreadyExists(string $rawName)

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

 из GeneratorCommand
string getPath(string $name)

Получить путь к классу назначения.

 из GeneratorCommand
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
строка|null userProviderModel()

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

 из GeneratorCommand
bool isReservedName(строка $name)

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

 из GeneratorCommand
строка viewPath(строка $path = '')

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

 из GeneratorCommand
void writeMarkdownTemplate()

Записать шаблон Markdown для mailable.

Подробности

abstract protected Command resolveCommand(Command|строка $command)

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

Параметры

Command|строка $command

Значение результата

Command

int call(Command|строка $command, массив $arguments = [])

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

Параметры

Command|строка $command
массив $arguments

Значение результата

int

int callSilent(Command|строка $command, массив $arguments = [])

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

Параметры

Command|строка $command
массив $arguments

Значение результата

int

protected int runCommand(Command|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

Command|строка $command
массив $arguments
OutputInterface $output

Значение результата

int

protected ArrayInput createInputFromArguments(массив $arguments)

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

Параметры

массив $arguments

Значение результата

ArrayInput

protected массив context()

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

Значение результата

массив

protected void specifyParameters()

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

Значение результата

void

protected массив getArguments()

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

Значение результата

массив

protected массив getOptions()

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

Значение результата

массив

bool hasArgument(строка|int $name)

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

Параметры

строка|int $name

Значение результата

bool

строка|массив|null argument(строка|null $key = null)

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

Параметры

строка|null $key

Значение результата

строка|массив|null

массив arguments()

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

Значение результата

массив

bool hasOption(строка $name)

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

Параметры

строка $name

Значение результата

bool

строка|массив|bool|null option(строка|null $key = null)

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

Параметры

строка|null $key

Значение результата

строка|массив|bool|null

массив options()

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

Значение результата

массив

bool confirm(строка $question, bool $default = false)

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

Параметры

строка $question
bool $default

Значение результата

bool

смешанное ask(строка $question, строка|null $default = null)

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

Параметры

строка $question
строка|null $default

Значение результата

смешанное

смешанное anticipate(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

Значение результата

смешанное

смешанное askWithCompletion(строка $question, массив|вызываемый $choices, строка|null $default = null)

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

Параметры

строка $question
массив|вызываемый $choices
строка|null $default

Значение результата

смешанное

смешанное secret(строка $question, bool $fallback = true)

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

Параметры

строка $question
bool $fallback

Значение результата

смешанное

строка|массив choice(строка $question, массив $choices, строка|null $default = null, смешанное|null $attempts = null, bool $multiple = false)

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

Параметры

строка $question
массив $choices
строка|null $default
смешанное|null $attempts
bool $multiple

Значение возврата

строка|массив

пустое значение table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

массив $headers
Arrayable|массив $rows
строка $tableStyle
массив $columnStyles

Значение возврата

пустое значение

пустое значение info(строка $string, int|строка|null $verbosity = null)

Выводит строку в качестве информации.

Параметры

строка $string
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение line(строка $string, строка|null $style = null, int|строка|null $verbosity = null)

Выводит строку в стандартный вывод.

Параметры

строка $string
строка|null $style
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение comment(строка $string, int|строка|null $verbosity = null)

Выводит строку как комментарий.

Параметры

строка $string
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение question(строка $string, int|строка|null $verbosity = null)

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

Параметры

строка $string
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение error(строка $string, int|строка|null $verbosity = null)

Выводит строку в качестве ошибки.

Параметры

строка $string
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение warn(строка $string, int|строка|null $verbosity = null)

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

Параметры

строка $string
int|строка|null $verbosity

Значение возврата

пустое значение

пустое значение alert(строка $string)

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

Параметры

строка $string

Значение возврата

пустое значение

пустое значение setInput(InputInterface $input)

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

Параметры

InputInterface $input

Значение возврата

пустое значение

пустое значение setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

Значение возврата

пустое значение

protected пустое значение setVerbosity(строка|int $level)

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

Параметры

строка|int $level

Значение возврата

пустое значение

protected int parseVerbosity(строка|int|null $level = null)

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

Параметры

строка|int|null $level

Значение возврата

int

OutputStyle getOutput()

Получение реализации вывода.

Значение возврата

OutputStyle

static пустое значение macro(строка $name, объект|вызываемый $macro)

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

Параметры

строка $name
объект|вызываемый $macro

Значение возврата

пустое значение

static пустое значение mixin(объект $mixin, bool $replace = true)

Добавление другого объекта в класс.

Параметры

объект $mixin
bool $replace

Значение возврата

пустое значение

Исключения

ReflectionException

static bool hasMacro(строка $name)

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

Параметры

строка $name

Значение возврата

bool

static смешанное __callStatic(строка $method, массив $parameters)

Динамическое обращение к классу.

Параметры

строка $method
массив $parameters

Значение возврата

смешанное

Исключения

BadMethodCallException

смешанное __call(строка $method, массив $parameters)

Динамическое обращение к классу.

Параметры

строка $method
массив $parameters

Значение возврата

смешанное

Исключения

BadMethodCallException

void __construct(Filesystem $files)

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

Параметры

Filesystem $files

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

void

protected void configureUsingFluentDefinition()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

protected int execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

isHidden()

{@inheritdoc}

setHidden(bool $hidden)

{@inheritdoc}

Параметры

bool $hidden

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

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

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

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

void

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

Spec-Zone.ru

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