This repository has been archived on 2023-08-20. You can view files and clone it, but cannot push or open issues or pull requests.
symfony/src/Symfony/Component/Console
Fabien Potencier 653428af76 Merge branch '2.3' into 2.7
* 2.3:
  fixed CS
  fixed CS
  documented the $url parameter better
  register commands from kernel when accessing list
  Update FileSystem
2016-02-18 17:03:55 +01:00
..
Command Merge branch '2.3' into 2.7 2016-02-16 07:07:10 +01:00
Descriptor Merge branch '2.3' into 2.7 2016-01-03 16:32:00 +01:00
Event fixes CS 2015-08-24 09:13:45 +02:00
Formatter Merge branch '2.3' into 2.7 2015-09-29 14:06:14 +02:00
Helper Fix max width for multibyte keys in choice question 2016-01-14 09:06:07 +01:00
Input Merge branch '2.3' into 2.7 2016-02-16 07:07:10 +01:00
Logger fixes CS 2015-08-24 09:13:45 +02:00
Output Merge branch '2.3' into 2.7 2016-01-12 18:44:11 +01:00
Question The exception should be thrown if an object doesn't implement Traversable AND doesn't implement Countable, not when it doesn't implement Traversable but DOES implement Countable 2016-02-17 07:12:58 +01:00
Resources/bin Move hiddeninput.exe to Resources/bin 2012-10-16 11:08:11 +02:00
Style Fix bug in windows detection 2015-11-18 10:54:26 +01:00
Tester Fix currently broken tests 2015-04-04 14:23:36 +02:00
Tests [Console] Add missing @require annotation in test 2016-02-02 10:46:12 +01:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
Application.php Merge branch '2.3' into 2.7 2016-02-18 17:03:55 +01:00
CHANGELOG.md Merge branch '2.5' 2014-08-05 11:07:51 +02:00
composer.json Merge branch '2.3' into 2.7 2015-10-30 13:10:21 -07:00
ConsoleEvents.php Add machine readable events 2014-11-16 18:21:02 +01:00
LICENSE Update copyright year 2016-01-01 23:53:47 -03:00
phpunit.xml.dist Add missing exclusions from phpunit.xml.dist 2015-11-18 09:19:46 +01:00
README.md link to https://symfony.com where possible 2015-05-01 16:06:45 +02:00
Shell.php Merge branch '2.3' into 2.7 2015-12-28 14:11:03 +01:00

Console Component

Console eases the creation of beautiful and testable command line interfaces.

The Application object manages the CLI application:

use Symfony\Component\Console\Application;

$console = new Application();
$console->run();

The run() method parses the arguments and options passed on the command line and executes the right command.

Registering a new command can easily be done via the register() method, which returns a Command instance:

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
    ->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));
    })
;

You can also register new commands via classes.

The component provides a lot of features like output coloring, input and output abstractions (so that you can easily unit-test your commands), validation, automatic help messages, ...

Tests

You can run the unit tests with the following command:

$ cd path/to/Symfony/Component/Console/
$ composer install
$ phpunit

Third Party

Resources/bin/hiddeninput.exe is a third party binary provided within this component. Find sources and license at https://github.com/Seldaek/hidden-input.

Resources

The Console Component

How to create a Console Command