Приложение

__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

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

Исключения

NamespaceNotFoundException

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

Команда 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, OutputInterface $output)

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

Параметры

Исключение	$e
OutputInterface	$output

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

Параметры

Исключение	$e
OutputInterface	$output

protected configureIO(InputInterface $input, OutputInterface $output)

Настраивает экземпляры входных и выходных данных на основе аргументов и параметров пользователя.

Параметры

InputInterface	$input
OutputInterface	$output

protected int doRunCommand(Команда $command, InputInterface $input, OutputInterface $output)

Выполняет текущую команду.

Если обработчик событий был подключен к приложению, события также отправляются в течение жизненного цикла команды.

Параметры

Команда	$command
InputInterface	$input
OutputInterface	$output

Значение, возвращаемое методом

int	0, если все прошло хорошо, или код ошибки

protected string getCommandName(InputInterface $input)

Получает имя команды на основе входных данных.

Параметры

InputInterface

$input

Значение, возвращаемое методом

string

Имя команды

protected InputDefinition getDefaultInputDefinition()

Получает определение входных данных по умолчанию.

Значение, возвращаемое методом

InputDefinition

Экземпляр InputDefinition

protected Команда[] getDefaultCommands()

Получает команды по умолчанию, которые всегда должны быть доступны.

Значение, возвращаемое методом

Команда[]

Массив экземпляров команд по умолчанию

protected HelperSet getDefaultHelperSet()

Получает набор помощников по умолчанию с помощниками, которые всегда должны быть доступны.

Значение, возвращаемое методом

HelperSet

Экземпляр HelperSet

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

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

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

Параметры

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

Значение, возвращаемое методом

string

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

Приложение setDefaultCommand(string $commandName, bool $isSingleCommand = false)

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

Параметры

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

Значение, возвращаемое методом

Приложение

KernelInterface getKernel()

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

Значение, возвращаемое методом

KernelInterface

Экземпляр KernelInterface

protected registerCommands()