|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.frameworkSupertype
coldbox.system.plugin
coldbox.system.plugins.sessionstorage
public class sessionstorage
Session Storage plugin. It provides the user with a mechanism for permanent data storage using the session scope.
Constructor Summary | |
---|---|
init(any controller)
|
Method Summary | |
---|---|
void |
clearAll()
Clear the entire coldbox session storage |
private void |
createStorage()
Create the session storage scope |
boolean |
deleteVar(string name)
Tries to delete a permanent session var. |
boolean |
exists(string name)
Checks wether the permanent variable exists. |
any |
getStorage()
Get the entire storage scope |
any |
getVar(string name, [any default=''])
Get a new permanent variable. If the variable does not exist. The method returns blank. |
private string |
getlockName()
Get lockName |
void |
removeStorage()
remove the entire storage scope |
void |
setVar(string name, any value)
Set a new permanent variable. |
private void |
setlockName(string lockName)
Set lockName |
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 |
---|
public void clearAll()
private void createStorage()
public boolean deleteVar(string name)
name
- The variable name to retrieve.public boolean exists(string name)
name
- The variable name to retrieve.public any getStorage()
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.private string getlockName()
public void removeStorage()
public void setVar(string name, any value)
name
- The name of the variable.value
- The value to set in the variable.private void setlockName(string lockName)
lockName
|
ColdBox Platform Version 2.6.3 | ||||
FRAMES |