Приложение

__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

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

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 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

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

Команда 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	Экземпляр OutputInterface

array getTerminalDimensions()

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

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

array

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

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

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

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

Параметры

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

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

Приложение

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

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

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

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

Параметры

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

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

string

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

setDefaultCommand(string $commandName)

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

Параметры

string

$commandName

Имя Command

ИнтерфейсЯдра getKernel()

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

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

ИнтерфейсЯдра

Экземпляр KernelInterface