coldbox.system.web.flash

Class SessionFlash

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

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This flash scope is smart enough to not create unecessary session variables unless data is put in it. Else, it does not abuse session.

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


    • 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.
    struct getFlash()
         Get the flash storage structure to inflate it.
    string getFlashKey()
    any removeFlash()
         Remove the entire flash storage.
    any saveFlash()
         Save the flash storage in preparing to go to the next request.
    any setFlashKey(any flashKey)
     
    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

    flashKey

    property any flashKey

    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

    getFlash

    public struct getFlash()

    Get the flash storage structure to inflate it.

    Overrides:
    getFlash in class AbstractFlashScope

    getFlashKey

    public string getFlashKey()

    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

    setFlashKey

    public any setFlashKey(any flashKey)

    Parameters:
    flashKey