UtilHelper()
Creates UtilHelper instance
Class: UtilHelper
appWrapper.helpers.systemHelpers. UtilHelper
UtilHelper class - contains various utility methods
Extends
Methods
_doLog(debugMessage){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| debugMessage | Object | Message object to be logged (returned by this.getMessageObject method) |
Return
Does actual logging to console (and log file is file logging is enabled)
_getStack(){array}
Return
Helper method for getting call stack array for debug or user message objects
addBoundMethods(){undefined}
Return
Method that sets up this.boundMethods property by binding this objects
functions to itself to be used as event listener handlers
addDesktopNotification(message, data, dontTranslate, options, callbacks){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Notification message |
| data | array | An array of data strings that are to be applied to notification |
| dontTranslate | Boolean | Flag to prevent automatic notification translation |
| options | Object | Desktop notification options (passed to HTML5 Notification object constructor) |
| callbacks | Object | Object with onshow, onClicked, onClosed and onerror notification handlers |
Return
Displays desktop notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addEventListeners(){undefined}
Return
Adds event listeners for this object
addModalMessage(message, type, data, important, dontTranslate, force, passToDebug){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Message to be logged |
| type | string | Type of log message (debug, info, warning, error) |
| data | array | An array of data strings that are to be applied to logging message |
| important | Boolean | Flag to indicate message importance |
| dontTranslate | Boolean | Flag to prevent automatic message translation |
| force | Boolean | Flag to force message output even if configuration wouldn't allow it |
| passToDebug | Boolean | Flag to force passing same message to debug log |
Return
Adds modal message to currently open modal dialog
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addNotification(message, type, data, dontTranslate, options){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Notification message |
| type | string | Notification message type |
| data | array | An array of data strings that are to be applied to notification |
| dontTranslate | Boolean | Flag to prevent automatic notification translation |
| options | Object | Additional notification options |
Return
Displays app notification
Notification message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
addUserMessage(message, type, data, important, dontTranslate, force, passToDebug){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Message to be logged |
| type | string | Type of log message (debug, info, warning, error) |
| data | array | An array of data strings that are to be applied to logging message |
| important | Boolean | Flag to indicate message importance |
| dontTranslate | Boolean | Flag to prevent automatic message translation |
| force | Boolean | Flag to force message output even if configuration wouldn't allow it |
| passToDebug | Boolean | Flag to force passing same message to debug log |
Return
Logs user message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
asyncMessage(data){mixed}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Message data object |
Return
Emits 'asyncMessage' global event, listened by main script
asyncMessageInfo(data, verboseOutput){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Message data.data object |
| verboseOutput | Boolean | Toggles verbose output |
Return
Returns info on async messages that can be passed to mainScript
clearIntervals(){undefined}
Return
Clears all intervals bound to this AppWrapper instance
clearTimeouts(){undefined}
Return
Clears all timeouts bound to this AppWrapper instance
confirmLogViewerModalAction(){undefined}
Return
Log viewer modal action confirm
confirmSaveLogAction(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Handler that saves user message or debug logs
destroy(){undefined}
Return
Destructor method - cleans up references for this instance
freeing memory upon object destruction
difference(original, modified){Object|array}
Parameters
| Name | Type | Description |
|---|---|---|
| original | Object | array | Original array or object |
| modified | Object | array | Modified array or object |
Return
Calculates deep difference between objects or arrays
finalize(){Boolean}
Return
Finalizes current class instance, setting up any additional properties
etc. Entire app structure, including frontend app is available here
getAppState(){Object}
Return
Helper method to get appState object
getAppWrapper(){AppWrapper}
Return
Helper method to get appWrapper instance
getArrayDuplicates(arr){array}
Parameters
| Name | Type | Description |
|---|---|---|
| arr | array | Array to search |
Return
Finds duplicates in array and returns them
getConfig(name, defaultValue){mixed}
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | String representing path to requested var (i.e. 'appConfig.appInfo.name') |
| defaultValue | mixed | Default value to be returned if configuration var is not found |
Return
Returns configuration var value
getControlObject(configValue, configName, path, options, isInner){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| configValue | mixed | Value of variable |
| configName | string | Name of variable |
| path | string | Path to variable in configuration |
| options | Object | Object with additional control options |
| isInner | Boolean | Flag to indicate whether method called itself for complex vars |
Return
Returns control object to be used in form-control component
getDebugMessageFileLine(message){string}
Parameters
| Name | Type | Description |
|---|---|---|
| message | obj | Message object to be logged (returned by this.getMessageObject method) |
Return
Returns string representing log line for appending
to debug log file
getDebugMessageFilePath(){string}
Return
Returns path to debug message log file
getHelper(name){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| name | string | Name of the helper |
Return
Returns instance of helper object based on passed parameter (or false if helper can't be found)
getMessageFileLine(message){string}
Parameters
| Name | Type | Description |
|---|---|---|
| message | obj | Message object to be logged (returned by this.getMessageObject method) |
Return
Gets JSON represenation of message object for saving into log file,
removing unneccessary properties and adding necessary ones
getMessageObject(messageLevel, message, type, data, important, dontTranslate, force){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| messageLevel | int | Number representing current message level (0=debug, 1=info, 2=warning, 3=error) |
| message | string | Message to be logged |
| type | string | Type of log message (debug, info, warning, error) |
| data | array | An array of data strings that are to be applied to logging message |
| important | Boolean | Flag to indicate message importance |
| dontTranslate | Boolean | Flag to prevent automatic message translation |
| force | Boolean | Flag to force message output even if configuration wouldn't allow it |
Return
Returns prepared message object based on passed arguments.
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
getMessageObjectRow(index, messageRowData){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| index | mixed | Key or array index |
| messageRowData | Object | Message row data for logging |
Return
Gets single row for tabular message logging
getMessageStacksCount(messages){Number}
Parameters
| Name | Type | Description |
|---|---|---|
| messages | Object | Message objects to count |
Return
Gets stack counts for messages
getMessageStacksState(messages){Number}
Parameters
| Name | Type | Description |
|---|---|---|
| messages | Array.<Object> | Messages to get state for |
Return
Gets current stack state for messages
getRandom(min, max){Number}
Parameters
| Name | Type | Description |
|---|---|---|
| min | Number | Minimum value for random number |
| max | Number | Maximum value for random number |
Return
Returns random number between min and max
getRandomString(size){string}
Parameters
| Name | Type | Description |
|---|---|---|
| size | Number | Size of the string (default is 4) |
Return
Returns random string
getStateVar(varPath, defaultValue){mixed}
Parameters
| Name | Type | Description |
|---|---|---|
| varPath | string | String representing path to requested var (i.e. 'appData.appMainData.cancelable') |
| defaultValue | mixed | Default value to be returned if appState var is not found |
Return
Returns appState var value
getTableMessageData(message){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| message | Object | Tabular data |
Return
Prepares table data for tabular message logging
getUserMessageFileLine(message){string}
Parameters
| Name | Type | Description |
|---|---|---|
| message | obj | Message object to be logged (returned by this.getMessageObject method) |
Return
Returns string representing log line for appending
to user message log file
getUserMessageFilePath(){string}
Return
Returns path to user message log file
getVar(varPath, context){mixed}
Parameters
| Name | Type | Description |
|---|---|---|
| varPath | string | Path to the var (i.e. 'appConfig.theme') |
| context | Object | Object that is base context for search (default: global) |
Return
Returns var value using path and context from arguments
getVarParent(varPath, context){mixed}
Parameters
| Name | Type | Description |
|---|---|---|
| varPath | string | Path to the var (i.e. 'appConfig.theme') |
| context | Object | Object that is base context for search (default: global) |
Return
Returns var value using path and context from arguments
globalEmit(eventName, data){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| eventName | String | Name of the event |
| data | Object | Event data object |
Return
Emits event to globalEmitter (listened by both main script and app code)
initialize(options){appWrapper.AppBaseClass}
Parameters
| Name | Type | Description |
|---|---|---|
| options | BaseInitializationOptions | Initialization options |
Return
Initializes current class instance, setting up logging and
bound methods to be used in event listeners
initializeLogging(options){appWrapper.AppBaseClass}
Parameters
| Name | Type | Description |
|---|---|---|
| options | Object | Options for logging initialization (currently only 'silent' property is used, determining whether warnings should be printed if no config found) |
Return
Determines whether logging for this class is regulated through
configuration, setting the logging by it (or warning if there
are no configuration settings for this class)
isDebugEnabled(){Boolean}
Return
Checks whether debug mode is on
loadLogViewerFile(fileName){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| fileName | string | Absolute path to log file |
Return
Loads log viewer file and displays it in modal log-viewer component
log(message, type, data, force){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| message | string | Message to be logged |
| type | string | Type of log message (debug, info, warning, error, group, groupCollaped, groupend) |
| data | array | An array of data strings that are to be applied to logging message |
| force | Boolean | Flag to force logging output even if config does not allow it |
Return
Logs debug message if conditions are met
Message is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
message(data){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Event data object |
Return
Emits 'message' global event, listened by main script
messageInfo(data, verboseOutput){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| data | Object | Message data.data object |
| verboseOutput | Boolean | Toggles verbose output |
Return
Returns info on messages that can be passed to mainScript
messageInfoOutput(messageData, verboseOutput){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| messageData | Object | Message response data |
| verboseOutput | Boolean | Toggles verbose output |
Return
Logs messages info to console
noop(){string}
Return
Empty method placeholder
openExternalUrl(url){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| url | string | Url to open |
Return
Opens external url in system default browser
pickLogFile(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Handler for opening log file for log-viewer component picking dialog
pickLogViewerFile(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that triggered the method |
Return
Handler for loading log file for log-viewer component
preloadImageCallback(imgSrc, callback){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| imgSrc | string | Image URL |
| callback | function | Callback function |
Return
Preloads image on page and calls callback when finished
prevent(e){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| e | Event | Event that should be prevented |
Return
Prevents default for passed event
propertyMap(obj, prepend){Array.<string>}
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | Object for mapping |
| prepend | string | String to prepend for property map items |
Return
Returns deep property map for object
propertyValuesMap(obj, prepend){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | Object for mapping |
| prepend | string | String to prepend for property map items |
Return
Gets deep property map with values
quoteRegex(string){string}
Parameters
| Name | Type | Description |
|---|---|---|
| string | string | String to quote |
Return
Quotes string so it can be used in regex safely
removeBoundMethods(){undefined}
Return
Method that cleans up this.boundMethods property
set in this.addBoundMethods method
removeEventListeners(){undefined}
Return
Removes event listeners for this object
resetAppError(){undefined}
Return
Resets (turns off) application error, removing app-error component
setAppError(title, text, debugText, data, doNotTranslate, messageType, omitIcon){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| title | String | App error title |
| text | String | App error text |
| debugText | String | App error debug text (shown only if debug is enabled) |
| data | Array.<String> | An array with replacement data for error title, text and debugText |
| doNotTranslate | Boolean | Flag to prevent automatic traslation of title and text |
| messageType | String | null | Type of messages to show in app-error ('user', 'debug' or null) |
| omitIcon | Boolean | Flag to control app-error icon rendering |
Return
Sets (turns on) application error, triggering rendering of app-error component
setObjectValuesFromForm(form, source, keepFirstChunk){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| form | HTMLElement | Form element |
| source | Object | Source object to use for final data |
| keepFirstChunk | boolean | Flag to indicate whether to keep first chunk from form elements data-path attributes |
Return
Sets object values using form data from passed form element
setVar(varPath, value, context){undefined}
Parameters
| Name | Type | Description |
|---|---|---|
| varPath | string | Path to the var (i.e. 'appConfig.theme') |
| value | mixed | New var value |
| context | Object | Object that is base context for search (default: global) |
Return
Sets var value based on path and context
sortObject(object, deep){Object}
Parameters
| Name | Type | Description |
|---|---|---|
| object | Object | Object to sort |
| deep | Boolean | Perform deep sorting |
Return
Sorts object properties by key and returns sorted copy
toJson(value, minified){string}
Parameters
| Name | Type | Description |
|---|---|---|
| value | mixed | Value to convert |
| minified | boolean | Flag to minify JSON output |
Return
Converts object to JSON and returns it
translate(text, currentLanguage, data){string}
Parameters
| Name | Type | Description |
|---|---|---|
| text | string | Text to be translated |
| currentLanguage | string | Curent language code |
| data | array | An array of data strings that are to be applied to translated message |
Return
Returns translated value for passed arguments
Translation is being interpolated by replacing placeholders
such as '{1}', '{2}' etc. by corresponding values from 'data' argument
uuid(){string}
Return
Returns UUID string