Class Helper

Helper provides several auxiliary functions for Intrexx.

deprecated: IMPORTANT: Please do not use these functions anymore since they will be removed in a future release. Use the corresponding functions given in the respective sections instead.
replacement: Please refer to IxUtil as a replacement.

Hierarchy

Helper

Methods

containsQsParam

containsQsParam(param: string, queryString: string): boolean

Searches for a parameter in a querystring.

deprecated

Please use ix.util.containsParam instead!

Parameters
- param: string
- queryString: string
Returns boolean

deleteCookie

deleteCookie(param: string): boolean

Remove a cookie parameter.

deprecated

Please use ix.cookie.deleteCookie instead!

Parameters
- param: string
Returns boolean

deleteParamFromQs

deleteParamFromQs(param: string, queryString?: string): string | boolean

Removes parameter from a querystring.

deprecated

Please use ix.util.deleteParamFromQs instead!

Parameters
- param: string
- Optional queryString: string
  
  Default: window.location
Returns string | boolean

url

deleteParamFromUrl

deleteParamFromUrl(param: string, url: string): string

Removes parameter from an url.

deprecated

Please use ix.util.deleteParamFromUrl instead!

Parameters
- param: string
- url: string
Returns string

url

doCharStuffing

doCharStuffing(list: any[]): string

Transforms an Array to a string.
|| is the separator where | as escaped with |0.

deprecated

Please use ix.util.doCharStuffing instead!

Parameters
- list: any[]
Returns string

getBaseUrl

getBaseUrl(path?: string): string

Get base url.

deprecated

Please use ix.util.getBaseUrl instead!

Parameters
- Optional path: string
  
  path e.g. folder/file.vm
Returns string

getCookieValueByParam

getCookieValueByParam(param: string, fallback?: string): string | boolean

Retrieve value of a cookie parameter.

deprecated

Please use ix.cookie.getValue instead!

Parameters
- param: string
- Optional fallback: string
Returns string | boolean

getFupId

getFupId(element: UpObject | HTMLElement): undefined | null | string

Get the GUID or ID of functional part, where given element is part of, otherwise empty string.

deprecated

Please use ix.util.getFuncPart instead!

Parameters
- element: UpObject | HTMLElement
Returns undefined | null | string

getQsValueByParam

getQsValueByParam(param: string, queryString?: string): undefined | string

Get value of a url querystring parameter.

deprecated

Please use ix.util.getQsValue instead!

Parameters
- param: string
- Optional queryString: string
  
  Default: window.location
Returns undefined | string

getQsValues

getQsValues(queryString: string): false | StringMap

Get Object with url querystring parameters or false if none found.

deprecated

Please use ix.util.getQsValues instead!

Parameters
- queryString: string
Returns false | StringMap

getUrlValueByParam

getUrlValueByParam(param: string, url?: string): undefined | string

Get value of a url querystring parameter or false if none found.

deprecated

Please use ix.util.getQsValue instead!

Parameters
- param: string
- Optional url: string
  
  Default: window.location
Returns undefined | string

getUrlValues

getUrlValues(url: string): false | StringMap

Get Object with url querystring parameters or false if none found.

deprecated

Please use ix.util.getQsValues instead!

Parameters
- url: string
Returns false | StringMap

hexDecodeString

hexDecodeString(value?: string): string

Decodes a hexadecimal to UTF-8-String.

deprecated

Please use ix.text.hexDecode instead!

Parameters
- Optional value: string
Returns string

hexEncodeString

hexEncodeString(value?: string): string

Encodes an UTF-8-String to hexadicmal.

deprecated

Please use ix.text.hexEncode instead!

Parameters
- Optional value: string
Returns string

htmlEncode

htmlEncode(html: string, insertNbsp?: boolean, insertBr?: boolean): string

Encodes particular html characters.

deprecated

Please use ix.util.htmlEncode instead!

Parameters
- html: string
- Optional insertNbsp: boolean
  
  Shall " " (space) with   be replaced. Default: false
- Optional insertBr: boolean
  
  Shall \n with <br> be replaced. Default: false
Returns string

isCookieEnabled

isCookieEnabled(): boolean

Check, if cookies are enabled.

deprecated

Please use navigator.cookieEnabled instead (see Navigator - Web API)!

Returns boolean

mergeQueryStrings

mergeQueryStrings(string1?: string, string2?: string): string

Merges two query-strings.

deprecated

Please use ix.util.mergeQueryStrings instead!

Parameters
- Optional string1: string
  
  Default: ""
- Optional string2: string
  
  Default: ""
Returns string

setCookie

setCookie(param: string, value?: string, expires?: boolean, timeOut?: number): boolean

Changes or adds a cookie parameter.

deprecated

Please use ix.cookie.setValue instead!

Parameters
- param: string
  
  New cookie parameter or parameter to change.
- Optional value: string
- Optional expires: boolean
  
  Shall expire 365 days from now.
- Optional timeOut: number
  
  Time in ms to be added to current year. Overrides expires.
Returns boolean

setQsValueByParam

setQsValueByParam(param: string, value?: string, queryString?: string): string

Changes value of a url querystring parameter. Adds parameter, if not exists already.

deprecated

Please use ix.util.setQsValue instead!

Parameters
- param: string
- Optional value: string
  
  Default: ""
- Optional queryString: string
Returns string

url

setUrlValueByParam

setUrlValueByParam(param: string, value?: string, url?: string): string

Changes value of a url querystring parameter.
Adds parameter, if not exists.

deprecated

Please use ix.util.setQsValue instead!

Parameters
- param: string
- Optional value: string
  
  Default: ""
- Optional url: string
  
  Default: window.location
Returns string

url

trim

trim(value: string): string

Trim left and right whitespaces from a string.

deprecated

Please use String.prototype.trim() instead!

Parameters
- value: string
Returns string

undoCharStuffing

undoCharStuffing(input: string): string[]

Splits a string to an Array.
|| is used as separator, while |0 is unescaped to |.

deprecated

Please use ix.util.undoCharStuffing instead!

Parameters
- input: string
Returns string[]