Приложение

__construct(KernelInterface $kernel)

Параметры

KernelInterface

$kernel

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

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

Исключения

CommandNotFoundException

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

Command find(string $name)

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

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

Параметры

string

$name

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

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

Command

Экземпляр Command

Исключения

CommandNotFoundException

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

Command[] all(string $namespace = null)

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

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

Параметры

string

$namespace

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

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

Command[]

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

static array getAbbreviations(array $names)

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

Параметры

array

$names

Массив имён

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

array

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

renderException(Exception $e, OutputInterface $output)

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

Параметры

Exception	$e
OutputInterface	$output

array getTerminalDimensions() ^{устаревший}

^{устаревший}

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

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

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

array

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

$this setTerminalDimensions(int $width, int $height) ^{устаревший}

^{устаревший}

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

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

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

Параметры

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

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

$this

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

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

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

Параметры

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

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

string

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

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

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

Параметры

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

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

Application

KernelInterface getKernel()

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

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

KernelInterface

Экземпляр KernelInterface