Приложение

класс Приложение расширяет Приложение

Методы

	__construct(Интерфейс ядра $kernel)
	setDispatcher(Интерфейс диспетчера событий $dispatcher)	из Приложение
int	run(Интерфейс ввода $input = null, Интерфейс вывода $output = null) Запускает текущее приложение.	из Приложение
int	doRun(Интерфейс ввода $input, Интерфейс вывода $output) Запускает текущее приложение.
	setHelperSet(Набор помощников $helperSet)	из Приложение
Набор помощников	getHelperSet() Получить набор помощников, связанный с командой.	из Приложение
	setDefinition(Определение ввода $definition)	из Приложение
Определение ввода	getDefinition() Получить определение ввода, связанное с этим приложением.	из Приложение
string	getHelp() Получить сообщение справки.	из Приложение
bool	areExceptionsCaught() Получить, перехватывать ли исключения при выполнении команд.	из Приложение
	setCatchExceptions(bool $boolean) Устанавливает, перехватывать ли исключения при выполнении команд.	из Приложение
bool	isAutoExitEnabled() Получить, автоматически ли завершать работу после выполнения команды.	из Приложение
	setAutoExit(bool $boolean) Устанавливает, автоматически ли завершать работу после выполнения команды.	из Приложение
string	getName() Получить имя приложения.	из Приложение
	setName(string $name) Установить имя приложения.	из Приложение
string	getVersion() Получить версию приложения.	из Приложение
	setVersion(string $version) Установить версию приложения.	из Приложение
string	getLongVersion() Возвращает полную версию приложения.
Команда	register(string $name) Регистрирует новую команду.	из Приложение
	addCommands(array $commands) Добавляет массив объектов команд.	из Приложение
Команда\|null	add(Команда $command) Добавляет объект команды.
Команда	get(string $name) Возвращает зарегистрированную команду по имени или псевдониму.
bool	has(string $name) Возвращает true, если команда существует, иначе false.	из Приложение
string[]	getNamespaces() Возвращает массив всех уникальных пространств имен, используемых текущими зарегистрированными командами.	из Приложение
string	findNamespace(string $namespace) Находит зарегистрированное пространство имен по имени или аббревиатуре.	из Приложение
Команда	find(string $name) Находит команду по имени или псевдониму.
Команда[]	all(string $namespace = null) Получает команды (зарегистрированные в заданном пространстве имен, если указано).
static array	getAbbreviations(array $names) Возвращает массив возможных аббревиатур, заданных набором имен.	из Приложение
	renderException(Исключение $e, Интерфейс вывода $output) Отображает пойманное исключение.	из Приложение
array	getTerminalDimensions() ^{устаревшее} Пытается определить размеры терминала на основе текущей среды.	из Приложение
$this	setTerminalDimensions(int $width, int $height) ^{устаревшее} Устанавливает размеры терминала.	из Приложение
string	extractNamespace(string $name, string $limit = null) Возвращает часть пространства имен имени команды.	из Приложение
Приложение	setDefaultCommand(string $commandName, bool $isSingleCommand = false) Устанавливает имя по умолчанию для команды.	из Приложение
Интерфейс ядра	getKernel() Получить ядро, связанное с этим консольным приложением.

Подробности

__construct(KernelInterface $kernel)

Параметры

KernelInterface

$kernel

setDispatcher(EventDispatcherInterface $dispatcher)

Параметры

EventDispatcherInterface

$dispatcher

int run(InputInterface $input = null, OutputInterface $output = null)

Выполняет текущее приложение.

Параметры

InputInterface	$input
OutputInterface	$output

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

int	0, если все прошло хорошо, или код ошибки

Исключения

Exception

При возникновении ошибки при выполнении. Пропускается при {@link setCatchExceptions()}.

int doRun(InputInterface $input, OutputInterface $output)

Выполняет текущее приложение.

Параметры

InputInterface	$input
OutputInterface	$output

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

int	0, если все прошло хорошо, или код ошибки

setHelperSet(HelperSet $helperSet)

Параметры

HelperSet

$helperSet

HelperSet getHelperSet()

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

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

HelperSet

Экземпляр HelperSet, связанный с этой командой

setDefinition(InputDefinition $definition)

Параметры

InputDefinition

$definition

InputDefinition getDefinition()

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

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

InputDefinition

Экземпляр InputDefinition

