Spec-Zone.ru › Laravel 10

TestMakeCommand

class TestMakeCommand extends GeneratorCommand (View source)

Свойства

CallsCommands
ConfiguresPrompts
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

Конструктор фабрики консольных компонентов.

from InteractsWithIO
protected InputInterface $input

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

from InteractsWithIO
protected OutputStyle $output

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

from InteractsWithIO
protected int $verbosity

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

from InteractsWithIO
protected array $verbosityMap

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

from InteractsWithIO
protected Signals|null $signals

Экземпляр регистратора сигналов.

from InteractsWithSignals
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 bool $isolated

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

from Command
protected int $isolatedExitCode

Значение кода завершения по умолчанию для изолированных команд.

from Command
protected array $aliases

Псевдонимы имени консольной команды.

from Command
protected Filesystem $files

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

from GeneratorCommand
protected string $type

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

protected string[] $reservedNames

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

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

Настроить отступы подсказок.

из ConfiguresPrompts
mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

из ConfiguresPrompts
void restorePrompts()

Восстановить вывод подсказок.

из ConfiguresPrompts
void specifyParameters()

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

из HasParameters
массив getArguments()

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

из HasParameters
массив getOptions()

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

bool hasArgument(string|int $name)

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

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

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

из InteractsWithIO
массив arguments()

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

из InteractsWithIO
bool hasOption(string $name)

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

из InteractsWithIO
строка|массив|bool|null option(string|null $key = null)

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

из InteractsWithIO
массив options()

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

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
строка|массив choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

из InteractsWithIO
void table(array $headers, Arrayable|array $rows, TableStyle|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, int|string|null $verbosity = null)

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

из InteractsWithIO
$this 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)

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

из InteractsWithIO
OutputStyle getOutput()

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

из InteractsWithIO
Factory outputComponents()

Получить реализацию фабрики компонентов вывода.

из InteractsWithIO
trap($signals, $callback)

Без описания

из InteractsWithSignals
void untrap()

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

из InteractsWithSignals
void interact(InputInterface $input, OutputInterface $output)

Взаимодействие с пользователем перед проверкой ввода.

из PromptsForMissingInput
void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запросить у пользователя отсутствующие аргументы.

из PromptsForMissingInput
array promptForMissingArgumentsUsing()

Запрос отсутствующих аргументов ввода, используя возвращенные вопросы.

из PromptsForMissingInput
void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Дополнительное взаимодействие с пользователем, если были запрошены отсутствующие аргументы.

bool didReceiveOptions(InputInterface $input)

Содержит ли ввод какие-либо параметры, отличающиеся от значений по умолчанию.

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

Настроить команду консоли для изоляции.

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

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

из команды
int execute(InputInterface $input, OutputInterface $output)

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

из команды
CommandMutex commandIsolationMutex()

Получить экземпляр мьютекса изоляции команд для команды.

из команды
bool isHidden()

{@inheritdoc}

из команды
Команда setHidden(bool $hidden = true)

{@inheritdoc}

из команды
Приложение getLaravel()

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

из команды
void setLaravel(Контейнер $laravel)

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

из команды
string getStub()

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

bool|null handle()

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

из Генератора команд
string qualifyClass(string $name)

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

из Генератора команд
string qualifyModel(string $model)

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

из Генератора команд
array<int,string> possibleModels()

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

из Генератора команд
array<int,string> possibleEvents()

Получить список возможных имён событий.

из Генератора команд
string getDefaultNamespace(string $rootNamespace)

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

bool alreadyExists(string $rawName)

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

из Генератора команд
string getPath(string $name)

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

string makeDirectory(string $path)

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

из Генератора команд
string buildClass(string $name)

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

из Генератора команд
$this replaceNamespace(string $stub, string $name)

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

из Генератора команд
string getNamespace(string $name)

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

из Генератора команд
string replaceClass(string $stub, string $name)

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

из Генератора команд
string sortImports(string $stub)

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

из Генератора команд
string getNameInput()

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

из Генератора команд
string rootNamespace()

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

string|null userProviderModel()

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

из Генератора команд
bool isReservedName(string $name)

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

из Генератора команд
string viewPath(string $path = '')

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

из Генератора команд
string resolveStubPath(string $stub)

Определить полное квалифицированное имя пути к шаблону.

Подробности

abstract protected Команда resolveCommand(Command|string $command)

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

Параметры

Команда|строка $command

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

Команда

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

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

Параметры

Команда|строка $command
массив $arguments

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

int

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

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

Параметры

Команда|строка $command
массив $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

protected int runCommand(Command|string $command, array $arguments, OutputInterface $output)

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

Параметры

Command|string $command
array $arguments
OutputInterface $output

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

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

array $arguments

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

ArrayInput

protected array context()

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

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

array

protected void configurePrompts(InputInterface $input)

Настроить отступы подсказок.

Параметры

InputInterface $input

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

void

protected mixed promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

Подсказывать пользователю до тех пор, пока не будет пройдена проверка.

Параметры

Closure $prompt
bool|string $required
Closure|null $validate

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

mixed

protected void restorePrompts()

Восстановить вывод подсказок.

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

void

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

array

protected array getOptions()

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

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

array

bool hasArgument(string|int $name)

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

Параметры

string|int $name

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

bool

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

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

Параметры

string|null $key

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

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

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

Parameters

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

Return Value

string|array

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

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

Parameters

array $headers
Arrayable|array $rows
TableStyle|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, int|string|null $verbosity = null)

Запись строки в информационное окно.

Parameters

string $string
int|string|null $verbosity

Return Value

void

$this newLine(int $count = 1)

Запись пустой строки.

Parameters

int $count

Return Value

$this

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.

Parameters

string|int|null $level

Return Value

int

OutputStyle getOutput()

Получение реализации вывода.

Return Value

OutputStyle

Factory outputComponents()

Получение реализации фабрики компонентов вывода.

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

$signals
$callback

void untrap()

internal

Отключение обработчиков сигналов, установленных в обработчике команды.

Return Value

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействие с пользователем перед валидацией входных данных.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

Запрос у пользователя отсутствующих аргументов.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected array promptForMissingArgumentsUsing()

Запрос отсутствующих входных аргументов, используя возвращённые вопросы.

Return Value

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

Дальнейшее взаимодействие с пользователем, если были запрошены отсутствующие аргументы.

Parameters

InputInterface $input
OutputInterface $output

Return Value

void

protected bool didReceiveOptions(InputInterface $input)

Содержит ли входные данные параметры, отличные от значений по умолчанию.

Parameters

InputInterface $input

Return Value

bool

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

protected void configureIsolation()

Настройка команды консоли для изоляции.

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

protected CommandMutex commandIsolationMutex()

Получение экземпляра мьютекса изоляции команды для команды.

Return Value

CommandMutex

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool $hidden

Return Value

Command

Application getLaravel()

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

Return Value

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 array<int,string> possibleModels()

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

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

array<int,string>

protected array<int,string> possibleEvents()

Получить список возможных имён событий.

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

array<int,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

protected bool isReservedName(string $name)

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

Параметры

string $name

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

bool

protected string viewPath(string $path = '')

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

Параметры

string $path

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

string

protected string resolveStubPath(string $stub)

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

Параметры

string $stub

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

string

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

Spec-Zone.ru

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