File: Getargs.php

Source Location: /Console_Getargs-1.3.5/Console/Getargs.php

Classes:

Console_Getargs

Command-line arguments parsing class

Console_Getargs_Options

This class implements a wrapper to the command line options and arguments.

Page Details:

Getargs.php

Author: Bertrand Mansion <bmansion@mamasam.com>
Version: 1.3.5
Copyright: 2004 Bertrand Mansion
Link: http://pear.php.net/package/Console_Getargs
License: PHP License 3.0

Includes:

require_once('PEAR.php') [line 32]

CONSOLE_GETARGS_ERROR_CONFIG [line 42]

CONSOLE_GETARGS_ERROR_CONFIG = -1

Wrong configuration

Error Constants This error will be TRIGGERed when a configuration error is found, it will also issue a WARNING.

[ Top ]

CONSOLE_GETARGS_ERROR_USER [line 51]

CONSOLE_GETARGS_ERROR_USER = -2

User made an error

Error Constants This error will be RETURNed when a bad parameter is found in the command line, for example an unknown parameter or a parameter with an invalid number of options.

[ Top ]

CONSOLE_GETARGS_HELP [line 60]

CONSOLE_GETARGS_HELP = -3

Help text wanted

Error Constants This error will be RETURNed when the user asked to see the help by using -h or --help in the command line, you can then print the help ascii art text by using the Console_Getargs::getHelp() method

[ Top ]

CONSOLE_GETARGS_PARAMS [line 70]

CONSOLE_GETARGS_PARAMS = 'parameters'

Option name for application "parameters"

Error Constants Parameters are the options an application needs to function. The two files passed to the diff command would be considered the parameters. These are different from other options in that they do not need an option name passed on the command line.

[ Top ]