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
Nicolas Grekas 4d275b42da Merge branch '2.7' into 2.8
* 2.7:
  [Finder] Fix recursive filter iterator
  Improve the structure of the Finder testsuite
  [VarDumper] Fix HtmlDumper constructor calling CliDumper's
  [Finder] Handle filtering of recursive iterators and use it to skip looping over excluded directories
  Exclude files based on path before applying the sorting
  fixed composer.json
  [Console] fix phpdoc of DialogHelper
  Allowed extensions to inline compiler passes
2015-09-18 09:20:16 +02:00
..
Command Merge branch '2.7' into 2.8 2015-09-03 13:42:45 +02:00
Descriptor [appveyor] PHP 5.3.11 for Symfony 2.7 2015-08-31 18:44:53 +02:00
Event fixes CS 2015-08-24 09:13:45 +02:00
Formatter Merge branch '2.3' into 2.6 2015-07-09 18:02:48 +02:00
Helper Merge branch '2.7' into 2.8 2015-09-18 09:20:16 +02:00
Input Merge branch '2.3' into 2.7 2015-07-28 16:07:07 +02:00
Logger fixes CS 2015-08-24 09:13:45 +02:00
Output Merge branch '2.7' into 2.8 2015-09-14 16:15:17 +02:00
Question fixes CS 2015-08-24 09:13:45 +02:00
Resources/bin Move hiddeninput.exe to Resources/bin 2012-10-16 11:08:11 +02:00
Style fixes CS 2015-08-24 09:13:45 +02:00
Tester Fix currently broken tests 2015-04-04 14:23:36 +02:00
Tests Convert Output::write's type to an options arg where verbosity can be passed in as well 2015-09-12 23:35:49 +01:00
.gitignore Added missing files .gitignore 2013-07-21 14:12:18 +02:00
Application.php Make the exception output visible even in quiet mode, fixes #15680 2015-09-12 23:39:36 +01:00
CHANGELOG.md [Console] Use readline for user input when available 2015-08-01 11:46:56 +02:00
composer.json Merge branch '2.7' into 2.8 2015-05-12 17:16:46 +02:00
ConsoleEvents.php Add machine readable events 2014-11-16 18:21:02 +01:00
LICENSE Updated copyright to 2015 2015-01-01 13:56:52 +01:00
phpunit.xml.dist [2.3] require-dev PHPUnit bridge 2015-02-24 11:24:26 +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.6 2015-06-18 14:58:06 +02: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