Docs For Class mosParameters

Description

Parameters handler

Located in /includes/core.classes.php (line 2828)

Direct descendents

Class	Description
mosAdminParameters	Parameters handler

Variable Summary

object $_params

string $_raw

Method Summary

mosParameters mosParameters (string $text, [string $process_sections = false])

string def (string $key, [string $value = ''])

string get (string $key, [mixed $default = ''])

void getBracketed ( $text, $opener, $closer)

string getParams ()

object parse (mixed $txt, [boolean $process_sections = false])

string render ([string $name = 'params'])

string set (string $key, [string $value = ''])

void textareaHandling ( &$txt)

Variables

object $_params = null (line 2830)

string $_raw = null (line 2832)

var: The raw params string

Methods

Constructor mosParameters (line 2839)

Constructor

var: The type of setup file

mosParameters mosParameters (string $text, [string $process_sections = false])

string $text: The raw parms text
string $process_sections: Path to the xml setup file

def (line 2865)

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 2873)

string get (string $key, [mixed $default = ''])

string $key: The name of the param
mixed $default: The default value if not found

getBracketed (line 2882)

Look to see if string is bracketed by opener and closer

If so, extract and trim the bracketed string Otherwise, return a null string

void getBracketed ( $text, $opener, $closer)

$text
$opener
$closer

getParams (line 2847)

Get the result of parsing the string provided on creation

return: parsed result

string getParams ()

parse (line 2892)

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 2933)

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

set (line 2855)

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 2945)

special handling for textarea param

void textareaHandling ( &$txt)

&$txt