PolicyMakeCommand

class PolicyMakeCommand extends GeneratorCommand (View source)

Свойства

CallsCommands

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 Filesystem	$files	Экземпляр файловой системы.	from GeneratorCommand
protected string	$type	Тип генерируемого класса.
protected string[]	$reservedNames	Зарезервированные имена, которые нельзя использовать для генерации.	from GeneratorCommand
static protected string\|null deprecated	$defaultName	Имя команды консоли.

Методы

Команда	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() Получить аргументы консольной команды.
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() Получить все опции, переданные команде.	из 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
строка\|массив	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) Вывести строку как предупреждение.	from InteractsWithIO
void	alert(string $string, int\|string\|null $verbosity = null) Вывести строку в окне оповещения.	from InteractsWithIO
$this	newLine(int $count = 1) Вывести пустую строку.	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
void	trap(iterable<array-key,int>\|int $signals, $callback) Определить обратный вызов для выполнения при возникновении заданного(ых) сигнала(ов).	from InteractsWithSignals
void	untrap() Отменить обработчики сигналов, установленные в обработчике команды.	from InteractsWithSignals
void	interact(InputInterface $input, OutputInterface $output) Взаимодействовать с пользователем до валидации ввода.	from PromptsForMissingInput
void	promptForMissingArguments(InputInterface $input, OutputInterface $output) Запросить у пользователя отсутствующие аргументы.	from PromptsForMissingInput
array	promptForMissingArgumentsUsing() Запросить отсутствующие аргументы ввода, используя возвращенные вопросы.	from PromptsForMissingInput
void	afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output) Дальнейшее взаимодействие с пользователем, если его попросили ввести отсутствующие аргументы.
bool	didReceiveOptions(InputInterface $input) Содержит ли вход какие-либо параметры, отличающиеся от значений по умолчанию.	from PromptsForMissingInput
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 void	flushMacros() Очистить существующие макросы.	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() Настроить команду консоли с помощью определения с плавным изменением.	from Command
void	configureIsolation() Настроить команду консоли для изоляции.	from Command
int	run(InputInterface $input, OutputInterface $output) Запустить команду консоли.	from Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить команду консоли.	from Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	from Command
bool	isHidden() {@inheritdoc}	from Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	from Command

Приложение	getLaravel() Получить экземпляр приложения Laravel.	из Команды
void	setLaravel(Контейнер $laravel) Установить экземпляр приложения Laravel.	из Команды
строка	getStub() Получить шаблонный файл для генератора.
bool\|null	handle() Выполнить консольную команду.	из Генератора команд
строка	qualifyClass(строка $name) Обработать имя класса и отформатировать его в соответствии с корневым пространством имён.	из Генератора команд
строка	qualifyModel(строка $model) Отформатировать заданный базовый класс модели.	из Генератора команд
массив<int,строка>	possibleModels() Получить список возможных имён моделей.	из Генератора команд
массив<int,строка>	possibleEvents() Получить список возможных имён событий.	из Генератора команд
строка	getDefaultNamespace(строка $rootNamespace) Получить стандартное пространство имён для класса.
bool	alreadyExists(строка $rawName) Определить, существует ли класс.	из Генератора команд
строка	getPath(строка $name) Получить путь к классу назначения.	из Генератора команд
строка	makeDirectory(строка $path) Создать директорию для класса, если необходимо.	из Генератора команд
строка	buildClass(строка $name) Сгенерировать класс с заданным именем.
$this	replaceNamespace(строка $stub, строка $name) Заменить пространство имён в заданном шаблоне.	из Генератора команд
строка	getNamespace(строка $name) Получить полное пространство имён для заданного класса без имени класса.	из Генератора команд
строка	replaceClass(строка $stub, строка $name) Заменить имя класса в заданном шаблоне.	из Генератора команд
строка	sortImports(строка $stub) Сортирует импорты в алфавитном порядке для данного шаблона.	из Генератора команд
строка	getNameInput() Получить желаемое имя класса из ввода.	из Генератора команд
строка	rootNamespace() Получить корневое пространство имён для класса.	из Генератора команд
строка\|null	userProviderModel() Получить модель для поставщика пользователей охранника.
bool	isReservedName(строка $name) Проверяет, является ли данное имя зарезервированным.	из Генератора команд
строка	viewPath(строка $path = '') Получить первый путь к каталогу представлений из конфигурации приложения.	из Генератора команд
строка	replaceUserNamespace(строка $stub) Заменить пространство имён модели User.
строка	replaceModel(строка $stub, строка $model) Заменить модель в заданном шаблоне.
строка	resolveStubPath(строка $stub) Определить полностью квалифицированный путь к шаблону.

Подробности

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

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

Параметры

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

$command

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

Команда

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

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

Параметры

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

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

целое число

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

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

Параметры

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

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

целое число

целое число callSilently(Команда|строка $command, массив $arguments = [])

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

Параметры

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

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

целое число

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

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

Параметры

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

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

целое число

protected ArrayInput createInputFromArguments(array $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

protected array context()

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

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

массив

protected void specifyParameters()

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

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

void

protected array getArguments()

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

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

массив

protected array getOptions()

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

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

массив

bool hasArgument(string|int $name)

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

Параметры

string|int

$name

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

bool

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

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

Параметры

string|null

$key

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

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

array arguments()

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

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

массив

bool hasOption(string $name)

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

Параметры

строка

$name

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

bool

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

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

Параметры

строка|null

$key

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

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

array options()

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

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

массив

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

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

Параметры

строка	$question
bool	$default

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

bool

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

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

Параметры

строка	$question
строка\|null	$default

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

mixed

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

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

Параметры

строка	$question
массив\|вызов	$choices
строка\|null	$default

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

mixed

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

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

Параметры

строка	$question
массив\|вызов	$choices
строка\|null	$default

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

mixed

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

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

Параметры

строка	$question
bool	$fallback

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

mixed

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

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

Параметры

строка	$question
массив	$choices
строка\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

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

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

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

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

Параметры

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

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

void

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

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

Параметры

iterable\|int	$totalSteps
Closure	$callback

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

mixed|void

void info(string $string, int|string|null $verbosity = null)

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

Параметры

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

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

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

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

Параметры

строка	$string
строка\|null	$style
int\|строка\|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, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

$this newLine(int $count = 1)

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

Параметры

int

$count

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

$this

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

void trap(iterable<array-key,int>|int $signals, $callback)

Определить обработчик, который будет запущен при возникновении указанного(ых) сигнала(ов).

Параметры

iterable<array-key,int>\|int	$signals
	$callback

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

void

void untrap()

internal

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

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

void

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

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

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

array

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

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

Параметры

InputInterface

$input

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

bool

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

protected void configureIsolation()

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

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

void

int run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

int

protected CommandMutex commandIsolationMutex()

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

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

CommandMutex

bool isHidden()

{@inheritdoc}

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

bool

Command setHidden(bool $hidden = true)

{@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 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

END_OF_DOCUMENT_MARKER

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

Exceptions

LogicException

protected bool isReservedName(string $name)

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

Parameters

string

$name

Return Value

bool

protected string viewPath(string $path = '')

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

Parameters

string

$path

Return Value

string

protected string replaceUserNamespace(string $stub)

Заменить пространство имён модели User.

Parameters

string

$stub

Return Value

string

protected string replaceModel(string $stub, string $model)

Заменить модель для данного фрагмента.

Parameters

string	$stub
string	$model

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/9.x/Illuminate/Foundation/Console/PolicyMakeCommand.html