Приложение

__construct(KernelInterface $kernel)

Конструктор.

Параметры

KernelInterface

$kernel

Экземпляр KernelInterface

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

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

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

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

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)

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

Parameters

string

$namespace

Namespace или сокращение для поиска

Return Value

string

Зарегистрированный namespace

Exceptions

CommandNotFoundException

Если namespace неверный или неоднозначный

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

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

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

Parameters

string

$name

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

Return Value

Команда

Экземпляр Command

Exceptions

CommandNotFoundException

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

Command[] all(string $namespace = null)

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

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

Parameters

string

$namespace

Имя namespace

Return Value

Command[]

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

static array getAbbreviations(array $names)

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

Parameters

array

$names

Массив имен

Return Value

array

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

renderException(Исключение $e, OutputInterface $output)

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

Parameters

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

array getTerminalDimensions()

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

Return Value

array

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

Приложение setTerminalDimensions(int $width, int $height)

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

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

Parameters

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

Return Value

Приложение

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

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

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

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

Parameters

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

Return Value

string

Namespace команды

setDefaultCommand(string $commandName)

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

Parameters

string

$commandName

Имя Command

KernelInterface getKernel()

Получает Kernel, связанный с этим Console.

Return Value

KernelInterface

Экземпляр KernelInterface