Class parameter

Description

A parameter class to contain setting parameter information. Every parameter has an idetifying name, and a type. The value of a parameter can be an array of name=>value pairs, or a scalar type such as a string, integer or boolean.

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


	
			
Variable Summary
 mixed $name
 mixed $type
 mixed $value
Method Summary
 parameter parameter (string $name, string $type)
 void getvalue ([string $ename = ""])
 mixed get_decodedvalue ()
 void htmldump ()
 void setvalue (mixed $value, [string $ename = ""])
Variables
mixed $name = "" (line 42)

Parameter name

mixed $type = "" (line 44)

Parameter type

mixed $value = "" (line 46)

Parameter value

Methods
Constructor parameter (line 53)

Make a new parameter.

parameter parameter (string $name, string $type)
  • string $name: Name of this parameter
  • string $type: Parameter type eg: 'array', 'string' etc.
getvalue (line 84)

Get the parameter value. If the element name is given (for an array type parameter) then we return the value of that element.

void getvalue ([string $ename = ""])
  • string $ename: Name of this value (arrayed parameters only)
get_decodedvalue (line 98)

Return decoded value (or array of values) so that applications can use the data unencumbered with URL encoding etc.

  • return: Value or array of values which have been urldecoded
mixed get_decodedvalue ()
htmldump (line 118)

Dump this parameter

void htmldump ()
setvalue (line 67)

Set the parameter to given value. If the parameter has an array of values, the name is also given.

void setvalue (mixed $value, [string $ename = ""])
  • mixed $value: Value to assign to this parameter
  • string $ename: Name of this value (arrayed parameters only)

Documentation generated by phpDocumentor 1.3.0RC3