ServeCommand

class ServeCommand extends Command (View source)

Трейты

InteractsWithTime

CallsCommands

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 string	$outputBuffer	Список строк, которые ожидают вывода.
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
смешанный	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() Получить параметры консольной команды.
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
int	secondsUntil(DateTimeInterface\|DateInterval\|int $delay) Получить количество секунд до заданной даты и времени.	из InteractsWithTime
int	availableAt(DateTimeInterface\|DateInterval\|int $delay = 0) Получить отметку времени UNIX для «доступно в».	из InteractsWithTime
DateTimeInterface\|int	parseDateInterval(DateTimeInterface\|DateInterval\|int $delay) Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.	из InteractsWithTime
int	currentTime() Получить текущее системное время в формате UNIX timestamp.	из InteractsWithTime
string	runTimeForHumans(float $startTime, float $endTime = null) Выводит время выполнения в читаемом формате.	из InteractsWithTime
int	handle() Выполняет команду консоли.
Process	startProcess(bool $hasEnvironment) Запустить новый процесс сервера.
array	serverCommand() Получить полную команду сервера.
string	host() Получить хост для команды.
string	port() Получить порт для команды.
array	getHostAndPort() Получить хост и порт из строки опции хоста.
bool	canTryAnotherPort() Проверить, достигнуто ли максимальное количество попыток изменения порта.
handleProcessOutput() Возвращает "вызываемый" объект для обработки выходных данных процесса.
void	flushOutputBuffer() Очистить буфер вывода.
Carbon	getDateFromLine(string $line) Получить дату из заданного вывода PHP сервера.
int	getRequestPortFromLine(string $line) Получить порт запроса из заданного вывода PHP сервера.

Подробности

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

END_OF_DOCUMENT_MARKER

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 ?string validatePrompt(mixed $value, mixed $rules)

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

Parameters

mixed	$value
mixed	$rules

Return Value

?string

protected Validator getPromptValidatorInstance(mixed $field, mixed $value, mixed $rules, array $messages = [], array $attributes = [])

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

Parameters

mixed	$field
mixed	$value
mixed	$rules
array	$messages
array	$attributes

Return Value

Validator

protected array validationMessages()

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

Return Value

array

protected array validationAttributes()

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

Return Value

array

protected void restorePrompts()

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

Return Value

void

protected void specifyParameters()

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

Return Value

void

protected array getArguments()

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

Return Value

array

protected array getOptions()

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

Return Value

array

bool hasArgument(string|int $name)

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

Parameters

string|int

$name

Return Value

bool

array|string|bool|null argument(string|null $key = null)

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

Parameters

string|null

$key

Return Value

array|string|bool|null

array arguments()

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

Return Value

array

bool hasOption(string $name)

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

Parameters

string

$name

Return Value

bool

string|array|bool|null option(string|null $key = null)

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

Parameters

string|null

$key

Return Value

string|array|bool|null

array options()

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

Return Value

array

bool confirm(string $question, bool $default = false)

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

Parameters

string	$question
bool	$default

Return Value

bool

mixed ask(string $question, string|null $default = null)

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

Parameters

string	$question
string\|null	$default

Return Value

mixed

mixed anticipate(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

mixed askWithCompletion(string $question, array|callable $choices, string|null $default = null)

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

Parameters

string	$question
array\|callable	$choices
string\|null	$default

Return Value

mixed

mixed secret(string $question, bool $fallback = true)

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

Parameters

string	$question
bool	$fallback

Return Value

mixed

string|array choice(string $question, array $choices, string|int|null $default = null, mixed|null $attempts = null, bool $multiple = false)

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

Parameters

string	$question
array	$choices
string\|int\|null	$default
mixed\|null	$attempts
bool	$multiple

Return Value

string|array

void table(array $headers, Arrayable|array $rows, TableStyle|string $tableStyle = 'default', array $columnStyles = [])

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

Parameters

array	$headers
Arrayable\|array	$rows
TableStyle\|string	$tableStyle
array	$columnStyles

Return Value

void

mixed|void withProgressBar(iterable|int $totalSteps, Closure $callback)

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

Parameters

iterable\|int	$totalSteps
Closure	$callback

Return Value

mixed|void

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

Записать строку как вывод информации.

Parameters

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

Return Value

void

void line(string $string, string|null $style = null, int|string|null $verbosity = null)

Записать строку в стандартный вывод.

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

Записать строку как вывод вопроса.

Parameters

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

Return Value

void

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

Записать строку как вывод ошибки.

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

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

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

Parameters

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

Return Value

void

$this newLine(int $count = 1)

Вставить пустую строку.

Parameters

int

$count

Return Value

$this

void setInput(InputInterface $input)

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

Parameters

InputInterface

$input

Return Value

void

void setOutput(OutputStyle $output)

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

Parameters

OutputStyle

$output

Return Value

void

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

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

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

Factory

trap($signals, $callback)

Описание отсутствует

Параметры

	$signals
	$callback

void untrap()

внутренний

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

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

void

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected array promptForMissingArgumentsUsing()

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

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

array

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

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

Параметры

InputInterface	$input
OutputInterface	$output

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

void

protected bool didReceiveOptions(InputInterface $input)

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

Параметры

InputInterface

$input

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

bool

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

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

Параметры

string	$name
object\|callable	$macro

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

void

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

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

Параметры

object	$mixin
bool	$replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string

$name

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

bool

static void flushMacros()

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

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

void

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

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

void __construct()

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

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

void

protected void configureUsingFluentDefinition()

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

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

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

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

Принудительно завершить команду с ошибкой.

Параметры

Throwable|string|null

$exception

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

void

Исключения

Throwable

END_OF_DOCUMENT_MARKER

bool isHidden()

{@inheritdoc}

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

bool

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

{@inheritdoc}

Параметры

bool

$hidden

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

Команда

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

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

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

Приложение

void setLaravel(Контейнер $laravel)

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

Параметры

Контейнер

$laravel

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

void

protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)

Получить количество секунд до заданной даты.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)

Получить отметку времени «доступно в» в формате UNIX.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

int

protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)

Если заданное значение является интервалом, преобразовать его в экземпляр DateTime.

Параметры

DateTimeInterface|DateInterval|int

$delay

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

DateTimeInterface|int

protected int currentTime()

Получить текущее время системы в формате UNIX.

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

int

protected string runTimeForHumans(float $startTime, float $endTime = null)

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

Параметры

float	$startTime
float	$endTime

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

string

int handle()

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

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

int

Исключения

Исключение

protected Process startProcess(bool $hasEnvironment)

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

Параметры

bool

$hasEnvironment

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

Process

protected array serverCommand()

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

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

array

protected string host()

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

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

string

protected string port()

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

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

string

protected array getHostAndPort()

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

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

array

protected bool canTryAnotherPort()

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

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

bool

protected handleProcessOutput()

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

protected void flushOutputBuffer()

Очистить буфер вывода.

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

void

protected Carbon getDateFromLine(string $line)

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

Параметры

string

$line

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

Carbon

protected int getRequestPortFromLine(string $line)

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

Параметры

string

$line

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

int

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