ActionUsage Class Reference

Verify arguments for action function. More...

Inheritance diagram for ActionUsage:

Collaboration diagram for ActionUsage:

Public Member Functions
	__construct (Action &$action)
	getUsage ()
Public Member Functions inherited from ApiUsage
	__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)

Additional Inherited Members
Protected Member Functions inherited from ApiUsage
	getHiddenKeys ()
Protected Attributes inherited from ApiUsage
	$action
	$strict = true

Detailed Description

Verify arguments for action function.

Verify arguments for action function

$usage = new ActionUsage();
$usage->setText("Refresh documents ");
$usage->addNeeded("famid", "the family filter");
$usage->addOption("revision", "use all revision - default is no", array(
"yes",
"no"
));
$usage->addOption("save", "use modify default is light", array(
"complete",
"light",
"none"
));
$usage->verify();

Definition at line 29 of file Class.ActionUsage.php.

Constructor & Destructor Documentation

__construct

(

Action &

$action

)

init current action

Parameters

Action

&$action

current action

Definition at line 36 of file Class.ActionUsage.php.

Here is the call graph for this function:

Member Function Documentation

getUsage

(

)

Definition at line 44 of file Class.ActionUsage.php.

---

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

• Class.ActionUsage.php