Spec-Zone.ru › Laravel 7

ChannelMakeCommand

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

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

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

 из GeneratorCommand

Методы

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

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

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

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

 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)

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

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

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

 из GeneratorCommand
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
логическое isReservedName(строка $name)

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

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

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

 из GeneratorCommand

Подробности

абстрактный защищённый Command resolveCommand(Command|строка $command)

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

Параметры

Command|строка $command

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

Command

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

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

Параметры

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

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

целое число

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

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

Параметры

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

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

целое число

защищённый целое число runCommand(Command|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

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

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

целое число

защищённый ArrayInput createInputFromArguments(массив $arguments)

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

Параметры

массив $arguments

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

ArrayInput

защищённый массив context()

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

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

массив

защищённый void specifyParameters()

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

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

void

защищённый массив getArguments()

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

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

массив

защищённый массив getOptions()

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

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

массив

логическое hasArgument(строка|целое число $name)

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

Параметры

строка|целое число $name

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

логическое

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

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

Параметры

строка|null $key

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

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

массив arguments()

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

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

массив

логическое hasOption(строка $name)

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

Параметры

строка $name

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

логическое

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

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

Параметры

строка|null $key

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

строка|массив|логическое|null

массив options()

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

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

массив

логическое confirm(строка $question, логическое $default = ложь)

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

Параметры

строка $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 = истина)

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

Параметры

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

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

смешанный тип

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

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

Параметры

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

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

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

void table(массив $headers, Arrayable|массив $rows, строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

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

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

void

void info(строка $string, int|строка|null $verbosity = null)

Вывести строку в качестве информационного сообщения.

Параметры

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

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

void

void line(строка $string, строка|null $style = null, int|строка|null $verbosity = null)

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

Параметры

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

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

void

void comment(строка $string, int|строка|null $verbosity = null)

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

Параметры

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

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

void

void question(строка $string, int|строка|null $verbosity = null)

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

Параметры

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

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

void

void error(строка $string, int|строка|null $verbosity = null)

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

Параметры

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

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

void

void warn(строка $string, int|строка|null $verbosity = null)

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

Параметры

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

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

void

void alert(строка $string)

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

Параметры

строка $string

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

void

void setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

void

void setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

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

void

protected void setVerbosity(строка|int $level)

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

Параметры

строка|int $level

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

void

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

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

Параметры

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

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

int

OutputStyle getOutput()

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

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

OutputStyle

static void macro(строка $name, объект|вызываемый $macro)

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

Параметры

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

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

void

static void mixin(объект $mixin, bool $replace = true)

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

Параметры

объект $mixin
bool $replace

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

void

Исключения

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

Исключения

FileNotFoundException

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

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

Spec-Zone.ru

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