Spec-Zone.ru › Laravel 10

VendorPublishCommand

class VendorPublishCommand extends Command (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

Сигнатура команды консоли.

protected string $name

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

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

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

protected string $provider

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

protected array $tags

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

Методы

Команда 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()

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

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

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

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

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

from InteractsWithIO
OutputStyle getOutput()

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

from InteractsWithIO
Factory outputComponents()

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

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

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

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

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

void configureUsingFluentDefinition()

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

from Command
void configureIsolation()

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

from Command
int run(InputInterface $input, OutputInterface $output)

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

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

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

из Command
CommandMutex commandIsolationMutex()

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

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

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

void createParentDirectory(string $directory)

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

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

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

Details

abstract protected Command resolveCommand(Command|string $command)

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

Parameters

Command|string $command

Return Value

Command

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments

Return Value

int

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

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

Parameters

Command|string $command
array $arguments
OutputInterface $output

Return Value

int

protected ArrayInput createInputFromArguments(array $arguments)

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

Parameters

array $arguments

Return Value

ArrayInput

protected array context()

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

Return Value

array

protected void configurePrompts(InputInterface $input)

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

Parameters

InputInterface $input

Return Value

void

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

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

Parameters

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

Return Value

mixed

protected void restorePrompts()

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

Return Value

void
END_OF_DOCUMENT_MARKER

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)

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

Параметры

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

внутренний

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

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

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

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
END_OF_DOCUMENT_MARKER

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

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

Параметры

string $from
string $to

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

void

protected void moveManagedFiles(MountManager $manager)

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

Параметры

MountManager $manager

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

void

protected void createParentDirectory(string $directory)

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

Параметры

string $directory

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

void

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

Записать сообщение об статусе в консоль.

Параметры

string $from
string $to
string $type

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

void

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

Spec-Zone.ru

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