Blame view

sources/3rdparty/symfony/console/Symfony/Component/Console/README.md 1.92 KB
31b7f2792   Kload   Upgrade to ownclo...
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
  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.phar install --dev
      $ 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](http://symfony.com/doc/current/components/console.html)
  
  [How to create a Console Command](http://symfony.com/doc/current/cookbook/console/console_command.html)