string getHelp()

Получение сообщения справки.

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

string

Сообщение справки

bool areExceptionsCaught()

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

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

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

setCatchExceptions(bool $boolean)

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

Параметры

bool

$boolean

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

bool isAutoExitEnabled()

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

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

bool	Нужно ли автоматически завершать выполнение после выполнения команды

setAutoExit(bool $boolean)

Устанавливает значение, определяющее, нужно ли автоматически завершать выполнение после выполнения команды.

Параметры

bool

$boolean

Нужно ли автоматически завершать выполнение после выполнения команды

string getName()

Получение имени приложения.

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

string

Имя приложения

setName(string $name)

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

Параметры

string

$name

Имя приложения

string getVersion()

Получение версии приложения.

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

string

Версия приложения

setVersion(string $version)

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

Параметры

string

$version

Версия приложения

string getLongVersion()

Возвращает полную версию приложения.

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

string

Полная версия приложения

Command register(string $name)

Регистрация новой команды.

Параметры

string

$name

Имя команды

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

Command

Новoсозданная команда

addCommands(array $commands)

Добавление массива объектов команд.

Если команда не включена, она не будет добавлена.

Параметры

array

$commands

Массив команд

Command|null add(Command $command)

Добавление объекта команды.

Если команда с таким же именем уже существует, она будет перезаписана. Если команда не включена, она не будет добавлена.

Параметры

Command

$command

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

Command|null

Зарегистрированная команда, если она включена, или null

Command get(string $name)

Возвращает зарегистрированную команду по имени или псевдониму.

Параметры

string

$name

Имя или псевдоним команды

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

Command

Объект Command

Исключения

CommandNotFoundException

При отсутствии команды с заданным именем

bool has(string $name)

Возвращает true, если команда существует, и false в противном случае.

Параметры

string

$name

Имя или псевдоним команды

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

bool	true, если команда существует, и false в противном случае

string[] getNamespaces()

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

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

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

string[]

Массив пространств имен

string findNamespace(string $namespace)

Находит зарегистрированное пространство имен по имени или аббревиатуре.

Параметры

string

$namespace

Пространство имён или сокращение для поиска

Значение возвращаемого значения

string

Зарегистрированное пространство имён

Исключения

CommandNotFoundException

При некорректном или неоднозначном пространстве имён

Команда find(string $name)

Ищет команду по имени или псевдониму.

В отличие от метода get, эта команда пытается найти наилучшее совпадение, если вы передадите сокращение имени или псевдонима.

Параметры

string

$name

Имя команды или псевдоним команды

Значение возвращаемого значения

Команда

Экземпляр Command

Исключения

CommandNotFoundException

При некорректном или неоднозначном имени команды

Команда[] all(string $namespace = null)

Возвращает команды (зарегистрированные в заданном пространстве имён, если указано).

Ключи массива — полные имена, а значения — экземпляры команд.

Параметры

string

$namespace

Имя пространства имён

Значение возвращаемого значения

Команда[]

Массив экземпляров Command

static array getAbbreviations(array $names)

Возвращает массив возможных сокращений, заданных набором имён.

Параметры

array

$names

Массив имён

Значение возвращаемого значения

array

Массив сокращений

renderException(Исключение $e, Интерфейс вывода $output)

Отображает пойманное исключение.

Параметры

Исключение	$e
Интерфейс вывода	$output

array getTerminalDimensions() ^{устаревший}

^{устаревший}

since версия 3.2, будет удалён в 4.0. Создайте экземпляр Terminal вместо этого.

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

Значение возвращаемого значения

array

Массив, содержащий ширину и высоту

$this setTerminalDimensions(int $width, int $height) ^{устаревший}

^{устаревший}

since версия 3.2, будет удалён в 4.0. Установите переменные среды COLUMNS и LINES вместо этого.

Устанавливает размеры терминала.

Может быть полезно для принудительного задания размеров терминала для функциональных тестов.

Параметры

int	$width	Ширина
int	$height	Высота

Значение возвращаемого значения

$this

string extractNamespace(string $name, string $limit = null)

Возвращает часть имени команды, относящуюся к пространству имён.

Этот метод не является частью публичного API и не должен использоваться напрямую.

Параметры

string	$name	Полное имя команды
string	$limit	Максимальное количество частей пространства имён

Значение возвращаемого значения

string

Пространство имён команды