Spec-Zone.ru › Laravel 8

ObserverMakeCommand

class ObserverMakeCommand extends GeneratorCommand (View source)

Трейты

CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

from InteractsWithIO
protected OutputStyle $output

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

from InteractsWithIO
protected int $verbosity

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

from InteractsWithIO
protected array $verbosityMap

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

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

Методы

Command 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
array context()

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

из CallsCommands
void specifyParameters()

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

из HasParameters
array getArguments()

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

из HasParameters
array getOptions()

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

bool hasArgument(string|int $name)

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

из InteractsWithIO
string|array|null argument(string|null $key = null)

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

из InteractsWithIO
array arguments()

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

из InteractsWithIO
bool hasOption(string $name)

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

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

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

из InteractsWithIO
array 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|array 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()

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

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

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

из GeneratorCommand
string replaceClass(string $stub, string $name)

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

из GeneratorCommand
string sortImports(string $stub)

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

из GeneratorCommand
string getNameInput()

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

из GeneratorCommand
string rootNamespace()

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

из GeneratorCommand
string|null userProviderModel()

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

из GeneratorCommand
bool isReservedName(string $name)

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

из GeneratorCommand
string viewPath(string $path = '')

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

из GeneratorCommand
string replaceModel(string $stub, string $model)

Заменить модель в данном шаблоне.

string parseModel(string $model)

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

string resolveStubPath(string $stub)

Определить полный путь к шаблону.

Подробности

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

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

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

Parameters

string|null $key

Return Value

string|array|bool|null

array options()

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

Return Value

array

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

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

Parameters

string $question
bool $default

Return Value

bool

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

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

Parameters

string $question
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
array|callable $choices
string|null $default

Return Value

mixed

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

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

Parameters

string $question
bool $fallback

Return Value

mixed

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

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

Return Value

void

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)

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

Parameters

string $string

Return Value

void

void newLine(int $count = 1)

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

Parameters

int $count

Return Value

void

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.

Параметры

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

Исключения

FileNotFoundException

protected string qualifyClass(string $name)

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

Параметры

string $name

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

string

protected string qualifyModel(string $model)

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

Параметры

string $model

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

string

protected string getDefaultNamespace(string $rootNamespace)

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

Параметры

string $rootNamespace

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

string
END_OF_DOCUMENT_MARKER

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 string replaceModel(string $stub, string $model)

Заменить модель для данного шаблона.

Parameters

string $stub
string $model

Return Value

string

protected string parseModel(string $model)

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

Parameters

string $model

Return Value

string

Exceptions

InvalidArgumentException

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

Spec-Zone.ru

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