|
ColdBox Platform Version 3.7.0 | ||||
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> controller)
Constructor |
Method Summary | |
---|---|
private any |
decryptIt(string decValue)
Return decrypted value |
boolean |
deleteVar(string name, [string domain=''])
Tries to delete a permanent cookie variable |
private any |
encryptIt(string encValue)
Return encrypted value |
boolean |
exists(string name)
Checks wether the permanent variable exists in the storage |
boolean |
getEncryption()
Get Encryption flag |
string |
getEncryptionAlgorithm()
Get the EncryptionAlgorithm |
string |
getEncryptionEncoding()
Get EncryptionEncoding value |
string |
getEncryptionKey()
Get the EncryptionKey |
any |
getVar(any name, [any default=''])
Get a new permanent variable |
void |
setEncryption(boolean Encryption)
Set Encryption flag |
void |
setEncryptionAlgorithm(string EncryptionAlgorithm)
Set EncryptionAlgorithm for this storage |
void |
setEncryptionEncoding(string EncryptionEncoding)
Set EncryptionEncoding value |
void |
setEncryptionKey(string EncryptionKey)
Set EncryptionKey for this storage |
void |
setVar(string name, any value, [numeric expires='0'], [boolean secure='false'], [string path=''], [string domain=''])
Set a new permanent variable in the storage |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any<Controller> controller)
controller
Method Detail |
---|
private any decryptIt(string decValue)
decValue
- string to be decryptedpublic boolean deleteVar(string name, [string domain=''])
name
- The variable name to retrieve.domain
- Domain in which cookie is valid and to which cookie content can be sent from the user's system.private any encryptIt(string encValue)
encValue
- string to be encryptedpublic 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(any 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='0'], [boolean secure='false'], [string path=''], [string domain=''])
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 = 0 days]secure
- If browser does not support Secure Sockets Layer (SSL) security, the cookie is not sent. To use the cookie, the page must be accessed using the https protocol.path
- URL, within a domain, to which the cookie applies; typically a directory. Only pages in this path can use the cookie. By default, all pages on the server that set the cookie can access the cookie.domain
- Domain in which cookie is valid and to which cookie content can be sent from the user's system.
|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |