|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
coldbox.system.plugin
coldbox.system.plugins.cookiestorage
public class cookiestorage
Cookie Storage plugin. It provides the user with a mechanism for permanent data storage using the cookie scope.
Constructor Summary | |
---|---|
init(any controller)
Constructor. |
Method Summary | |
---|---|
private Any |
DecryptIt(string decValue)
Return decrypted value |
private Any |
EncryptIt(string encValue)
Return encypted value |
boolean |
deleteVar(string name)
Tries to delete a permanent cookie var. |
boolean |
exists(string name)
Checks wether the permanent variable exists. |
boolean |
getEncryption()
Get Encryption |
string |
getEncryptionAlgorithm()
Get EncryptionAlgorithm |
string |
getEncryptionEncoding()
Get EncryptionEncoding |
string |
getEncryptionKey()
Get EncryptionKey |
any |
getVar(string name, [any default=''])
Get a new permanent variable. If the cookie does not exist. The method returns blank. |
void |
setEncryption(boolean Encryption)
Set Encryption |
void |
setEncryptionAlgorithm(string EncryptionAlgorithm)
Set EncryptionAlgorithm |
void |
setEncryptionEncoding(string EncryptionEncoding)
Set EncryptionEncoding |
void |
setEncryptionKey(string EncryptionKey)
Set EncryptionKey |
void |
setVar(string name, any value, [numeric expires='1'])
Set a new permanent variable. |
Methods inherited from class coldbox.system.plugin |
---|
getPluginDescription, getPluginName, getPluginVersion, getpluginPath, setPluginDescription, setPluginName, setPluginVersion
|
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller)
Method Detail |
---|
private Any DecryptIt(string decValue)
decValue
- string to be decryptedprivate Any EncryptIt(string encValue)
encValue
- string to be encryptedpublic boolean deleteVar(string name)
name
- The variable name to retrieve.public boolean exists(string name)
name
- The variable name to retrieve.public boolean getEncryption()
public string getEncryptionAlgorithm()
public string getEncryptionEncoding()
public string getEncryptionKey()
public any getVar(string name, [any default=''])
name
- The variable name to retrieve.default
- The default value to set. If not used, a blank is returned.public void setEncryption(boolean Encryption)
Encryption
public void setEncryptionAlgorithm(string EncryptionAlgorithm)
EncryptionAlgorithm
public void setEncryptionEncoding(string EncryptionEncoding)
EncryptionEncoding
public void setEncryptionKey(string EncryptionKey)
EncryptionKey
public void setVar(string name, any value, [numeric expires='1'])
name
- The name of the variable.value
- The value to set in the variable, simple, array, query or structure.expires
- Cookie Expire in number of days. [default cookie is session only]
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |