Приложение

$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	Экземпляр Input
OutputInterface	$output	Экземпляр Output

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

int	0, если всё прошло успешно, или код ошибки

Исключения

Exception

Когда doRun возвращает Exception

int doRun(InputInterface $input, OutputInterface $output)

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

Параметры

InputInterface	$input	Экземпляр Input
OutputInterface	$output	Экземпляр 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

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

addCommands(array $commands)

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

Параметры

array

$commands

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

Command add(Command $command)

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

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

Параметры

Command

$command

Объект Command

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

Command

Зарегистрированная команда

Command get(string $name)

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

Параметры

string

$name

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

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

Command

Объект Command

Исключения

CommandNotFoundException

Когда заданное имя команды не существует

bool has(string $name)

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

Параметры

string

$name

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

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

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

array getNamespaces()

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

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

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

array

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

string findNamespace(string $namespace)

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

Параметры

string

$namespace

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

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

string

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

Исключения

CommandNotFoundException

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

Command find(string $name)

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

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

Параметры

string

$name

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

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

Command

Экземпляр Command

Исключения

CommandNotFoundException

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

Command[] all(string $namespace = null)

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

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

Параметры

string

$namespace

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

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

Command[]

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

static array getAbbreviations(array $names)

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

Параметры

array

$names

Массив имен

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

array

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

renderException(Exception $e, OutputInterface $output)

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

Параметры

Exception	$e	Экземпляр исключения
OutputInterface	$output	Экземпляр OutputInterface

array getTerminalDimensions()

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

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

array

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

Application setTerminalDimensions(int $width, int $height)

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

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

Параметры

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

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

Application

Текущее приложение

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

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

Этот метод не входит в общедоступный API и не должен использоваться напрямую.

Параметры

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

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

string

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

setDefaultCommand(string $commandName)

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

Параметры

string

$commandName

Имя команды