ApiUsage Class Reference

Inheritance diagram for ApiUsage:

Collaboration diagram for ApiUsage:

Public Member Functions
	__construct ()
	setText ($text)
	addHidden ($argName, $argDefinition)
	addNeeded ($argName, $argDefinition, array $restriction=null)
	addOption ($argName, $argDefinition, array $restriction=null, $default=null)
	getUsage ()
	exitError ($error= '')
	strict ($strict=true)
	if false additionnal arguments are ignored, default is true
	verify ($useException=false)

Protected Member Functions
	getHiddenKeys ()

Protected Attributes
	$action
	$strict = true

Detailed Description

Definition at line 28 of file Class.ApiUsage.php.

Constructor & Destructor Documentation

__construct

(

)

init action

Definition at line 69 of file Class.ApiUsage.php.

Here is the call graph for this function:

Member Function Documentation

addHidden	(		$argName,
			$argDefinition
	)

add hidden argument (private arg not see them in usage)

Parameters

string	$argName	argument name
string	$argDefinition	argument définition

Returns

argument value

Definition at line 95 of file Class.ApiUsage.php.

addNeeded	(		$argName,
			$argDefinition,
		array	$restriction = null
	)

add needed argument

Parameters

string	$argName	argument name
string	$argDefinition	argument définition
array	$restriction	optionnal enumeration for argument

Returns

argument value

Definition at line 112 of file Class.ApiUsage.php.

addOption	(		$argName,
			$argDefinition,
		array	$restriction = null,
			$default = null
	)

add optionnal argument

Parameters

string	$argName	argument name
string	$argDefinition	argument définition
array	$restriction	optionnal enumeration for argument
string	$default	default value if no value set

Returns

argument value

Definition at line 131 of file Class.ApiUsage.php.

exitError

(

$error = ''

)

exit when error

Parameters

string

$error

message error

Returns

void

Definition at line 186 of file Class.ApiUsage.php.

Here is the call graph for this function:

getHiddenKeys ( )

protected

list hidden keys

Returns

array

Definition at line 203 of file Class.ApiUsage.php.

getUsage

(

)

return usage text for the action

Returns

string

Definition at line 169 of file Class.ApiUsage.php.

setText

(

$text

)

add textual definition of program

Parameters

string

$text

usage text

Returns

void

Definition at line 83 of file Class.ApiUsage.php.

strict

(

$strict = true

)

if false additionnal arguments are ignored, default is true

set strict mode

Parameters

boolean

$strict

strict mode

Returns

void

Definition at line 219 of file Class.ApiUsage.php.

verify

(

$useException = false

)

verify if wsh program argument are valids. If not wsh exit

Parameters

boolean

$useExcepion

if true throw ApiUsageException when verify is not successful

Returns

void

Definition at line 230 of file Class.ApiUsage.php.

Here is the call graph for this function:

Field Documentation

$action

protected

Definition at line 59 of file Class.ApiUsage.php.

$strict = true

protected

Definition at line 65 of file Class.ApiUsage.php.

---

The documentation for this class was generated from the following file:

• Class.ApiUsage.php