Приложение

$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

setCommandLoader(CommandLoaderInterface $commandLoader)

Параметры

CommandLoaderInterface

$commandLoader

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

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

Исключения

NamespaceNotFoundException

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

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

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

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

Параметры

string

$name

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

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

Команда

Экземпляр команды

Исключения

CommandNotFoundException

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

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

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

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

Параметры

string

$namespace

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

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

Команда[]

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

static array getAbbreviations(array $names)

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

Параметры

array

$names

Массив имён

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

array

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

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

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

Параметры

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

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

Параметры

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

protected configureIO(Интерфейс ввода $input, Интерфейс вывода $output)

Настраивает экземпляры ввода и вывода на основе аргументов и опций пользователя.

Параметры

Интерфейс ввода	$input
Интерфейс вывода	$output

protected int doRunCommand(Команда $command, Интерфейс ввода $input, Интерфейс вывода $output)

Выполняет текущую команду.

Если диспетчер событий был присоединён к приложению, события также рассылаются во время жизненного цикла команды.

Параметры

Команда	$command
Интерфейс ввода	$input
Интерфейс вывода	$output

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

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

protected string getCommandName(Интерфейс ввода $input)

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

Параметры

Интерфейс ввода

$input

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

string

Имя команды

protected Определение ввода getDefaultInputDefinition()

Получает определение ввода по умолчанию.

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

Определение ввода

Экземпляр InputDefinition

protected Команда[] getDefaultCommands()

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

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

Команда[]

Массив экземпляров команд по умолчанию

protected Набор помощников getDefaultHelperSet()

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

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

Набор помощников

Экземпляр HelperSet

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

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

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

Параметры

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

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

string

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

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

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

Параметры

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

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

Приложение