Spec-Zone.ru › Laravel 6

MailMakeCommand

class MailMakeCommand extends 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

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

Методы

Command resolveCommand(Command|string $command)

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

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

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

from CallsCommands
int callSilent(Command|string $command, array $arguments = [])

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

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

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

from CallsCommands
ArrayInput createInputFromArguments(array $arguments)

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

from CallsCommands
array context()

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

from CallsCommands
void specifyParameters()

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

from HasParameters
array getArguments()

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

from HasParameters
array getOptions()

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

bool hasArgument(string|int $name)

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

from InteractsWithIO
string|array|null argument(string|null $key = null)

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

from InteractsWithIO
array arguments()

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

from InteractsWithIO
bool hasOption(string $name)

Определить, присутствует ли данная опция.

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

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

from InteractsWithIO
array options()

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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)

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

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
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 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
int run(InputInterface $input, OutputInterface $output)

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

from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

from Command
isHidden()

{@inheritdoc}

from Command
setHidden($hidden)

{@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 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()

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

из GeneratorCommand
void writeMarkdownTemplate()

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

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string $command

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

Command

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

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

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

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

Параметры

string|null $key

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

string|array|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 choice(string $question, array $choices, string|null $default = null, mixed|null $attempts = null, bool|null $multiple = null)

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

Параметры

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

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

string
END_OF_DOCUMENT_MARKER

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

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

Параметры

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

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

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)

Вывести строку в окне уведомления.

Параметры

string $string

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

void

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

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

protected void configureUsingFluentDefinition()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

mixed

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

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

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

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

void

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

Spec-Zone.ru

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