Приложение

__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

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

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

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

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

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

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

Параметры

string

$name

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

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

Команда

Экземпляр 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

Имя команды

KernelInterface getKernel()

Получает ядро, связанное с этой консолью.

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

KernelInterface

Экземпляр KernelInterface