class GetOptLong
Gives arguement parsing ability
class attributes
[
NB. Highlighted attributes are static members
]
GetOptLong()
- The class constructor
set_ordering()
- Set the ording requirements of the parameter parsing
set_options()
- Setup the options we want to be able to parse and whether or not they are necessary
terminated()
- Check to see if parsing has completed
terminate()
- Terminate the parsing
set_error()
- Terminate processing and throw an error
get()
- Get the next pair of arguments that are matched
Functions
function
GetOptLong
The class constructor
Parameters:
Parameter #1: array
a
- This array is the array over which arguments will be looked for.
function
set_ordering
Set the ording requirements of the parameter parsing
Declaration:
function set_ordering( number ordering )
Parameters:
Parameter #1: number
ordering
- The order the parameters must be in.
function
set_options
Setup the options we want to be able to parse and whether or not they are necessary
Declaration:
function set_options( array arguments )
Parameters:
Parameter #1: array
arguments
- The options.
function
terminated
Check to see if parsing has completed
Declaration:
function terminate()
Returns:
boolean
function
terminate
Terminate the parsing
Declaration:
function terminate()
function
set_error
Terminate processing and throw an error
Declaration:
function set_error( string message )
Parameters:
Parameter #1: string
message
- The error message
function
get
Get the next pair of arguments that are matched
Declaration:
function get()
Automatically generated at
8:45pm, Wednesday 08 January 2003
by
feritedoc
.