Callable

Class

ColdBox Platform Version 2.6.4

FRAMES

coldbox.system.plugins
Class ClientStorage

WEB-INF.cftags.component
        coldbox.system.FrameworkSupertype
            coldbox.system.Plugin
                coldbox.system.plugins.ClientStorage

public class ClientStorage
extends Plugin
extends Plugin

Client Storage plugin. It provides the user with a mechanism for permanent data storage using the client scope and WDDX.

Constructor Summary
`init(any controller)` Constructor

Method Summary
`void`	`clearAll()` Clear the entire coldbox client storage
`boolean`	`deleteVar(string name)` Tries to delete a permanent client var
`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`	`setVar(string name, any value)` Set a new permanent variable

Methods inherited from class coldbox.system.Plugin
`getPluginDescription, getPluginName, getPluginVersion, getRequestCollection, getRequestContext, getpluginAuthor, getpluginAuthorURL, getpluginPath, setPluginDescription, setPluginName, setPluginVersion, setpluginAuthor, setpluginAuthorURL`

Methods inherited from class coldbox.system.FrameworkSupertype
$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class coldbox.system.FrameworkSupertype

$abort, $dump, $htmlhead, $include, $rethrow, $throw, addAsset, announceInterception, getColdboxOCM, getController, getDatasource, getDebugMode, getHash, getInstance, getInterceptor, getMailSettings, getModel, getModuleSettings, getMyPlugin, getPlugin, getResource, getSetting, getSettingStructure, getSettingsBean, getfwLocale, includeUDF, locateDirectoryPath, locateFilePath, persistVariables, populateModel, relocate, renderExternalView, renderView, runEvent, setDebugMode, setNextEvent, setNextRoute, setSetting, setfwLocale, settingExists

Methods inherited from class WEB-INF.cftags.component

Constructor Detail

init

public init(any controller)

Constructor.

Parameters:: controller - coldbox.system.web.Controller

Method Detail

clearAll

public void clearAll()

Clear the entire coldbox client storage

deleteVar

public boolean deleteVar(string name)

Tries to delete a permanent client var.

exists

public boolean exists(string name)

Checks wether the permanent variable exists.

getStorage

public struct getStorage()

Get the entire storage scope structure

getVar

public any getVar(string name, [any default=''])

Get a new permanent variable. If the variable does not exist. The method returns blank.

setVar

public void setVar(string name, any value)

Set a new permanent variable.

Overview

Package