Приложение

__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

При неудачном выполнении. Пропустить это, если {@link setCatchExceptions()}.

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)

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

Parameters

string

$namespace

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

Return Value

string

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

Exceptions

CommandNotFoundException

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

Command find(string $name)

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

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

Parameters

string

$name

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

Return Value

Command

Экземпляр Command

Exceptions

CommandNotFoundException

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

Command[] all(string $namespace = null)

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

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

Parameters

string

$namespace

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

Return Value

Command[]

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

static array getAbbreviations(array $names)

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

Parameters

array

$names

Массив имён

Return Value

array

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

renderException(Exception $e, OutputInterface $output)

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

Parameters

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

array getTerminalDimensions() ^{устарело}

^{устарело}

since версия 3.2, будет удалено в 4.0. Создайте вместо этого экземпляр Terminal.

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

Return Value

array

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

$this setTerminalDimensions(int $width, int $height) ^{устарело}

^{устарело}

since версия 3.2, будет удалено в 4.0. Вместо этого установите переменные среды COLUMNS и LINES.

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

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

Parameters

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

Return Value

$this

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

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

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

Parameters

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

Return Value

string

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

Application setDefaultCommand(string $commandName, bool $isSingleCommand = false)

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

Parameters

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

Return Value

Application

KernelInterface getKernel()

Возвращает ядро, связанное с этой консолью.

Return Value

KernelInterface

Экземпляр KernelInterface