NotificationMakeCommand

class NotificationMakeCommand extends GeneratorCommand (View source)

Свойства

CreatesMatchingTest

CallsCommands

Свойства

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

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\|array	choice(string $question, array $choices, string\|int\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Предложить пользователю один вариант из списка ответов.	from InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, TableStyle\|string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу.	from InteractsWithIO
mixed\|void	withProgressBar(iterable\|int $totalSteps, Closure $callback) Выполнить заданный обратный вызов, продвигая полосу прогресса.	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, 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) Получить уровень подробности в терминах уровня Symfony's OutputInterface.	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

Команда	setHidden(bool $hidden = true) {@inheritdoc}	из Команды
Приложение	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) Заменить имя класса для данного шаблона.	из GeneratorCommand
string	sortImports(string $stub) Сортирует импорты для данного шаблона в алфавитном порядке.	из GeneratorCommand
string	getNameInput() Получить желаемое имя класса из ввода.	из GeneratorCommand
string	rootNamespace() Получить корневой namespace для класса.	из GeneratorCommand
string\|null	userProviderModel() Получить модель для поставщика пользователей по умолчанию.	из GeneratorCommand
bool	isReservedName(string $name) Проверяет, является ли данное имя зарезервированным.	из GeneratorCommand
string	viewPath(string $path = '') Получить путь к первому каталогу представлений из конфигурации приложения.	из GeneratorCommand
void	addTestOptions() Добавить стандартные параметры команды для генерации соответствующих тестов.	из CreatesMatchingTest
bool	handleTestCreation(string $path) Создать соответствующий тест-кейс, если запрошено.	из CreatesMatchingTest
void	writeMarkdownTemplate() Записать шаблон Markdown для mailable.
string	resolveStubPath(string $stub) Определить полностью квалифицированный путь к шаблону.

Подробности

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

int callSilently(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

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

массив options()

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

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

массив

логическое значение confirm(строка $question, логическое значение $default = false)

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

Параметры

строка	$question
логическое значение	$default

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

логическое значение

смешанное значение 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, логическое значение $fallback = true)

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

Параметры

строка	$question
логическое значение	$fallback

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

смешанное значение

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

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

Параметры

строка	$question
массив	$choices
строка\|целое число\|null	$default
смешанное значение\|null	$attempts
логическое значение	$multiple

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

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

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

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

Параметры

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

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

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

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)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

Parameters

string	$string
string\|null	$style
int\|string\|null	$verbosity

Return Value

void

void comment(string $string, int|string|null $verbosity = null)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void question(string $string, int|string|null $verbosity = null)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

void error(string $string, int|string|null $verbosity = null)

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

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

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

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

Вывести строку в всплывающем окне.

Parameters

string	$string
int\|string\|null	$verbosity

Return Value

void

$this newLine(int $count = 1)

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

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle

$output

Return Value

void

protected void setVerbosity(string|int $level)

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

Parameters

string|int

$level

Return Value

void

protected int parseVerbosity(string|int|null $level = null)

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

Parameters

string|int|null

$level

Return Value

int

OutputStyle getOutput()

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

Return Value

OutputStyle

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

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

Parameters

iterable<array-key,int>\|int	$signals
	$callback

Return Value

void

void untrap()

internal

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

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected array promptForMissingArgumentsUsing()

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

Return Value

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Является ли входной параметр содержащим параметры, отличающиеся от значений по умолчанию?

Parameters

InputInterface

$input

Return Value

bool

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

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)

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

Параметры

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

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

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

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

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/NotificationMakeCommand.html