PHP Classes

File: README.md

Recommend this page to a friend!
  Classes of Joseluis Laso  >  PHP Get Console Arguments  >  README.md  >  Download  
File: README.md
Role: Documentation
Content type: text/markdown
Description: Documentation
Class: PHP Get Console Arguments
Read and parse arguments for command line scripts
Author: By
Last change: Update README.md
Date: 7 months ago
Size: 1,518 bytes
 

Contents

Class file image Download

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

For more information send a message to info at phpclasses dot org.