Class CQ_Analytics.Utils

Package:	CQ_Analytics
Class:	Utils
Extends:	Object
Clientlib:	personalization.core

A helper class providing a set of utility methods.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	addParameter( `String url`, `String name`, `String/String[] value` ) : String <static> Adds a parameter to the specified URL. The parameter name and value will be URL-endcoded. <static> Adds a parameter to the specified URL. The parameter name and value will be URL-endcoded. Parameters: `url` : String The URL `name` : String The name of the parameter `value` : String/String[] The value of the parameter. Since 5.3, an array of strings can be passed Returns: `String` The URL with the new parameter	Utils
	clearElement( `String elemId` ) : void <static> Clears in the inner HTML content of a DOM element. <static> Clears in the inner HTML content of a DOM element. Parameters: `elemId` : String Id of the DOM element to clear. Returns: `void`	Utils
	encodePath( `String path` ) : String <static> Encodes the specified path using encodeURI. Additionally +, # and ? are encoded. The following charact... <static> Encodes the specified path using encodeURI. Additionally `+`, `#` and `?` are encoded. The following characters are not encoded: `0-9 a-z A-Z` `- _ . ! ~ * ' ( )` `; / : @ & = $ ,` Parameters: `path` : String The path to encode Returns: `String` The encoded path Added in CQ 5.3.	Utils
	encodePathOfURI( `String url` ) : String <static> Encodes the path of the specified URL if it is not already encoded. Path means the part of the URL bef... <static> Encodes the path of the specified URL if it is not already encoded. Path means the part of the URL before the first question mark or hash sign. See CQ.shared.HTTP.encodePath for details about the encoding. Sample: `/x/y+z.png?path=/x/y+z >> /x/y%2Bz.png?path=x/y+z` Note that the sample would not work because the "+" in the request parameter would be interpreted as a space. Parameters must be encoded separately. Parameters: `url` : String The URL to encoded Returns: `String` The encoded URL Added in CQ 5.3.	Utils
	eventWrapper( `Function func` ) : Function <static> Creates a event wraping function of a parameter function. Available parameters are: event : ObjectEven... <static> Creates a event wraping function of a parameter function. Available parameters are: event : Object Event keyCode : Number Key code Parameters: `func` : Function The function to wrap Returns: `Function` Wrapping function	Utils
	externalize( `String url`, [`boolean encode`] ) : String <static> Makes sure the specified relative URL starts with the context path used on the server. If an absolute ... <static> Makes sure the specified relative URL starts with the context path used on the server. If an absolute URL is passed, it will be returned as-is. Parameters: `url` : String The URL `encode` : boolean true to encode the path of the URL (optional) Returns: `String` The externalized URL Added in CQ 5.3.	Utils
	getContextPath() : String <static> Returns the context path used on the server. <static> Returns the context path used on the server. Parameters: None. Returns: `String` The context path Added in CQ 5.3.	Utils
	getPagePath() : String <static> Returns the current page path. <static> Returns the current page path. Parameters: None. Returns: `String` Page path	Utils
	getPath( `String url` ) : String <static> Removes all parts but the path from the specified URL. Examples:/x/y.sel.html?param=abc => /x/y htt... <static> Removes all parts but the path from the specified URL. Examples: `/x/y.sel.html?param=abc => /x/y` `http://www.day.com/foo/bar.html => /foo/bar` Parameters: `url` : String The URL Returns: `String` The path	Utils
	getTimestamp() : Number <static> Returns a timestamp. <static> Returns a timestamp. Parameters: None. Returns: `Number` Timestamp	Utils
	getUID() : String <static> Returns a base 16 encoded UID based on a timestamp and a random number. <static> Returns a base 16 encoded UID based on a timestamp and a random number. Parameters: None. Returns: `String` UID	Utils
	insert( `String str`, `Number every`, `String separator` ) : String <static> Inserts a string every x character into another string. <static> Inserts a string every x character into another string. Parameters: `str` : String Source string `every` : Number Inserts every x characters `separator` : String String to insert Returns: `String` The string with inserted separators	Utils
	internalize( `String url`, [`String doc`] ) : String <static> Removes scheme, authority and context path from the specified absolute URL if it has the same scheme a... <static> Removes scheme, authority and context path from the specified absolute URL if it has the same scheme and authority as the specified document (or the current one). Parameters: `url` : String The URL `doc` : String (optional) The document Returns: `String` The internalized URL	Utils
	load( `String url`, [`Function callback`] ) : void <static> Requests the specified URL from the server using GET. The request will be synchronous, unless a callba... <static> Requests the specified URL from the server using GET. The request will be synchronous, unless a callback function is specified. Parameters: `url` : String The URL to request `callback` : Function (optional) The callback function which is called regardless of success or failure and is passed the following parameter: xhr : Object The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response. Returns: `void`	Utils
	loadElement( `String url`, `String elemId` ) : void <static> Loads the HTML returned by a GET request into a DOM element. <static> Loads the HTML returned by a GET request into a DOM element. Parameters: `url` : String URL to request `elemId` : String Id of the DOM element where HTML is inserted. Returns: `void`	Utils
	loadTeaserElement( `String url`, `String elemId` ) : void <static> Loads the HTML returned by a GET request into a DOM element. Teasers smooth loading. <static> Loads the HTML returned by a GET request into a DOM element. Teasers smooth loading. Parameters: `url` : String URL to request `elemId` : String Id of the DOM element where HTML is inserted. Returns: `void`	Utils
	post( `String url`, [`Function callback`], `Object params`, `Object scope` ) : void <static> Requests the specified URL from the server using POST. The request will be synchronous, unless a callb... <static> Requests the specified URL from the server using POST. The request will be synchronous, unless a callback function is specified. The returned response object looks like this: `{ headers: { "Status": 200, ... } }` See constants above for all supported headers. Parameters: `url` : String The URL to request `callback` : Function (optional) The callback function which is called regardless of success or failure and is passed the following parameter: xhr : Object The XMLHttpRequest object containing the response data. See http://www.w3.org/TR/XMLHttpRequest/ for details about accessing elements of the response. `params` : Object The parameters `scope` : Object The scope Returns: `void`	Utils
	registerDocumentEventHandler( `Object event`, `Function func` ) : void <static> Attaches an event handler while properly considering (aka chaining) an existing one <static> Attaches an event handler while properly considering (aka chaining) an existing one Parameters: `event` : Object Event `func` : Function Function Returns: `void`	Utils
	removeAnchor( `String url` ) : String <static> Removes the anchor from the specified URL. <static> Removes the anchor from the specified URL. Parameters: `url` : String The URL Returns: `String` The URL without anchor Copied from CQ.HTTP	Utils
	removeParameters( `String url` ) : String <static> Removes all parameter from the specified URL. <static> Removes all parameter from the specified URL. Parameters: `url` : String The URL Returns: `String` The URL without parameters	Utils

Public Events

This class has no public events.