Метод configure

Метод configure вызывается автоматически при создании консольной команды. Внутри него через методы setName, setDescription, addArgument и addOption задаются имя команды, её описание, аргументы и опции. Метод не принимает параметров и не возвращает значения.

Синтаксис

protected function configure(): void
{
}

Пример

Давайте создадим команду с именем 'app:greet' и описанием:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	
	class GreetCommand extends Command
	{
		protected function configure(): void
		{
			$this
				->setName('app:greet')
				->setDescription('Greets the user');
		}
	}
?>

Результат выполнения команды:

php bin/console app:greet

Пример

Давайте добавим обязательный аргумент name и опцию upper:

<?php
	namespace AppCommand;
	
	use SymfonyComponentConsoleCommandCommand;
	use SymfonyComponentConsoleInputInputArgument;
	use SymfonyComponentConsoleInputInputOption;
	
	class GreetCommand extends Command
	{
		protected function configure(): void
		{
			$this
				->setName('app:greet')
				->setDescription('Greets the user')
				->addArgument('name', InputArgument::REQUIRED, 'The user name')
				->addOption('upper', null, InputOption::VALUE_NONE, 'Uppercase the name');
		}
	}
?>

Результат выполнения команды для адреса php bin/console app:greet user:

Greets the user

Смотрите также

класс Command,
который является базой для консольных команд
метод execute,
который выполняет логику команды
метод addArgument,
который добавляет аргумент команды
метод addOption,
который добавляет опцию команды