Приложение

$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

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

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

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

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

Исключения

Исключение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

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

Приложение setDefaultCommand(string $commandName, bool $isSingleCommand = false)

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

Параметры

string	$commandName	Имя команды
bool	$isSingleCommand	Установите в true, если в этом приложении только одна команда

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

Приложение