coldbox.system.web.flash

Class ColdboxCacheFlash

lucee.Component
    extended by coldbox.system.web.flash.AbstractFlashScope
      extended by coldbox.system.web.flash.ColdboxCacheFlash

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This flash uses CacheBox

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
  • author : Luis Majano
    •  
    Property Summary
    type property default serializable required
    any cache


    • access = public
    • returntype = any
    		 true false
    any cacheName


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any controller, struct defaults='[runtime expression]')
          Constructor.
    Method Summary
    boolean flashExists()
         Checks if the flash storage exists and IT HAS DATA to inflate.
    string getCache()
    string getCacheName()
    struct getFlash()
         Get the flash storage structure to inflate it.
    any getFlashKey()
         Build Flash Key according to standards.
    any removeFlash()
         Remove the entire flash storage.
    any saveFlash()
         Save the flash storage in preparing to go to the next request.
    any setCache(any cache)
    any setCacheName(any cacheName)
     
    Methods inherited from class coldbox.system.web.flash.AbstractFlashScope
    clear, clearFlash, discard, exists, get, getController, getDefaults, getKeys, getProperties, getProperty, getScope, getUtil, inflateFlash, isEmpty, keep, persistRC, propertyExists, put, putAll, remove, setController, setDefaults, setProperties, setProperty, size, statusMarks
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any controller, struct defaults='[runtime expression]')

    Constructor

    Parameters:
    controller - ColdBox Controller
    defaults - Default flash data packet for the flash RAM object=[scope,properties,inflateToRC,inflateToPRC,autoPurge,autoSave]
    Property Detail

    cache

    property any cache

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true

    cacheName

    property any cacheName

    Attributes:
    access - public
    required - false
    returntype - any
    serializable - true
    Method Detail

    flashExists

    public boolean flashExists()

    Checks if the flash storage exists and IT HAS DATA to inflate.

    Overrides:
    flashExists in class AbstractFlashScope

    getCache

    public string getCache()

    getCacheName

    public string getCacheName()

    getFlash

    public struct getFlash()

    Get the flash storage structure to inflate it.

    Overrides:
    getFlash in class AbstractFlashScope

    getFlashKey

    public any getFlashKey()

    Build Flash Key according to standards

    removeFlash

    public any removeFlash()

    Remove the entire flash storage

    Overrides:
    removeFlash in class AbstractFlashScope
    Returns:
    SessionFlash

    saveFlash

    public any saveFlash()

    Save the flash storage in preparing to go to the next request

    Overrides:
    saveFlash in class AbstractFlashScope
    Returns:
    SessionFlash

    setCache

    public any setCache(any cache)

    Parameters:
    cache

    setCacheName

    public any setCacheName(any cacheName)

    Parameters:
    cacheName