CWIS Developer Documentation
|
Class supplying a standard user interface for viewing and setting configuration parameters. More...
Public Member Functions | |
__construct ($CfgParams, $CfgValues, $UniqueKey=NULL) | |
Class constructor. More... | |
DisplaySettingsTable ($TableId=NULL, $TableStyle=NULL) | |
Display HTML table with settings parameters. More... | |
GetNewSettingsFromForm () | |
Retrieve values set by form. More... | |
SetEventToSignalOnChange ($EventName, $EventParams=array()) | |
Set event to signal when retrieving values from form when settings have changed. More... | |
Class supplying a standard user interface for viewing and setting configuration parameters.
Definition at line 14 of file ConfigSettingsUI.php.
ConfigSettingsUI::__construct | ( | $CfgParams, | |
$CfgValues, | |||
$UniqueKey = NULL |
|||
) |
Class constructor.
array | $CfgParams | Array of arrays of configuration setting parameters. |
array | $CfgValues | Associative array of current values for configuration settings, with setting names for the index. |
string | $UniqueKey | Unique string to include in form field names to distinguish them from other fields in the form. (OPTIONAL) |
Definition at line 27 of file ConfigSettingsUI.php.
ConfigSettingsUI::DisplaySettingsTable | ( | $TableId = NULL , |
|
$TableStyle = NULL |
|||
) |
Display HTML table with settings parameters.
string | $TableId | CSS ID for table element. (OPTIONAL) |
string | $TableStyle | CSS styles for table element. (OPTIONAL) |
Definition at line 39 of file ConfigSettingsUI.php.
References PHP.
ConfigSettingsUI::GetNewSettingsFromForm | ( | ) |
Retrieve values set by form.
Definition at line 109 of file ConfigSettingsUI.php.
ConfigSettingsUI::SetEventToSignalOnChange | ( | $EventName, | |
$EventParams = array() |
|||
) |
Set event to signal when retrieving values from form when settings have changed.
If the supplied event parameters include parameter names (indexes) of "SettingName", "OldValue", or "NewValue", the parameter value will be replaced with an appropriate value before the event is signaled.
string | $EventName | Name of event to signal. |
array | $EventParams | Array of event parameters, with CamelCase parameter names for index. (OPTIONAL) |
Definition at line 237 of file ConfigSettingsUI.php.