2f3692aca7
* 2.3: Minor hot fix [PROCESS] make sure /dev/tty is readable [2.3] require-dev PHPUnit bridge [FrameworkBundle] Fixed Shell logo [2.3] Update CONTRIBUTING.md [2.3][Process] Fixed PhpProcess::getCommandLine() result [Console] explicit assertion for ArgvInput::getFirstArgument() with no arguments Enforce UTF-8 charset for core controllers Conflicts: CONTRIBUTING.md src/Symfony/Bridge/Monolog/composer.json src/Symfony/Bundle/FrameworkBundle/composer.json src/Symfony/Bundle/SecurityBundle/composer.json src/Symfony/Bundle/TwigBundle/Controller/ExceptionController.php src/Symfony/Bundle/WebProfilerBundle/Controller/ProfilerController.php src/Symfony/Component/Console/composer.json src/Symfony/Component/Debug/composer.json src/Symfony/Component/DomCrawler/composer.json src/Symfony/Component/EventDispatcher/composer.json src/Symfony/Component/HttpFoundation/composer.json src/Symfony/Component/Security/composer.json src/Symfony/Component/Templating/composer.json |
||
---|---|---|
.. | ||
Command | ||
Descriptor | ||
Event | ||
Formatter | ||
Helper | ||
Input | ||
Logger | ||
Output | ||
Question | ||
Resources/bin | ||
Tester | ||
Tests | ||
.gitignore | ||
Application.php | ||
CHANGELOG.md | ||
composer.json | ||
ConsoleEvents.php | ||
LICENSE | ||
phpunit.xml.dist | ||
README.md | ||
Shell.php |
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.