Class CQ_Analytics.Variables

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

A helper class providing a set of ClientContext utility methods to handle variables: a variable is a marker used in a store property value to referenced the value of another property. Format: ${/storeName/propertyName}

Added in CQ 5.5.

Public Properties

This class has no public properties.

Public Methods

Method		Defined By
	containsVariable( `String value` ) : void <static> Returns if a value contains a variable of not. <static> Returns if a value contains a variable of not. Parameters: `value` : String The value to test Returns: `void`	Variables
	getPropertyName( `String variable` ) : The <static> Returns the name of the property contained in the provided variable. <static> Returns the name of the property contained in the provided variable. Parameters: `variable` : String The variable Returns: `The` name of the property. Null if no property name available.	Variables
	getPropertyPath( `String variable` ) : The <static> Returns the path to the property contained in the provided variable. <static> Returns the path to the property contained in the provided variable. Parameters: `variable` : String The variable Returns: `The` path to the property. Null if no path available.	Variables
	getStoreName( `String variable` ) : The <static> Returns the name of the store contained in the provided variable. <static> Returns the name of the store contained in the provided variable. Parameters: `variable` : String The variable Returns: `The` name of the store. Null if no store name available.	Variables
	getVariables( `String value` ) : void <static> Returns the variables contained into a value. <static> Returns the variables contained into a value. Parameters: `value` : String The value Returns: `void`	Variables
	replace( `String string`, `String key`, `String value` ) : String <static> Replaces all instances of the variable `${key}` by `value` in the provided `string` and returns the result. <static> Replaces all instances of the variable `${key}` by `value` in the provided `string` and returns the result. Parameters: `string` : String The string `key` : String The variable key `value` : String The replacement value Returns: `String` The result of the replacement	Variables
	replaceVariables( `String value` ) : String <static> Replaces the variables into a value by their corresponding values in the ClientContext and returns the... <static> Replaces the variables into a value by their corresponding values in the ClientContext and returns the result. Parameters: `value` : String The value Returns: `String` The result of the replacement	Variables

Public Events

This class has no public events.