NAME
Kernel::WebApp::Util::UserPreferenceType::Base – User Preference Type Base fields.
PUBLIC INTERFACE
has UserType
Attribute that holds to the type of user to handle.
has UserID
Attribute that holds the user id.
has UserLogin
Attribute that holds the user login/username.
has UserObject
Attribute that holds the user object (User or CustomerUser).
has ID
Attribute that holds the preference internal ID.
has IsEmpty
Attribute that holds preference absence of configurable options.
GetConfig()
Get the preference key from the configuration. With the 'Name' argument it's possible to get a single value.
FieldStructure()
The /FieldStructure() method will return the FormGroup Field structure.
Label()
The /Label() method will return the Field label.
Description()
The /Description() method will return the Field description.
GetError()
The /GetError() method should check if the received value for the preference is valid.
FieldsValue()
The /FieldsValue() sets the current values of the preference fields.
Fields()
The /Fields() method should return the form fields that represent the preference.
Set()
The /Set() method should set/save the preference for the user in context. It use the internal /_Set() function from every module.
IsEnabled()
The /IsEnabled() method should check if the preference is enabled.
PRIVATE INTERFACE
has _Config
Attribute that holds the preference configuration.
_BuildID()
The /_BuildID() method creates an ID based on the label of the field.
_BuildUserObject()
The /_BuildUserObject() method will create a Kernel::System::User or CustomerUser object.
_BuildIsEmpty()
The /__BuildIsEmpty() method sets IsEmpty property and it should be overwritten in the UserPreferenceTypes where is needed.
_Set()
The /_Set() method should set/save the preference for the user in context.
