Приложение

$app = new Application('myapp', '1.0 (stable)');
$app->add(new SimpleCommand());
$app->run();

__construct(string $name = 'UNKNOWN', string $version = 'UNKNOWN')

Параметры

string	$name	Название приложения
string	$version	Версия приложения

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

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

setCatchExceptions(bool $boolean)

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

Параметры

bool

$boolean

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

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

Созданная команда

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

Если пространство имен неверно или неоднозначно

Command find(string $name)

Находит команду по имени или псевдониму.

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

Параметры

string

$name

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

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

Command

Экземпляр Command

Исключения

CommandNotFoundException

Если имя команды неверно или неоднозначно

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

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

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

Параметры

string

$namespace

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

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

Команда[]

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

static array getAbbreviations(array $names)

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

Параметры

array

$names

Массив имён

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

array

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

string asText(string $namespace = null, bool $raw = false) ^{устаревший}

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

since версия 2.3, будет удалён в 3.0.

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

Параметры

string	$namespace	Необязательное имя пространства имён
bool	$raw	Возвращать ли список команд в сыром виде

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

string

Строковое представление приложения

string|DOMDocument asXml(string $namespace = null, bool $asDom = false) ^{устаревший}

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

since версия 2.3, будет удалён в 3.0.

Возвращает XML-представление приложения.

Параметры

string	$namespace	Необязательное имя пространства имён
bool	$asDom	Возвращать DOM или строку XML

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

string|DOMDocument

XML-строка, представляющая приложение

renderException($e, $output)

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

Параметры

	$e
	$output

array getTerminalDimensions()

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

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

array

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

$this setTerminalDimensions(int $width, int $height)

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

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

Параметры

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

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

$this

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

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

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

Параметры

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

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

string

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

setDefaultCommand(string $commandName)

Устанавливает имя команды по умолчанию.

Параметры

string

$commandName

Имя команды