|
ColdBox Platform Version 3.7.0 | ||||
FRAMES |
WEB-INF.cftags.componentcoldbox.system.FrameworkSupertype
coldbox.system.Plugin
coldbox.system.plugins.ApplicationStorage
public class ApplicationStorage
Application Storage plugin. It provides the user with a mechanism for permanent data storage using the application scope.
Constructor Summary | |
---|---|
init(any controller)
Constructor |
Method Summary | |
---|---|
void |
clearAll()
Clear the entire coldbox application storage |
private void |
createStorage()
Create the app storage scope |
boolean |
deleteVar(string name)
Tries to delete a permanent application variable |
boolean |
exists(string name)
Checks wether the permanent variable exists |
struct |
getStorage()
Get the entire storage scope structure |
any |
getVar(string name, [any default=''])
Get a new permanent variable |
void |
removeStorage()
remove the entire storage from scope |
void |
setVar(string name, any value)
Set a new permanent variable |
Methods inherited from class WEB-INF.cftags.component |
---|
|
Constructor Detail |
---|
public init(any controller)
controller
- coldbox.system.web.ControllerMethod 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 struct 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 Version 3.7.0 | ||||
FRAMES |