Outils en ligne de commande : Symfony/Console
La prochaine fois que vous lancerez composer require ou php artisan migrate, vous utiliserez le composant Console de Symfony. Composer et lâArtisan de Laravel sont tous deux construits dessus. Rien de tout cela nâexige le reste de Symfony. Console est un paquet autonome qui transforme une classe PHP en vĂ©ritable outil en ligne de commande, avec arguments, options, sortie en couleur et barres de progression, et rien dâautre attachĂ©.
composer require symfony/console
<?php
// bin/console
require __DIR__.'/../vendor/autoload.php';
use Symfony\Component\Console\Application;
use Symfony\Component\Console\Attribute\AsCommand;
use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
#[AsCommand(name: 'app:import-users', description: 'Import users from a CSV file')]
class ImportUsersCommand extends Command
{
protected function configure(): void
{
$this->addArgument('file', InputArgument::REQUIRED, 'Path to the CSV file');
}
protected function execute(InputInterface $input, OutputInterface $output): int
{
$rows = array_map('str_getcsv', file($input->getArgument('file')));
$output->writeln(sprintf('<info>Imported %d rows.</info>', count($rows)));
return Command::SUCCESS;
}
}
$app = new Application('My Tool', '1.0.0');
$app->add(new ImportUsersCommand());
$app->run();
php bin/console app:import-users users.csv
Quand le choisir
Tout travail que quelquâun lance Ă la main ou depuis une entrĂ©e cron : un import de donnĂ©es, un nettoyage, une Ă©tape de dĂ©ploiement. Il bat un script PHP brut dĂšs quâil vous faut des arguments, des options, ou une sortie quâun humain doit lire et Ă laquelle il doit pouvoir se fier.
Quand ce nâest pas le bon outil
Si le « script » est le dĂ©but dâune application web, ou si vous ĂȘtes dĂ©jĂ dans un projet Laravel ou Symfony, utilisez artisan ou le bin/console de lâapplication. Un second point dâentrĂ©e en ligne de commande Ă cĂŽtĂ© du premier nâaide personne.
Sous le capot : une commande Console est une classe PHP ordinaire avec une méthode
configure()et une mĂ©thodeexecute(). Pas de runtime spĂ©cial, pas de binaire compilĂ©, juste lâinterprĂ©teur PHP que vous avez dĂ©jĂ , pointĂ© vers un script au lieu dâune requĂȘte de navigateur.