jlaso/console-args

A wrapper for the argv global

dev-master 2018-11-14 20:25 UTC

This package is auto-updated.

Last update: 2021-04-15 02:56:28 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

console-args

This is an wrapper for the argv global

The difference between arguments and options are:

  • arguments are strings like --help
  • options are strings like --file=filename
  • other arguments without -- are not recognized because the magic of this wrapper is that doesn't matter the order of the arguments/options

Version

1.0.0

Installation

Add the module by composer.json, adding in require clause:

{
    "jlaso/console-args": "1.0.0"
}

Sample of use

$consoleArgs = new ConsoleArgs($argv, array('help'), array('arg1', 'arg2'));

if($consoleArgs->hasHelp){
    print <<<EOD
        Please, use this arguments to invoke this command:

             --help       \tto see this help
             --arg1=filename \tthe first argument
             --arg2=filename\toptional, the second argument
EOD;
   exit();
}
$arg1 = $consoleArgs->getArg1;
$arg2 = $consoleArgs->getArg2;

License

MIT