DocsCommand

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

Трейты

ВызываетКоманды

НастраиваетПодсказки

СодержитПараметры

ВзаимодействуетСВводомВыводом

ВзаимодействуетССигналами

ЗапрашиваетОтсутствующийВвод

Macroable

Свойства

protected Фабрика внутреннее	$components	Фабрика компонентов консоли.	из ВзаимодействуетСВводомВыводом
protected InputInterface	$input	Реализация интерфейса ввода.	из ВзаимодействуетСВводомВыводом
protected СтильВывода	$output	Реализация интерфейса вывода.	из ВзаимодействуетСВводомВыводом
protected int	$verbosity	Уровень детализации вывода по умолчанию для команд.	из ВзаимодействуетСВводомВыводом
protected array	$verbosityMap	Сопоставление между удобочитаемыми уровнями детализации и уровнями Symfony OutputInterface.	из ВзаимодействуетСВводомВыводом
protected Сигналы\|null	$signals	Экземпляр регистратора сигналов.	из ВзаимодействуетССигналами
static protected array	$macros	Зарегистрированные макросы строк.	из Macroable
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 Фабрика	$http	Экземпляр HTTP клиента.
protected Репозиторий	$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	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() Создаёт новый экземпляр команды консоли.	из 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
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	configure() Настроить текущую команду.
int	handle(Factory $http, Repository $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($search) Предположить, какую страницу пользователь пытается открыть.
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 с помощью встроенной стратегии.
Collection	sectionsFor(string $page) Доступные разделы для страницы.
Collection	pages() Доступные страницы для открытия.
Collection	docs() Получить индекс документации в виде коллекции.
void	refreshDocs() Обновить кэшированную копию индекса документации.
Response	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(Команда|строка $command)

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

Параметры

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

$command

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

Команда

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

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

Параметры

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

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

int

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

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

Параметры

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

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

int

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

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

Параметры

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

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

int

protected int runCommand(Команда|строка $command, массив $arguments, OutputInterface $output)

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

Параметры

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

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

int

protected ArrayInput createInputFromArguments(массив $arguments)

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

Параметры

массив

$arguments

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

ArrayInput

protected массив context()

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

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

массив

protected void configurePrompts(InputInterface $input)

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

Параметры

InputInterface

$input

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

void

protected смешанный promptUntilValid(Closure $prompt, bool|строка $required, Closure|null $validate)

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

Параметры

Closure	$prompt
bool\|строка	$required
Closure\|null	$validate

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

смешанный

protected ?строка validatePrompt(смешанный $value, смешанный $rules)

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

Параметры

смешанный	$value
смешанный	$rules

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

?строка

protected Validator getPromptValidatorInstance(смешанный $field, смешанный $value, смешанный $rules, массив $messages = [], массив $attributes = [])

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

Параметры

смешанный	$field
смешанный	$value
смешанный	$rules
массив	$messages
массив	$attributes

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

Validator

protected массив validationMessages()

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

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

массив

protected массив validationAttributes()

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

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

массив

protected void restorePrompts()

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

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

void

protected void specifyParameters()

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

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

void

protected массив getArguments()

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

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

массив

protected массив getOptions()

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

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

массив

bool hasArgument(строка|int $name)

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

Параметры

строка|int

$name

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

bool

массив|строка|bool|null argument(строка|null $key = null)

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

Параметры

строка|null

$key

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

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

массив arguments()

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

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

массив

bool hasOption(строка $name)

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

Параметры

строка

$name

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

bool

строка|массив|bool|null option(строка|null $key = null)

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

Параметры

строка|null

$key

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

строка|массив|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

Factory outputComponents()

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

Return Value

Factory

trap($signals, $callback)

Без описания

Parameters

	$signals
	$callback

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

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

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)

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

Parameters

InputInterface	$input
OutputInterface	$output

Return Value

int

protected CommandMutex commandIsolationMutex()

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

Return Value

CommandMutex

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

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

Parameters

Throwable|string|null

$exception

Return Value

void

Exceptions

Throwable

bool isHidden()

{@inheritdoc}

Return Value

bool

Command setHidden(bool $hidden = true)

{@inheritdoc}

Parameters

bool

$hidden

Return Value

Command

Application getLaravel()

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

Return Value

Application

void setLaravel(Container $laravel)

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

Parameters

Container

$laravel

Return Value

void

protected void configure()

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

Return Value

void

int handle(Factory $http, Repository $cache)

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

Parameters

Factory	$http
Repository	$cache

Return Value

int

protected void openUrl()

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

Return Value

void

protected string url()

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

Return Value

string

protected string page()

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

Return Value

string

protected string|null resolvePage()

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

Return Value

string|null

protected bool didNotRequestPage()

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

Return Value

bool

protected string|null askForPage()

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

Return Value

string|null

protected string|null askForPageViaCustomStrategy()

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

Return Value

string|null

protected string|null askForPageViaAutocomplete()

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

Return Value

string|null

protected string|null guessPage($search)

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

Parameters

$search

Return Value

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

Коллекция sectionsFor(string $page)

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

Параметры

string

$page

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

Коллекция

Коллекция pages()

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

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

Коллекция

Коллекция docs()

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

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

Коллекция

protected void refreshDocs()

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

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

void

protected Ответ fetchDocs()

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

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

Ответ

protected string version()

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

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

string

protected string searchQuery()

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

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

string

protected bool isSearching()

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

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

bool

$this setVersion(string $version)

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

Параметры

string

$version

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

$this

$this setUrlOpener(callable|null $opener)

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

Параметры

callable|null

$opener

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

$this

$this setSystemOsFamily(string $family)

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

Параметры

string

$family

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

$this

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