DocsCommand

класс DocsCommand расширяет 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	Текст справки команды консоли.
protected bool	$hidden	Указывает, должна ли команда отображаться в списке команд Artisan.	из Command
static protected string\|null deprecated	$defaultName	Имя команды консоли.
protected Factory	$http	Экземпляр HTTP-клиента.
protected Repository	$cache	Реализация репозитория кеша.
protected callable\|null	$urlOpener	Пользовательский открыватель URL.
protected string\|null	$version	Пользовательская версия документации для открытия.
protected string	$systemOsFamily	Семейство операционной системы.

Методы

Команда	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) Получить уровень подробности в терминах уровня OutputInterface Symfony.	из 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() Создать новый экземпляр команды консоли.	из Command
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	configure() Настроить текущую команду.
int	handle(Фабрика $http, Репозиторий $cache) Выполнить консольную команду.
void	openUrl() Открыть URL документации.
string	url() URL страницы документации.
string	page() Открываемая страница.
string\|null	resolvePage() Определить страницу для открытия.
bool	didNotRequestPage() Определить, запросил ли пользователь конкретную страницу при вызове команды.
string\|null	askForPage() Спросить у пользователя, какую страницу он хотел бы открыть.
string\|null	askForPageViaCustomStrategy() Спросить у пользователя, какую страницу он хотел бы открыть, используя пользовательскую стратегию.
string\|null	askForPageViaAutocomplete() Спросить у пользователя, какую страницу он хотел бы открыть, используя автодополнение.
string\|null	guessPage() Предположить, какую страницу пытается открыть пользователь.
string\|null	section(string $page) Раздел, который пользователь явно запросил открыть.
bool	didNotRequestSection() Определить, запросил ли пользователь конкретный раздел при вызове команды.
string\|null	guessSection(string $page) Предположить, какой раздел пытается открыть пользователь.
void	open(string $url) Открыть URL в браузере пользователя.
void	openViaCustomStrategy(string $url) Открыть URL с помощью пользовательской стратегии.
void	openViaBuiltInStrategy(string $url) Открыть URL с помощью встроенной стратегии.
Коллекция	sectionsFor(string $page) Доступные разделы для страницы.
Коллекция	pages() Доступные для открытия страницы.
Коллекция	docs() Получить индекс документации в виде коллекции.
void	refreshDocs() Обновить кэшированную копию индекса документации.
Ответ	fetchDocs() Получить индекс документации с сайта Laravel.
string	version() Определить версию документации для открытия.
string	searchQuery() Запрос поиска, предоставленный пользователем.
bool	isSearching() Определить, предназначена ли команда для выполнения поиска.
$this	setVersion(string $version) Установить версию документации.
$this	setUrlOpener(callable\|null $opener) Установить пользовательскую функцию открытия URL.
$this	setSystemOsFamily(string $family) Установить семейство операционной системы.

Подробности

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

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

Параметры

Команда|string

$command

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

Команда

int call(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

int callSilent(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

int callSilently(Команда|string $command, array $arguments = [])

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

Параметры

Команда\|string	$command
array	$arguments

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

int

protected int runCommand(Команда|string $command, array $arguments, OutputInterface $output)

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

Параметры

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

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

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

END_OF_DOCUMENT_MARKER

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

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

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

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

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

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

void

int handle(Factory $http, Repository $cache)

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

Параметры

Factory	$http
Repository	$cache

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

int

protected void openUrl()

Открыть URL документации.

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

void

protected string url()

URL страницы документации.

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

string

protected string page()

Страница, которую пользователь открывает.

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

string

protected string|null resolvePage()

Определить страницу для открытия.

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

string|null

protected bool didNotRequestPage()

Определить, запросил ли пользователь конкретную страницу при вызове команды.

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

bool

protected string|null askForPage()

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

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

string|null

protected string|null askForPageViaCustomStrategy()

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

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

string|null

protected string|null askForPageViaAutocomplete()

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

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

string|null

protected string|null guessPage()

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

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

string|null

protected string|null section(string $page)

Раздел, который пользователь конкретно попросил открыть.

Parameters

string

$page

Return Value

string|null

protected bool didNotRequestSection()

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

Return Value

bool

protected string|null guessSection(string $page)

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

Parameters

string

$page

Return Value

string|null

protected void open(string $url)

Открыть URL в браузере пользователя.

Parameters

string

$url

Return Value

void

protected void openViaCustomStrategy(string $url)

Открыть URL с помощью пользовательской стратегии.

Parameters

string

$url

Return Value

void

protected void openViaBuiltInStrategy(string $url)

Открыть URL с помощью встроенной стратегии.

Parameters

string

$url

Return Value

void

Collection sectionsFor(string $page)

Доступные разделы для страницы.

Parameters

string

$page

Return Value

Collection

Collection pages()

Доступные для открытия страницы.

Return Value

Collection

Collection docs()

Получить индекс документации в виде коллекции.

Return Value

Collection

protected void refreshDocs()

Обновить кэшированную копию индекса документации.

Return Value

void

protected Response fetchDocs()

Получить индекс документации с веб-сайта Laravel.

Return Value

Response

protected string version()

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

Return Value

string

protected string searchQuery()

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

Return Value

string

protected bool isSearching()

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

Return Value

bool

$this setVersion(string $version)

Установить версию документации.

Parameters

string

$version

Return Value

$this

$this setUrlOpener(callable|null $opener)

Установить пользовательский открыватель URL.

Parameters

callable|null

$opener

Return Value

$this

$this setSystemOsFamily(string $family)

Установить семейство операционной системы системы.

Parameters

string

$family

Return Value

$this

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