Spec-Zone.ru › Laravel 6

ConsoleMakeCommand

class ConsoleMakeCommand extends 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|null $help

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

из Command
protected bool $hidden

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

из Command
protected Filesystem $files

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

из GeneratorCommand
protected string $type

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

Методы

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

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

array getOptions()

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

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

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

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)

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

from InteractsWithIO
void setOutput(OutputStyle $output)

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

from InteractsWithIO
void setVerbosity(string|int $level)

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

from InteractsWithIO
int parseVerbosity(string|int|null $level = null)

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

from InteractsWithIO
OutputStyle getOutput()

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

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

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

from Command
mixed execute(InputInterface $input, OutputInterface $output)

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

from Command
isHidden()

{@inheritdoc}

from Command
setHidden($hidden)

{@inheritdoc}

from Command
Application getLaravel()

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

from Command
void setLaravel(Container $laravel)

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

from Command
string getStub()

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

bool|null handle()

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

from GeneratorCommand
string qualifyClass(string $name)

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

from GeneratorCommand
string getDefaultNamespace(string $rootNamespace)

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

bool alreadyExists(string $rawName)

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

from GeneratorCommand
string getPath(string $name)

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

from GeneratorCommand
string makeDirectory(string $path)

Создать каталог для класса, если необходимо.

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

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

string sortImports(string $stub)

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

from GeneratorCommand
string getNameInput()

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

from GeneratorCommand
string rootNamespace()

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

from GeneratorCommand
string|null userProviderModel()

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

from GeneratorCommand

Подробности

абстрактный защищенный 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 runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

защищенный ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

защищенный array context()

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

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

array

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

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

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

void

защищенный array getArguments()

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

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

array

защищенный array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

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

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

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

Параметры

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

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

string

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

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

Параметры

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

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

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 setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

void

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

protected void configureUsingFluentDefinition()

Настроить команду консоли с помощью определения fluent.

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface $input
OutputInterface $output

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

int

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

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

Параметры

InputInterface $input
OutputInterface $output

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

mixed

isHidden()

{@inheritdoc}

setHidden($hidden)

{@inheritdoc}

Параметры

$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

Исключения

FileNotFoundException

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

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

Spec-Zone.ru

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