Last Updated | | Ratings | | Unique User Downloads | | Download Rankings |
2023-05-23 (3 days ago)  | | Not enough user ratings | | Total: 245 This week: 2 | | All time: 7,950 This week: 258 |
|
Description | | Author |
This class can read and parse arguments for command line scripts.
It takes an array with the command line arguments passed from the console and parses them according to the definition of expected arguments passed as another array.
The class supports boolean options that are enabled by the presence of argument like --help, and string options that have associated values like --file=filename. other values that do not start with -- are ignored.
The class returns argument values using getter functions. | |
 |
|
Innovation award
 Nominee: 6x
Winner: 2x |
|
Details

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
|
Applications that use this package |
|
No pages of applications that use this class were specified.
If you know an application of this package, send a message to the author to add a link here.