Class mosParameters

Description

Parameters handler

Located in /includes/mamboxml.php (line 17)


	
			
Variable Summary
object $_params
string $_path
string $_raw
string $_type
object The $_xmlElem
Method Summary
mosParameters mosParameters (string $text, [string $path = ''], [mixed $type = 'component'])
string def (string $key, [string $value = ''])
string get (string $key, [mixed $default = ''])
object parse (mixed $txt, [boolean $process_sections = false])
string render ([string $name = 'params'])
array renderParam (object A &$param, [string $control_name = 'params'])
string set (string $key, [string $value = ''])
void textareaHandling (mixed &$txt)
string _form_imagelist (string $name, string $value, object The &$node, string $control_name)
string _form_list (string $name, string $value, object The &$node, string $control_name)
string _form_mos_category (string $name, string $value, object The &$node, string $control_name)
string _form_mos_menu (string $name, string $value, object The &$node, string $control_name)
string _form_mos_section (string $name, string $value, object The &$node, string $control_name)
string _form_radio (string $name, string $value, object The &$node, string $control_name)
string _form_spacer (string $name, string $value, object The &$node, string $control_name)
string _form_text (string $name, string $value, object The &$node, string $control_name)
string _form_textarea (string $name, string $value, object The &$node, string $control_name)
Variables
object $_params = null (line 19)
string $_path = null (line 23)
  • var: Path to the xml setup file
string $_raw = null (line 21)
  • var: The raw params string
string $_type = null (line 25)
  • var: The type of setup file
object The $_xmlElem = null (line 27)
  • var: xml params element
Methods
Constructor mosParameters (line 34)

Constructor

  • var: The type of setup file
mosParameters mosParameters (string $text, [string $path = ''], [mixed $type = 'component'])
  • string $text: The raw parms text
  • string $path: Path to the xml setup file
def (line 55)

Sets a default value if not alreay assigned

  • return: The set value
string def (string $key, [string $value = ''])
  • string $key: The name of the param
  • string $value: The value of the parameter
get (line 63)
string get (string $key, [mixed $default = ''])
  • string $key: The name of the param
  • mixed $default: The default value if not found
parse (line 76)

Parse an .ini string, based on phpDocumentor phpDocumentor_parse_ini_file function

object parse (mixed $txt, [boolean $process_sections = false])
  • mixed $txt: The ini string or array of lines
  • boolean $process_sections: add an associative index for each section [in brackets]
render (line 158)
  • return: HTML
string render ([string $name = 'params'])
  • string $name: The name of the control, or the default text area if a setup file is not found
renderParam (line 218)
  • return: Any array of the label, the form element and the tooltip
array renderParam (object A &$param, [string $control_name = 'params'])
  • object A &$param: param tag node
  • string $control_name: The control name
set (line 45)
  • return: The set value
string set (string $key, [string $value = ''])
  • string $key: The name of the param
  • string $value: The value of the parameter
textareaHandling (line 422)

special handling for textarea param

void textareaHandling (mixed &$txt)
_form_imagelist (line 367)
  • return: The html for the element
string _form_imagelist (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_list (line 269)
  • return: The html for the element
string _form_list (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_mos_category (line 326)
  • return: The html for the element
string _form_mos_category (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_mos_menu (line 348)
  • return: The html for the element
string _form_mos_menu (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_mos_section (line 305)
  • return: The html for the element
string _form_mos_section (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_radio (line 288)
  • return: The html for the element
string _form_radio (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_spacer (line 411)
  • return: The html for the element
string _form_spacer (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_text (line 257)
  • return: The html for the element
string _form_text (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name
_form_textarea (line 395)
  • return: The html for the element
string _form_textarea (string $name, string $value, object The &$node, string $control_name)
  • string $name: The name of the form element
  • string $value: The value of the element
  • object The &$node: xml element for the parameter
  • string $control_name: The control name

Documentation generated on Fri, 4 Mar 2005 13:56:38 +1000 by phpDocumentor 1.3.0RC3