coldbox.system.core.collections

Class ScopeStorage

lucee.Component
    extended by coldbox.system.core.collections.ScopeStorage

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- A utility Facade to help in storing data in multiple CF Storages

Class Attributes:
  • synchronized : false
    •  
  • accessors : false
    •  
  • persistent : false
    •  
    Constructor Summary
    init()
          Constructor.
    Method Summary
    boolean delete(any key, any scope)
         Delete a value in a scope.
    boolean exists(any key, any scope)
         Check if a key exists.
    any get(any key, any scope, [any defaultValue])
         Get a value in a scope.
    any getApplication()
         Shortcut to get Application.
    any getClient()
         Shortcut to get Client.
    any getCookie()
         Shortcut to get cookie.
    any getScope(any scope)
         Get a scope reference.
    any getServer()
         Shortcut to get Server.
    any getSession()
         Shortcut to get Session.
    any put(any key, any value, any scope)
         Store a value in a scope.
    any scopeCheck(any scope)
         Check if a scope is valid, else throws exception.
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init()

    Constructor

    Method Detail

    delete

    public boolean delete(any key, any scope)

    Delete a value in a scope

    Parameters:
    key - The key
    scope - The ColdFusion Scope

    exists

    public boolean exists(any key, any scope)

    Check if a key exists

    Parameters:
    key - The key
    scope - The CF Scope

    get

    public any get(any key, any scope, [any defaultValue])

    Get a value in a scope

    Parameters:
    key - The key
    scope - The CF Scope
    defaultValue - The default value

    getApplication

    public any getApplication()

    Shortcut to get Application

    getClient

    public any getClient()

    Shortcut to get Client

    getCookie

    public any getCookie()

    Shortcut to get cookie

    getScope

    public any getScope(any scope)

    Get a scope reference

    Parameters:
    scope - The CF Scope

    getServer

    public any getServer()

    Shortcut to get Server

    getSession

    public any getSession()

    Shortcut to get Session

    put

    public any put(any key, any value, any scope)

    Store a value in a scope

    Parameters:
    key - The key
    value - The value
    scope - The ColdFusion Scope

    scopeCheck

    public any scopeCheck(any scope)

    Check if a scope is valid, else throws exception

    Parameters:
    scope - The CF Scope