Class setting

Description

Application settings class. This class contains one or more parameters.

A setting can also have an 'agent' defined which will action it. This can, for example, be the name of a function, if used.

Located in /application-defs.php (line 150)


	
			
Variable Summary
 mixed $agent
 mixed $name
 mixed $parameters
Method Summary
 setting setting ([mixed $name = ""], [mixed $agent = ""])
 void addparameter (string $pname, object $parm)
 void delparameter (string $pname)
 void getparameter (string $pname, [string $ename = ""])
 void htmldump ()
 void newparameter (string $pname, mixed $value, string $type, [string $ename = ""])
 void setparameter (string $pname, mixed $value, [string $ename = ""], [string $type = ""])
Variables
mixed $agent = "" (line 154)

Agent which will action this setting

mixed $name = "" (line 152)

Name of this setting

mixed $parameters = array() (line 156)
Methods
Constructor setting (line 159)

Make a new setting

setting setting ([mixed $name = ""], [mixed $agent = ""])
addparameter (line 169)

Add the given parameter to this setting.

void addparameter (string $pname, object $parm)
  • string $pname: Name of the parameter to add
  • object $parm: Parameter object to add to this setting
delparameter (line 177)

Delete the given parameter from this setting.

void delparameter (string $pname)
  • string $pname: Name of the parameter to remove
getparameter (line 219)

Get the value of a named parameter.

void getparameter (string $pname, [string $ename = ""])
  • string $pname: Name of the parameter to get value of
  • string $ename: Name of element (arrayed parameters only)
htmldump (line 229)

Dump setting

void htmldump ()
newparameter (line 191)

Add a new parameter to this setting, with given value and type. For arrays we also specify the name of the array value.

void newparameter (string $pname, mixed $value, string $type, [string $ename = ""])
  • string $pname: Name of the new parameter to add
  • mixed $value: Value to assign to this parameter
  • string $type: Parameter type eg: 'array', 'string' etc.
  • string $ename: Name of this value (arrayed parameters only)
setparameter (line 205)

Set the value of a parameter which already exists in this setting.

void setparameter (string $pname, mixed $value, [string $ename = ""], [string $type = ""])
  • string $pname: Name of the parameter to set value of
  • mixed $value: Value to set in the parameter
  • string $ename: Name of this value (arrayed parameters only)
  • string $type: If supplied will auto-create missing parameter

Documentation generated by phpDocumentor 1.3.0RC3