[2.2][Console] command's name required when added to an application #4104

brikou · 2012-04-25T09:11:05Z

Bug fix: no
Feature addition: yes
Backwards compatibility break: no
Symfony2 tests pass: yes
Fixes the following tickets: [2.2][Console] default command #3857
Todo: -

Here is an application with a single purpose/command : listing a directory as seen here

<?php
// console.php
// usage: php console.php ls <dir>

require_once __DIR__.'/../../../../../vendor/autoload.php';

use Symfony\Component\Console\Application;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\OutputInterface;

$console = new Application();
$console
    ->register('ls')
    ->setDefinition(array(
        new InputArgument('dir', InputArgument::REQUIRED, 'Directory name'),
    ))
    ->setDescription('Displays the files in the given directory')
    ->setCode(function (InputInterface $input, OutputInterface $output) {
        $dir = $input->getArgument('dir');

        $output->writeln(sprintf('Dir listing for <info>%s</info>', $dir));
    })
;
$console->run();

This simple command can be refactored into this...

<?php
// ls.php
// usage: php ls.php <dir>

require_once __DIR__.'/../../../../../vendor/autoload.php';

use Symfony\Component\Console\Command\Command;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Output\ConsoleOutput;

$command = new Command("ANameAsItIsMandatory");
$command
    ->setDefinition(array(
        new InputArgument('dir', InputArgument::REQUIRED, 'Directory name'),
    ))
    ->setDescription('Displays the files in the given directory')
    ->setCode(function (InputInterface $input, OutputInterface $output) {
        $dir = $input->getArgument('dir');

        $output->writeln(sprintf('Dir listing for <info>%s</info>', $dir));
    })
;

$command->run(new ArgvInput(), new ConsoleOutput());

The conceptual problem is that command's name is required even if not needed/used.
This PR makes the name required only when this command is attached to an application.

stof · 2012-10-13T16:44:02Z

@brikou The issue if you run the command directly instead of using an application is that you loose some features:

you have to reimplement the display of the help of the command whereas the application provides the --help option;
you have to reimplement the handling of exceptions yourself;
you have to reimplement the option used to control the interactivity, color support and verbosity of the console as the application is responsible to handle them.

A better way to achieve single-command applications can be found in symfony/symfony-docs#1810 (not merged yet so not yet in the online doc)

stof · 2012-10-13T16:45:15Z

@fabpot what do you think about it ? should we still merge it or close it ?

fabpot · 2012-10-14T09:31:56Z

fabpot commented

Oct 14, 2012

Closing it in favor of the doc update.

command's name mandatory only if linked to an application

523d888

fabpot closed this Oct 14, 2012

soxofaan mentioned this pull request Nov 23, 2013

[Console Component] Make creating single command app easier #9564

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

[2.2][Console] command's name required when added to an application #4104

[2.2][Console] command's name required when added to an application #4104

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

[2.2][Console] command's name required when added to an application #4104

[2.2][Console] command's name required when added to an application #4104

Uh oh!

Conversation

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!