ServeCommand

class ServeCommand 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	Имя и синтаксис команды консоли.	from Command
protected string	$name	Имя команды консоли.
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 int	$portOffset	Текущий смещение порта.
protected Carbon>	$requestsPool	Список запросов, которые обрабатываются, и их время начала.
protected bool	$serverRunningHasBeenDisplayed	Указывает, было ли выведено сообщение «Сервер запущен по...».
static string[]	$passthroughVariables	Переменные окружения, которые должны передаваться от машины-хоста к процессу PHP-сервера.

Методы

Команда	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() Получить параметры консольной команды.
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() Получить все параметры, переданные команде.
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
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
bool	isHidden() {@inheritdoc}	из Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	из Command
Application	getLaravel() Получить экземпляр приложения Laravel.	из Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	из Command
int	handle() Выполнить консольную команду.
Process	startProcess(bool $hasEnvironment) Запустить новый процесс сервера.
array	serverCommand() Получить полную команду сервера.
string	host() Получить хост для команды.
string	port() Получить порт для команды.
array	getHostAndPort() Получить хост и порт из строки параметра хоста.
bool	canTryAnotherPort() Проверить, достигнуто ли максимальное число попыток порта.
handleProcessOutput() Возвращает «вызываемый» элемент для обработки вывода процесса.
Carbon	getDateFromLine(string $line) Получить дату из заданного вывода PHP сервера.
int	getRequestPortFromLine(string $line) Получить порт запроса из заданного вывода PHP сервера.

Подробности

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

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

END_OF_DOCUMENT_MARKER

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

END_OF_DOCUMENT_MARKER

void warn(string $string, int|string|null $verbosity = null)

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

Параметры

string	$string
int\|string\|null	$verbosity

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

void

void alert(string $string, int|string|null $verbosity = null)

Вывести строку в окне оповещения.

Параметры

string	$string
int\|string\|null	$verbosity

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

void

$this newLine(int $count = 1)

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

Параметры

int

$count

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

$this

void setInput(InputInterface $input)

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

Параметры

InputInterface

$input

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

void

void setOutput(OutputStyle $output)

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

Параметры

OutputStyle

$output

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

void

protected void setVerbosity(string|int $level)

Установить уровень подробности.

Параметры

string|int

$level

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

void

protected int parseVerbosity(string|int|null $level = null)

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

Параметры

string|int|null

$level

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

int

OutputStyle getOutput()

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

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

OutputStyle

Factory outputComponents()

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

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

Factory

trap($signals, $callback)

Нет описания.

Параметры

	$signals
	$callback

void untrap()

internal

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

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

void

protected void interact(InputInterface $input, OutputInterface $output)

Взаимодействовать с пользователем перед проверкой ввода.

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected void promptForMissingArguments(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

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

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

array

protected void afterPromptingForMissingArguments(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

Принимает ли ввод какие-либо параметры, отличающиеся от значений по умолчанию.

Параметры

InputInterface

$input

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

bool

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макрос.

Параметры

string	$name
object\|callable	$macro

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

void

static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

static void flushMacros()

Очистить существующие макросы.

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

void

static mixed __callStatic(string $method, array $parameters)

Динамически обработать вызовы к классу.

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

END_OF_DOCUMENT_MARKER

смешанный тип __call(строка $method, массив $parameters)

Динамически обрабатывает вызовы класса.

Параметры

строка	$method
массив	$parameters

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

смешанный тип

Исключения

BadMethodCallException

пустое значение __construct()

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

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

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

защищённый пустое значение configureUsingFluentDefinition()

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

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

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

защищённый пустое значение configureIsolation()

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

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

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

целое число run(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищённый целое число execute(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input
OutputInterface	$output

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

целое число

защищённый CommandMutex commandIsolationMutex()

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

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

CommandMutex

булево значение isHidden()

{@inheritdoc}

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

булево значение

Команда setHidden(булево значение $hidden = true)

{@inheritdoc}

Параметры

булево значение

$hidden

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

Команда

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

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

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

Приложение

пустое значение setLaravel(Контейнер $laravel)

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

Параметры

Контейнер

$laravel

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

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

целое число handle()

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

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

целое число

Исключения

Исключение

защищённый Процесс startProcess(булево значение $hasEnvironment)

Запускает новый процесс сервера.

Параметры

булево значение

$hasEnvironment

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

Процесс

защищённый массив serverCommand()

Получает полную команду сервера.

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

массив

защищённый строка host()

Получает хост для команды.

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

строка

защищённый строка port()

Получает порт для команды.

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

строка

защищённый массив getHostAndPort()

Получает хост и порт из строки опции хоста.

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

массив

защищённый булево значение canTryAnotherPort()

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

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

булево значение

защищённый handleProcessOutput()

Возвращает «вызываемый» объект для обработки вывода процесса.

защищённый Carbon getDateFromLine(строка $line)

Получает дату из заданного вывода PHP сервера.

Параметры

строка

$line

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

Carbon

защищённый целое число getRequestPortFromLine(строка $line)

Получает порт запроса из заданного вывода PHP сервера.

Параметры

строка

$line

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

целое число

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