Spec-Zone.ru › Laravel 11

VendorPublishCommand

class VendorPublishCommand extends Команда (Просмотреть исходный код)

Трейты

ВызываетКоманды
НастраиваетПодсказки
ИмеетПараметры
ВзаимодействуетСВводомВыводом
ВзаимодействуетССигналами
ЗапрашиваетОтсутствующийВвод
Макросовместимый

Свойства

protected Фабрика внутренний $components

Фабрика компонентов консоли.

из ВзаимодействуетСВводомВыводом
protected InputInterface $input

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

из ВзаимодействуетСВводомВыводом
protected СтильВывода $output

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

из ВзаимодействуетСВводомВыводом
protected int $verbosity

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

из ВзаимодействуетСВводомВыводом
protected array $verbosityMap

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

из ВзаимодействуетСВводомВыводом
protected Сигналы|null $signals

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

из ВзаимодействуетССигналами
static protected array $macros

Зарегистрированные макросы строк.

из Макросовместимый
protected Приложение $laravel

Экземпляр приложения Laravel.

из Команда
protected string $signature

Подпись команды консоли.

protected string $name

Имя команды консоли.

из Команда
protected string $description

Описание команды консоли.

protected string $help

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

из Команда
protected bool $hidden

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

из Команда
protected bool $isolated

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

из Команда
protected int $isolatedExitCode

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

из Команда
protected array $aliases

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

из Команда
protected ФайловаяСистема $files

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

protected string $provider

Провайдер для публикации.

protected array $tags

Теги для публикации.

protected Carbon|null $publishedAt

Время начала работы команды.

static protected bool $updateMigrationDates

Указывает, должны ли быть обновлены даты миграций во время публикации.

Методы

Команда 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
смешанный promptUntilValid(Closure $prompt, bool|string $required, Closure|null $validate)

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

из ConfiguresPrompts
?string validatePrompt(mixed $value, mixed $rules)

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

из ConfiguresPrompts
Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

из ConfiguresPrompts
массив validationMessages()

Получить сообщения об ошибках валидации, которые должны использоваться при проверке подсказок.

из ConfiguresPrompts
массив validationAttributes()

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

из ConfiguresPrompts
void restorePrompts()

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

из ConfiguresPrompts
void specifyParameters()

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

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

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

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

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

из HasParameters
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
смешанный ask(string $question, string|null $default = null)

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

из InteractsWithIO
смешанный anticipate(string $question, array|callable $choices, string|null $default = null)

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

из InteractsWithIO
смешанный askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

из InteractsWithIO
смешанный secret(string $question, bool $fallback = true)

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

из InteractsWithIO
string|array 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)

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

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

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

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

Создать новый экземпляр команды.

void configureUsingFluentDefinition()

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

из Command
void configureIsolation()

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

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

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

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

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

из Command
CommandMutex commandIsolationMutex()

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

из Command
void fail(Throwable|string|null $exception = null)

Принудительно завершить команду с ошибкой.

из Command
bool isHidden()

{@inheritdoc}

из Command
Command setHidden(bool $hidden = true)

{@inheritdoc}

из Command
Application getLaravel()

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

из Command
void setLaravel(Container $laravel)

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

из Command
void handle()

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

void determineWhatShouldBePublished()

Определить провайдер или тег(и) для публикации.

void promptForProviderOrTag()

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

array publishableChoices()

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

void parseChoice(string $choice)

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

mixed publishTag(string $tag)

Опубликовать активы для тега.

array pathsToPublish(string $tag)

Получить все пути для публикации.

void publishItem(string $from, string $to)

Опубликовать указанный элемент из и в заданное местоположение.

void publishFile(string $from, string $to)

Опубликовать файл в указанный путь.

void publishDirectory(string $from, string $to)

Опубликовать директорию в указанную директорию.

void moveManagedFiles(string $from, MountManager $manager)

Переместить все файлы в указанном MountManager.

void createParentDirectory(string $directory)

Создать необходимую родительскую директорию для размещения опубликованных файлов.

string ensureMigrationNameIsUpToDate(string $from, string $to)

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

void status(string $from, string $to, string $type)

Вывести сообщение о статусе в консоль.

static void dontUpdateMigrationDates()

Указать команде не обновлять даты миграций при публикации.

Подробности

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)

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

Параметры

Массив $arguments

Значение результата

ArrayInput

protected array context()

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

Значение результата

Массив

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 ?string validatePrompt(mixed $value, mixed $rules)

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

Параметры

mixed $value
mixed $rules

Значение результата

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Параметры

mixed $field
mixed $value
mixed $rules
array $messages
array $attributes

Значение результата

Validator

protected array validationMessages()

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

Значение результата

Массив

protected array validationAttributes()

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

Значение результата

Массив

protected void restorePrompts()

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

Значение результата

void

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

Значение результата

array|string|bool|null

array arguments()

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

Значение результата

Массив

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

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

Значение результата

Массив

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)

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

Параметры

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

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

string|array

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

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

Параметры

array $headers
Arrayable|array $rows
TableStyle|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, 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

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Нет описания

Параметры

$signals
$callback

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

void fail(Throwable|string|null $exception = null)

Принудительное завершение команды с ошибкой.

Параметры

Throwable|string|null $exception

Значение результата

void

Исключения

Throwable

bool isHidden()

{@inheritdoc}

Значение результата

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Параметры

bool $hidden

Значение результата

Command

Приложение getLaravel()

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

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

Приложение

void setLaravel(Контейнер $laravel)

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

Параметры

Контейнер $laravel

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

void

void handle()

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

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

void

protected void determineWhatShouldBePublished()

Определить поставщик или тэг(и) для публикации.

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

void

protected void promptForProviderOrTag()

Запросить, какой поставщик или тэг опубликовать.

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

void

protected array publishableChoices()

Доступные варианты через запрос.

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

array

protected void parseChoice(string $choice)

Обработать ответ, полученный через запрос.

Параметры

string $choice

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

void

protected mixed publishTag(string $tag)

Опубликовать ресурсы для тэга.

Параметры

string $tag

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

mixed

protected array pathsToPublish(string $tag)

Получить все пути для публикации.

Параметры

string $tag

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

array

protected void publishItem(string $from, string $to)

Опубликовать указанный элемент из и в указанное местоположение.

Параметры

string $from
string $to

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

void

protected void publishFile(string $from, string $to)

Опубликовать файл по указанному пути.

Параметры

string $from
string $to

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

void

protected void publishDirectory(string $from, string $to)

Опубликовать директорию в указанную директорию.

Параметры

string $from
string $to

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

void

protected void moveManagedFiles(string $from, MountManager $manager)

Переместить все файлы в указанном MountManager.

Параметры

string $from
MountManager $manager

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

void

protected void createParentDirectory(string $directory)

Создать директорию для размещения опубликованных файлов при необходимости.

Параметры

string $directory

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

void

protected string ensureMigrationNameIsUpToDate(string $from, string $to)

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

Параметры

string $from
string $to

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

string

protected void status(string $from, string $to, string $type)

Вывести сообщение об статусе в консоль.

Параметры

string $from
string $to
string $type

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

void

static void dontUpdateMigrationDates()

Указать команде не обновлять даты миграций при публикации.

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

void

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

Spec-Zone.ru

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