Spec-Zone.ru › Laravel 8

CastMakeCommand

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

Особенности

CallsCommands
HasParameters
InteractsWithIO
Macroable

Свойства

protected InputInterface $input

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

 из InteractsWithIO
protected OutputStyle $output

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

 из InteractsWithIO
protected int $verbosity

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

 из InteractsWithIO
protected array $verbosityMap

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

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

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

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

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

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

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

 from GeneratorCommand
$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()

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

 from GeneratorCommand
bool isReservedName(string $name)

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

 from GeneratorCommand
string viewPath(string $path = '')

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

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

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

Значение возвращаемого значения

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

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

Параметры

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

Значение возвращаемого значения

string|array

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

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

Параметры

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

Значение возвращаемого значения

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Параметры

iterable|int $totalSteps
Closure $callback

Значение возвращаемого значения

mixed|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 newLine(int $count = 1)

Вставить пустую строку.

Параметры

int $count

Значение возвращаемого значения

void

void setInput(InputInterface $input)

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

Параметры

InputInterface $input

Значение возвращаемого значения

void

void setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

Значение возвращаемого значения

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

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

int run(InputInterface $input, OutputInterface $output)

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

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

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

Parameters

InputInterface $input
OutputInterface $output

Return Value

int

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

Application getLaravel()

Получить экземпляр приложения Laravel.

Return Value

Application

void setLaravel(Container $laravel)

Установить экземпляр приложения Laravel.

Parameters

Container $laravel

Return Value

void

protected string getStub()

Получить файл шаблона для генератора.

Return Value

string

bool|null handle()

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

Return Value

bool|null

Exceptions

FileNotFoundException

protected string qualifyClass(string $name)

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

Parameters

string $name

Return Value

string

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

Exceptions

FileNotFoundException

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

Spec-Zone.ru

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