class GetOptLong

Gives arguement parsing ability

class attributes [NB. Highlighted attributes are static members]
function GetOptLong() - The class constructor
function set_ordering() - Set the ording requirements of the parameter parsing
function set_options() - Setup the options we want to be able to parse and whether or not they are necessary
function terminated() - Check to see if parsing has completed
function terminate() - Terminate the parsing
function set_error() - Terminate processing and throw an error
function get() - Get the next pair of arguments that are matched

Functions

function GetOptLong Click to go up to the list
The class constructor
Parameters:
    Parameter #1: array a - This array is the array over which arguments will be looked for.

function set_ordering Click to go up to the list
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 Click to go up to the list
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 Click to go up to the list
Check to see if parsing has completed
Declaration:
    function terminate()
Returns:
    boolean

function terminate Click to go up to the list
Terminate the parsing
Declaration:
    function terminate()

function set_error Click to go up to the list
Terminate processing and throw an error
Declaration:
    function set_error( string message )
Parameters:
    Parameter #1: string message - The error message

function get Click to go up to the list
Get the next pair of arguments that are matched
Declaration:
    function get()

Automatically generated at 8:45pm, Wednesday 08 January 2003 by feritedoc.