ColdBox Platform Version 3.7.0

coldbox.system.core.collections
Class ScopeStorage

WEB-INF.cftags.component
        extended by coldbox.system.core.collections.ScopeStorage

public class ScopeStorage
extends WEB-INF.cftags.component

A utility storage to all CF scopes


Constructor Summary
init()
          Constructor
 
Method Summary
 boolean delete(string key, string scope)
          delete from a scope
 boolean exists(string key, string scope)
          Check if a value is in scope
 any get(string key, string scope, [any default])
          Get something from a scope
 struct getApplication()
          Get application
 struct getClient()
          Get client
 struct getCluster()
          Get cluster
 struct getCookie()
          Get cookie
 struct getScope(string scope)
          Get a named scope
 struct getServer()
          Get server
 struct getSession()
          Get Session
 void put(string key, any value, string scope)
          Put into a scope
 void scopeCheck(string scope)
          Check if a scope is valid, else throw exception
 
Methods inherited from class WEB-INF.cftags.component
 

Constructor Detail

init

public init()
Constructor

Method Detail

delete

public boolean delete(string key, string scope)
delete from a scope

Parameters:
key - The key value
scope - The CF scope to place it in

exists

public boolean exists(string key, string scope)
Check if a value is in scope

Parameters:
key - The key to retrieve
scope - The CF scope to get an object from

get

public any get(string key, string scope, [any default])
Get something from a scope. Throws exception if not found

Parameters:
key - The key to retrieve
scope - The CF scope to get an object from
default - The default value if not found

getApplication

public struct getApplication()
Get application


getClient

public struct getClient()
Get client


getCluster

public struct getCluster()
Get cluster


getCookie

public struct getCookie()
Get cookie


getScope

public struct getScope(string scope)
Get a named scope

Parameters:
scope - The CF scope to get an object from

getServer

public struct getServer()
Get server


getSession

public struct getSession()
Get Session


put

public void put(string key, any value, string scope)
Put into a scope

Parameters:
key - The key value
value - The value to put
scope - The CF scope to place it in

scopeCheck

public void scopeCheck(string scope)
Check if a scope is valid, else throw exception

Parameters:
scope - The CF scope to check

ColdBox Platform Version 3.7.0