class GetOptLong

Gives arguement parsing ability

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

Functions

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

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

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 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 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 terminate Click to go up to the list
Terminate the parsing
Declaration:
    function terminate()

function terminated Click to go up to the list
Check to see if parsing has completed
Declaration:
    function terminate()
Returns:
     boolean

Automatically generated at 12:07PM, Wednesday 25 May 2005 by feritedoc.