Spec-Zone.ru › Laravel 8

NotificationMakeCommand

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

Трейты

CreatesMatchingTest
CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

из InteractsWithIO
protected OutputStyle $output

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

из InteractsWithIO
protected int $verbosity

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

из InteractsWithIO
protected array $verbosityMap

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

из InteractsWithIO
static protected array $macros

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

из Macroable
protected Application $laravel

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

из Command
protected string $signature

Имя и синтаксис команды консоли.

из Command
protected string $name

Имя команды консоли.

protected string $description

Описание команды консоли.

protected string $help

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

из Command
protected bool $hidden

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

из Command
protected Filesystem $files

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

из GeneratorCommand
protected string $type

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

protected string[] $reservedNames

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

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

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

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

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

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

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

из Command
bool isHidden()

{@inheritdoc}

из Command
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 qualifyModel(string $model)

Добавить квалификатор к заданному имени базового класса модели.

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

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

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 = '')

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

from GeneratorCommand
void addTestOptions()

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

from CreatesMatchingTest
void handleTestCreation(string $path)

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

from CreatesMatchingTest
void writeMarkdownTemplate()

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

string resolveStubPath(string $stub)

Получить полностью квалифицированный путь к шаблону.

Details

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

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

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

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

Parameters

string|null $key

Return Value

string|array|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string $name

Return Value

bool

строка|массив|булево|null option(строка|null $key = null)

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

Параметры

строка|null $key

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

строка|массив|булево|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 = 'default', массив $columnStyles = [])

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

Параметры

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

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

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

смешанный тип|пустое значение withProgressBar(итерируемый объект|int $totalSteps, Closure $callback)

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

Параметры

итерируемый объект|int $totalSteps
Closure $callback

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

смешанный тип|пустое значение

пустое значение 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

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

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

пустое значение newLine(int $count = 1)

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

Параметры

int $count

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

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

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

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

Параметры

InputInterface $input

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

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

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

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

int

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden)

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

protected string qualifyModel(string $model)

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

Parameters

string $model

Return Value

string

protected string getDefaultNamespace(string $rootNamespace)

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

Parameters

string $rootNamespace

Return Value

string

protected bool alreadyExists(string $rawName)

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

Parameters

string $rawName

Return Value

bool

protected string getPath(string $name)

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

Parameters

string $name

Return Value

string

protected string makeDirectory(string $path)

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

Parameters

string $path

Return Value

string

protected string buildClass(string $name)

Создать класс с заданным именем.

Parameters

string $name

Return Value

string

protected $this replaceNamespace(string $stub, string $name)

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

Parameters

string $stub
string $name

Return Value

$this

protected string getNamespace(string $name)

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

Parameters

string $name

Return Value

string

protected string replaceClass(string $stub, string $name)

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

Parameters

string $stub
string $name

Return Value

string

protected string sortImports(string $stub)

Сортирует импорты в заданном шаблоне по алфавиту.

Parameters

string $stub

Return Value

string

protected string getNameInput()

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

Return Value

string

protected string rootNamespace()

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

Return Value

string

protected string|null userProviderModel()

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

Return Value

string|null

protected bool isReservedName(string $name)

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

Parameters

string $name

Return Value

bool

protected string viewPath(string $path = '')

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

Parameters

string $path

Return Value

string

protected void addTestOptions()

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

Return Value

void

protected void handleTestCreation(string $path)

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

Parameters

string $path

Return Value

void

protected void writeMarkdownTemplate()

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

Return Value

void

protected string resolveStubPath(string $stub)

Разобрать полностью квалифицированный путь к шаблону.

Parameters

string $stub

Return Value

string

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

Spec-Zone.ru

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