AboutCommand

class AboutCommand 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	Подпись команды консоли.
protected string	$name	Имя команды консоли.	from Command
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 Composer	$composer	Экземпляр Composer.
static protected array	$data	Данные для отображения.
static protected array	$customDataResolvers	Зарегистрированные вызываемые объекты, которые добавляют пользовательские данные в вывод команды.

Методы

Command	resolveCommand(Command\|string $command) Разрешить экземпляр консольной команды для данной команды.	from CallsCommands
int	call(Command\|string $command, array $arguments = []) Вызвать другую консольную команду.	from CallsCommands
int	callSilent(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	from CallsCommands
int	callSilently(Command\|string $command, array $arguments = []) Вызвать другую консольную команду без вывода.	from CallsCommands
int	runCommand(Command\|string $command, array $arguments, OutputInterface $output) Запустить данную консольную команду.	from CallsCommands
ArrayInput	createInputFromArguments(array $arguments) Создать экземпляр ввода из заданных аргументов.	from CallsCommands
array	context() Получить весь контекст, переданный команде.	from CallsCommands
void	configurePrompts(InputInterface $input) Настроить резервные варианты подсказок.	from ConfiguresPrompts
mixed	promptUntilValid(Closure $prompt, bool\|string $required, Closure\|null $validate) Запрашивать у пользователя ввод до тех пор, пока обратный вызов проверки не пройдёт.	from ConfiguresPrompts
void	restorePrompts() Восстановить вывод подсказок.	from ConfiguresPrompts
void	specifyParameters() Указать аргументы и параметры в команде.	from HasParameters
array	getArguments() Получить аргументы консольной команды.	from HasParameters
array	getOptions() Получить параметры консольной команды.	from HasParameters
bool	hasArgument(string\|int $name) Определить, присутствует ли данный аргумент.	from InteractsWithIO
array\|string\|bool\|null	argument(string\|null $key = null) Получить значение аргумента команды.	from InteractsWithIO
array	arguments() Получить все аргументы, переданные команде.	from InteractsWithIO
bool	hasOption(string $name) Определить, присутствует ли данный параметр.	from InteractsWithIO
string\|array\|bool\|null	option(string\|null $key = null) Получить значение параметра команды.	from InteractsWithIO
array	options() Получить все параметры, переданные команде.	from InteractsWithIO
bool	confirm(string $question, bool $default = false) Подтвердить вопрос с пользователем.	from InteractsWithIO
mixed	ask(string $question, string\|null $default = null) Запросить у пользователя ввод.	from InteractsWithIO
mixed	anticipate(string $question, array\|callable $choices, string\|null $default = null) Запросить у пользователя ввод с автодополнением.	from InteractsWithIO
mixed	askWithCompletion(string $question, array\|callable $choices, string\|null $default = null) Запросить у пользователя ввод с автодополнением.	from InteractsWithIO
mixed	secret(string $question, bool $fallback = true) Запросить у пользователя ввод, но скрыть ответ от консоли.	from InteractsWithIO
string\|array	choice(string $question, array $choices, string\|int\|null $default = null, mixed\|null $attempts = null, bool $multiple = false) Предоставить пользователю единственный выбор из массива ответов.	from InteractsWithIO
void	table(array $headers, Arrayable\|array $rows, TableStyle\|string $tableStyle = 'default', array $columnStyles = []) Форматировать ввод в текстовую таблицу.	from InteractsWithIO
mixed\|void	withProgressBar(iterable\|int $totalSteps, Closure $callback) Выполнить заданный обратный вызов, продвигая индикатор выполнения.	from InteractsWithIO
void	info(string $string, int\|string\|null $verbosity = null) Вывести строку в качестве информационного вывода.	from 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(Composer $composer) Создать новый экземпляр команды.
void	configureUsingFluentDefinition() Настроить команду консоли с помощью определения fluent.	из Command
void	configureIsolation() Настроить команду консоли для изоляции.	из Command

int	run(InputInterface $input, OutputInterface $output) Запустить консольную команду.	from Command
int	execute(InputInterface $input, OutputInterface $output) Выполнить консольную команду.	from Command
CommandMutex	commandIsolationMutex() Получить экземпляр мьютекса изоляции команды для команды.	from Command
bool	isHidden() {@inheritdoc}	from Command
Command	setHidden(bool $hidden = true) {@inheritdoc}	from Command
Application	getLaravel() Получить экземпляр приложения Laravel.	from Command
void	setLaravel(Container $laravel) Установить экземпляр приложения Laravel.	from Command
int	handle() Выполнить консольную команду.
void	display(Collection $data) Отобразить информацию об приложении.
void	displayDetail(Collection $data) Отобразить информацию об приложении в виде подробного представления.
void	displayJson(Collection $data) Отобразить информацию об приложении в формате JSON.
void	gatherApplicationInformation() Собрать информацию о приложении.
bool	hasPhpFiles(string $path) Определить, содержит ли заданная директория файлы PHP.
static void	add(string $section, callable\|string\|array $data, string $value = null) Добавить дополнительные данные в вывод команды "about".
static void	addToSection(string $section, callable\|string\|array $data, string $value = null) Добавить дополнительные данные в вывод команды "about".
array	sections() Получить разделы, предоставленные команде.
static	format(mixed $value, Closure $console = null, Closure $json = null) Материализовать функцию, которая форматирует заданное значение для вывода в консоль или JSON.
string	toSearchKeyword(string $value) Отформатировать заданную строку для поиска.
static void	flushState() Очистить зарегистрированные данные о команде "about".

Details

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

END_OF_DOCUMENT_MARKER

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

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(Composer $composer)

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

Параметры

Composer

$composer

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

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

int handle()

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

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

int

protected void display(Collection $data)

Отобразить информацию об приложении.

Параметры

Collection

$data

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

void

protected void displayDetail(Collection $data)

Отобразить информацию об приложении в виде детализированного представления.

Параметры

Collection

$data

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

void

protected void displayJson(Collection $data)

Отобразить информацию об приложении в формате JSON.

Параметры

Collection

$data

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

void

protected void gatherApplicationInformation()

Собрать информацию об приложении.

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

void

protected bool hasPhpFiles(string $path)

Определить, содержит ли указанная директория файлы PHP.

Параметры

string

$path

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

bool

static void add(string $section, callable|string|array $data, string $value = null)

Добавить дополнительные данные в вывод команды "about".

Параметры

string	$section
callable\|string\|array	$data
string	$value

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

void

END_OF_DOCUMENT_MARKER

static protected void addToSection(string $section, callable|string|array $data, string $value = null)

Добавить дополнительные данные к выводу команды "about".

Параметры

string	$section
callable\|string\|array	$data
string	$value

Значение результата

void

protected array sections()

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

Значение результата

array

static format(mixed $value, Closure $console = null, Closure $json = null)

Материализовать функцию, которая форматирует заданное значение для вывода в консоль или формате JSON.

Параметры

mixed	$value
Closure	$console
Closure	$json

protected string toSearchKeyword(string $value)

Форматировать заданную строку для поиска.

Параметры

string

$value

Значение результата

string

static void flushState()

Очистить зарегистрированные данные about.

Значение результата

void

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