|
ColdBox Platform v3.8.0 | ||||
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 |
void |
removeStorage()
remove the entire storage scope |
void |
setVar(string name, any value)
Set a new permanent variable |
Methods inherited from class WEB-INF.cftags.component |
---|
None
|
Constructor Detail |
---|
public init(any controller)
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.public void removeStorage()
public void setVar(string name, any value)
name
- The name of the variable.value
- The value to set in the variable.
|
ColdBox Platform v3.8.0 | ||||
FRAMES |