CSWidgetPreferences
in package
This property describes the CSWidgets preferences
Tags
Table of Contents
- __construct() : mixed
- addBoolean() : void
- Add checkbox (true/false) preference
- addColor() : void
- Add color preference
- addHidden() : void
- Add hidden preference
- addHtml() : void
- Add HTML based preference for complex data types
- addIDList() : void
- Add a preference definining an ID List for a given Record
- addIFrameSection() : void
- Add custom widget preference iframe section
- addInt() : void
- Add integer preference
- addInterval() : void
- Add numeric interval preference
- addList() : void
- Add selection preference
- addPanel() : void
- Add custom widget preference panel for all preferences below
- addPanelForEastContent() : mixed
- addPanelForEMail() : mixed
- addPanelForExport() : mixed
- addPanelForFilters() : mixed
- addPanelForLists() : mixed
- addPanelForPlugins() : mixed
- addPanelForWestContent() : mixed
- addPassword() : void
- Add password preference
- addPreference() : void
- Add Widget preference
- addSection() : void
- Add custom widget preference section
- addSeparator() : void
- Add separator to the preference to group preferences
- addText() : void
- Add text preference
- addTextarea() : void
- Add textarea preference
- addViewSeparator() : mixed
- getFromUWAPath() : mixed
- Loads all meta datas from a UWA Path
- getListDefaultValue() : mixed
- getPreference() : mixed
- Retrieve one Widget preference by name
- getPreferences() : array<string|int, mixed>
- Retrieve Widget preferences
- getSections() : array<string|int, mixed>
- Retrieve Sections if defined
- resetPanel() : mixed
- setDefaultPanel() : void
- Adds a default widget preference panel for all preferences below
Methods
__construct()
public
__construct() : mixed
Tags
Return values
mixed —addBoolean()
Add checkbox (true/false) preference
public
addBoolean(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addColor()
Add color preference
public
addColor(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addHidden()
Add hidden preference
public
addHidden(string $name, string $value) : void
Parameters
- $name : string
-
name of preference
- $value : string
-
value of preference
Tags
Return values
void —addHtml()
Add HTML based preference for complex data types
public
addHtml(string $label, string $html[, bool $secured = false ]) : void
Parameters
- $label : string
-
name of preference
- $html : string
-
content of preference
- $secured : bool = false
-
define as secured preference
Tags
Return values
void —addIDList()
Add a preference definining an ID List for a given Record
public
addIDList(string $name, string $mRecord[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, bool $multiple = true ][, bool $onlyFolders = true ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $mRecord : string
-
the class name of Record the ID List should be created for
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $multiple : bool = true
-
whether multiple IDs could be selected
- $onlyFolders : bool = true
-
whether only folders may be selected
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addIFrameSection()
Add custom widget preference iframe section
public
addIFrameSection(string $sTitle, string $sSrc[, string $sHeight = '400px' ]) : void
Parameters
- $sTitle : string
-
the title of the section
- $sSrc : string
-
the url of the section content
- $sHeight : string = '400px'
-
the height of the section content
Tags
Return values
void —addInt()
Add integer preference
public
addInt(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addInterval()
Add numeric interval preference
public
addInterval(string $name, int $min, int $max[, int $step = 1 ][, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $min : int
-
lowest value of interval
- $max : int
-
highest value of interval
- $step : int = 1
-
length of step
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addList()
Add selection preference
public
addList(string $name, array<string|int, mixed> $valueArray[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, bool $multiple = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $valueArray : array<string|int, mixed>
-
list of selectable preference values
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $multiple : bool = false
-
multiple selection of values possible
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addPanel()
Add custom widget preference panel for all preferences below
public
addPanel(string $sTitle[, string $sTooltip = '' ][, string $sDescription = '' ][, null $sIconPath = NULL ]) : void
Parameters
- $sTitle : string
-
The title of the section panel e.g. {SORTORDER}|{TITLE} OR {TITLE}
- $sTooltip : string = ''
-
The tooltip of the section panel
- $sDescription : string = ''
-
The description of the section panel
- $sIconPath : null = NULL
-
The icon path that should be displayed
Tags
Return values
void —addPanelForEastContent()
public
addPanelForEastContent([mixed $iSortOrder = 60 ]) : mixed
Parameters
- $iSortOrder : mixed = 60
Tags
Return values
mixed —addPanelForEMail()
public
addPanelForEMail([mixed $iSortOrder = 50 ]) : mixed
Parameters
- $iSortOrder : mixed = 50
Tags
Return values
mixed —addPanelForExport()
public
addPanelForExport([mixed $iSortOrder = 70 ]) : mixed
Parameters
- $iSortOrder : mixed = 70
Tags
Return values
mixed —addPanelForFilters()
public
addPanelForFilters([mixed $iSortOrder = 40 ]) : mixed
Parameters
- $iSortOrder : mixed = 40
Tags
Return values
mixed —addPanelForLists()
public
addPanelForLists([mixed $iSortOrder = 80 ]) : mixed
Parameters
- $iSortOrder : mixed = 80
Tags
Return values
mixed —addPanelForPlugins()
public
addPanelForPlugins([mixed $iSortOrder = 110 ]) : mixed
Parameters
- $iSortOrder : mixed = 110
Tags
Return values
mixed —addPanelForWestContent()
public
addPanelForWestContent([mixed $iSortOrder = 90 ]) : mixed
Parameters
- $iSortOrder : mixed = 90
Tags
Return values
mixed —addPassword()
Add password preference
public
addPassword(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addPreference()
Add Widget preference
public
addPreference(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, string $type = 'text' ][, bool $secured = FALSE ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $type : string = 'text'
-
preference type
- $secured : bool = FALSE
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addSection()
Add custom widget preference section
public
addSection(string $sTitle, string $sContent[, string $sTooltip = '' ][, string $sDescription = '' ][, string $sIconPath = NULL ]) : void
Parameters
- $sTitle : string
- $sContent : string
- $sTooltip : string = ''
- $sDescription : string = ''
- $sIconPath : string = NULL
Tags
Return values
void —addSeparator()
Add separator to the preference to group preferences
public
addSeparator(string $sLabel[, string $sIconPath = '' ][, bool $bSecured = FALSE ]) : void
Parameters
- $sLabel : string
- $sIconPath : string = ''
- $bSecured : bool = FALSE
Tags
Return values
void —addText()
Add text preference
public
addText(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addTextarea()
Add textarea preference
public
addTextarea(string $name[, string $defaultValue = '' ][, string $label = '' ][, array<string|int, mixed> $attributes = array() ][, bool $secured = false ][, string $desc = '' ]) : void
Parameters
- $name : string
-
name of preference
- $defaultValue : string = ''
-
default value of preference when unset
- $label : string = ''
-
name of preference overwriting $name
- $attributes : array<string|int, mixed> = array()
-
list of additional attributes for preference
- $secured : bool = false
-
define as secured preference
- $desc : string = ''
-
define the help text for the preference
Tags
Return values
void —addViewSeparator()
public
addViewSeparator(mixed $sIconPath[, mixed $sLabel = 'CSP_MAN_WID_PREF_LABEL_SEPARATOR_VIEW' ][, mixed $bSecured = FALSE ]) : mixed
Parameters
- $sIconPath : mixed
- $sLabel : mixed = 'CSP_MAN_WID_PREF_LABEL_SEPARATOR_VIEW'
- $bSecured : mixed = FALSE
Tags
Return values
mixed —getFromUWAPath()
Loads all meta datas from a UWA Path
public
static getFromUWAPath(string $uwaPath) : mixed
Parameters
- $uwaPath : string
-
the path to the uwa widget
Tags
Return values
mixed —getListDefaultValue()
public
getListDefaultValue(mixed $aValueArray) : mixed
Parameters
- $aValueArray : mixed
Tags
Return values
mixed —getPreference()
Retrieve one Widget preference by name
public
getPreference(string $name) : mixed
Parameters
- $name : string
-
name of preference
Tags
Return values
mixed —content of preference
getPreferences()
Retrieve Widget preferences
public
getPreferences([bool $secured = null ]) : array<string|int, mixed>
Parameters
- $secured : bool = null
-
fetch only preferences marked as "secured"
Tags
Return values
array<string|int, mixed> —list of key-value-pairs
getSections()
Retrieve Sections if defined
public
getSections() : array<string|int, mixed>
Tags
Return values
array<string|int, mixed> —with sections. A section is again an array with the keys title, src and height.
resetPanel()
public
resetPanel() : mixed
Tags
Return values
mixed —setDefaultPanel()
Adds a default widget preference panel for all preferences below
public
setDefaultPanel(string $sTitle[, string $sTooltip = '' ][, string $sDescription = '' ][, null $sIconPath = NULL ]) : void
Parameters
- $sTitle : string
-
The title of the section panel e.g. {SORTORDER}|{TITLE} OR {TITLE}
- $sTooltip : string = ''
-
The tooltip of the section panel
- $sDescription : string = ''
-
The description of the section panel
- $sIconPath : null = NULL
-
The icon path that should be displayed