Spec-Zone.ru › Laravel 9

VendorPublishCommand

класс VendorPublishCommand расширяет Command (View source)

Трейты

CallsCommands
HasParameters
InteractsWithIO
InteractsWithSignals
PromptsForMissingInput
Macroable

Свойства

protected Factory internal $components

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

 из InteractsWithIO
protected InputInterface $input

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

 из InteractsWithIO
protected OutputStyle $output

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

 из InteractsWithIO
protected int $verbosity

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

 из InteractsWithIO
protected array $verbosityMap

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

 из InteractsWithIO
protected Signals|null $signals

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

 из InteractsWithSignals
static protected array $macros

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

 из Macroable
protected Application $laravel

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

 из Command
protected string $signature

Подпись команды консоли.
protected string $name

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

 из Command
protected string $description

Описание команды консоли.
protected string $help

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

 из Command
protected bool $hidden

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

 из Command
protected Filesystem $files

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

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

Теги для публикации.
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()

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

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

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

 из 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
void trap(iterable<array-key,int>|int $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
bool isHidden()

{@inheritdoc}

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

{@inheritdoc}

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

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

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

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

 из Команды
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)

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

Подробности

abstract protected Command resolveCommand(Command|string $command)

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

Параметры

Command|string $command

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

Command

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

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

Параметры

Command|string $command
array $arguments

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

int

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

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

Параметры

Command|string $command
array $arguments

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

int

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

массив options()

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

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

массив

логическое значение confirm(строка $question, логическое значение $default = false)

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

Параметры

строка $question
логическое значение $default

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

логическое значение

смешанное значение ask(строка $question, строка|null $default = null)

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

Параметры

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

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

смешанное значение

смешанное значение anticipate(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

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

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

смешанное значение

смешанное значение askWithCompletion(строка $question, массив|вызов $choices, строка|null $default = null)

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

Параметры

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

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

смешанное значение

смешанное значение secret(строка $question, логическое значение $fallback = true)

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

Параметры

строка $question
логическое значение $fallback

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

смешанное значение

строка|массив choice(строка $question, массив $choices, строка|целое число|null $default = null, смешанное значение|null $attempts = null, логическое значение $multiple = false)

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

Параметры

строка $question
массив $choices
строка|целое число|null $default
смешанное значение|null $attempts
логическое значение $multiple

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

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

пустое значение table(массив $headers, Arrayable|массив $rows, TableStyle|строка $tableStyle = 'default', массив $columnStyles = [])

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

Параметры

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

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

пустое значение

смешанное значение|пустое значение withProgressBar(последовательность|целое число $totalSteps, Closure $callback)

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

Параметры

последовательность|целое число $totalSteps
Closure $callback

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

смешанное значение|пустое значение

пустое значение info(строка $string, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

пустое значение line(строка $string, строка|null $style = null, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
строка|null $style
целое число|строка|null $verbosity

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

пустое значение

пустое значение comment(строка $string, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

пустое значение question(строка $string, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

пустое значение error(строка $string, целое число|строка|null $verbosity = null)

Вывести строку как ошибку.

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

пустое значение warn(строка $string, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

пустое значение alert(строка $string, целое число|строка|null $verbosity = null)

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

Параметры

строка $string
целое число|строка|null $verbosity

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

пустое значение

$this newLine(целое число $count = 1)

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

Параметры

целое число $count

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

$this

пустое значение setInput(InputInterface $input)

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

Параметры

InputInterface $input

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

пустое значение

пустое значение setOutput(OutputStyle $output)

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

Параметры

OutputStyle $output

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

пустое значение

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

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

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

Parameters

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

Return Value

void

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)

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

Параметры

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

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

Spec-Zone.ru

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