How to create a new command in Symfony?
How to create a new command in Symfony?
1 answer
by
darion ,
6 months ago
@aubrey
To create a new command in Symfony, follow these steps:
- Create a new class in the src/Command directory of your Symfony application. The class should extend the SymfonyComponentConsoleCommandCommand class.
- Define the command's name, description, and options in the configure() method of your command class.
- Implement the command's logic in the execute() method of your command class.
- (Optional) Define any helper methods that your command needs to execute its logic.
- Register the command in the src/Kernel.php file by adding it to the registerCommands() method.
Here's an example of what your command class might look like:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
namespace AppCommand; use SymfonyComponentConsoleCommandCommand; use SymfonyComponentConsoleInputInputInterface; use SymfonyComponentConsoleOutputOutputInterface; class MyCommand extends Command { protected static $defaultName = 'my:command'; protected function configure() { $this->setDescription('Description of my command') ->setHelp('Help text for my command') ->addOption('foo', null, InputOption::VALUE_REQUIRED, 'Value for foo option') ->addOption('bar', null, InputOption::VALUE_NONE, 'Enable bar option'); } protected function execute(InputInterface $input, OutputInterface $output) { $fooValue = $input->getOption('foo'); $barEnabled = $input->getOption('bar'); // Command logic goes here... $output->writeln('My command executed successfully!'); } // Optional helper methods go here... } |
Once you've created your command class, you can run it from the command line using the Symfony console:
1
|
$ php bin/console my:command --foo=value --bar
|
This will execute the MyCommand class with the --foo=value and --bar options.