PluginParameters Class Reference

List of all members.

---

Detailed Description

Helper class, plugin parameter container, an array of key equals value pairs.

Public Member Functions
	add ($aName, $aValue)
	Add an entry.
	get ($aName)
	Query the value for a key.
	has ($aName)
	Query if a key exists.
	keys ()
	Query a list of all keys in this array.
	PluginParameters ()
	Constructor.
Public Attributes
	$parameters

---

Constructor & Destructor Documentation

PluginParameters.PluginParameters (   )

Constructor.

---

Member Function Documentation

PluginParameters.add (  $  aName, $  aValue )

Add an entry. Parameters: $aName  [i] String, name of the key $aValue  [i] Mixed, the assigned value

PluginParameters.get (  $  aName  )

Query the value for a key. Parameters: $aName  [i] String, name of the key Returns: Mixed, the asssociated value, or FALSE if the key iss not defined

PluginParameters.has (  $  aName  )

Query if a key exists. Parameters: $aName  [i] String, name of the key Returns: boolean, true: the key exists, false: the key does not exist

PluginParameters.keys (   )

Query a list of all keys in this array. Returns: array, a list of all keys

---

Member Data Documentation

PluginParameters.$parameters

---

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

• signware_bapi.php