Class: Console_CommandLine

Example:

 $parser = new Console_CommandLine(array(

     'name'               => 'yourprogram', // defaults to argv[0]
     'description'        => 'Description of your program',
     'version'            => '0.0.1', // your program version
     'add_help_option'    => true, // or false to disable --help option
     'add_version_option' => true, // or false to disable --version option
     'force_posix'        => false // or true to force posix compliance
 ));

Overridden in child classes as:

Console_CommandLine_Command::__construct()

Constructor.

Parameters:

• a custom renderer,
• a custom outputter,
• or a custom message provider

Parameters:

Adds an argument with the name $name and set its attributes with the array $params, then return the Console_CommandLine_Argument instance created. The method accepts another form: you can directly pass a Console_CommandLine_Argument object as the sole argument, this allows you to contruct the argument separately, in order to reuse it in different command line parsers or commands for example.

Example:

 $parser = new Console_CommandLine();

 // add an array argument
 $parser->addArgument('input_files', array('multiple'=>true));
 // add a simple argument
 $parser->addArgument('output_file');
 $result = $parser->parse();
 print_r($result->args['input_files']);
 print_r($result->args['output_file']);
 // will print:
 // array('file1', 'file2')
 // 'file3'
 // if the command line was:
 // myscript.php file1 file2 file3

In a terminal, the help will be displayed like this:

 $ myscript.php install -h

 Usage: myscript.php <input_files...> <output_file>

Parameters:

Adds a command with the given $name to the parser and returns the Console_CommandLine_Command instance, you can then populate the command with options, configure it, etc... like you would do for the main parser because the class Console_CommandLine_Command inherits from Console_CommandLine.

An example:

 $parser = new Console_CommandLine();

 $install_cmd = $parser->addCommand('install');
 $install_cmd->addOption(
     'verbose',
     array(
         'short_name'  => '-v',
         'long_name'   => '--verbose',
         'description' => 'be noisy when installing stuff',
         'action'      => 'StoreTrue'
      )
 );
 $parser->parse();

 $ myscript.php install -h
 Usage: myscript.php install [options]
 
 Options:
   -h, --help     display this help message and exit
   -v, --verbose  be noisy when installing stuff
 
 $ myscript.php install --verbose
 Installing whatever...
 $

Parameters:

Adds an option with the name $name and set its attributes with the array $params, then return the Console_CommandLine_Option instance created. The method accepts another form: you can directly pass a Console_CommandLine_Option object as the sole argument, this allows you to contruct the option separately, in order to reuse it in different command line parsers or commands for example.

Example:

 $parser = new Console_CommandLine();

 $parser->addOption('path', array(
     'short_name'  => '-p',  // a short name
     'long_name'   => '--path', // a long name
     'description' => 'path to the dir', // a description msg
     'action'      => 'StoreString',
     'default'     => '/tmp' // a default value
 ));
 $parser->parse();

In a terminal, the help will be displayed like this:

 $ myscript.php --help

 Usage: myscript.php [options]
 
 Options:
   -h, --help  display this help message and exit
   -p, --path  path to the dir

Various methods to specify an option, these 3 commands are equivalent:

 $ myscript.php --path=some/path

 $ myscript.php -p some/path
 $ myscript.php -psome/path

Parameters:

Parameters:

Parameters:

Parameters:

Parameters:

Example:

 require_once 'Console/CommandLine.php';

 $parser = Console_CommandLine::fromXmlFile('path/to/file.xml');
 $result = $parser->parse();

Parameters:

Example:

 require_once 'Console/CommandLine.php';

 $xmldata = '<?xml version="1.0" encoding="utf-8" standalone="yes"?>
 <command>
   <description>Compress files</description>
   <option name="quiet">
     <short_name>-q</short_name>
     <long_name>--quiet</long_name>
     <description>be quiet when run</description>
     <action>StoreTrue/action>
   </option>
   <argument name="files">
     <description>a list of files</description>
     <multiple>true</multiple>
   </argument>
 </command>';
 $parser = Console_CommandLine::fromXmlString($xmldata);
 $result = $parser->parse();

Parameters:

Parameters:

Parameters:

 // in this example we create a "range" action:

 // the user will be able to enter something like:
 // $ <program> -r 1,5
 // and in the result we will have:
 // $result->options['range']: array(1, 5)
 
 require_once 'Console/CommandLine.php';
 require_once 'Console/CommandLine/Action.php';
 
 class ActionRange extends Console_CommandLine_Action
 {
     public function execute($value=false, $params=array())
     {
         $range = explode(',', str_replace(' ', '', $value));
         if (count($range) != 2) {
             throw new Exception(sprintf(
                 'Option "%s" must be 2 integers separated by a comma',
                 $this->option->name
             ));
         }
         $this->setResult($range);
     }
 }
 // then we can register our action
 Console_CommandLine::registerAction('Range', 'ActionRange');
 // and now our action is available !
 $parser = new Console_CommandLine();
 $parser->addOption('range', array(
     'short_name'  => '-r',
     'long_name'   => '--range',
     'action'      => 'Range', // note our custom action
     'description' => 'A range of two integers separated by a comma'
 ));
 // etc...

Parameters:

Parameters: