coldbox.system.ioc.scopes

Class CacheBox

lucee.Component
    extended by coldbox.system.ioc.scopes.CacheBox

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- A scope that interfaces with CacheBox

Class Attributes:
  • synchronized : false
    •  
  • see : coldbox.system.ioc.scopes.IScope
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any cacheBox
          CacheBox Reference.

    • access = public
    • returntype = any
    		 true false
    any injector
          Injector linkage.

    • access = public
    • returntype = any
    		 true false
    any log
          Log Reference.

    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any<Injector> injector)
          Configure the scope for operation and returns itself.
    Method Summary
    boolean exists(any<Mapping> mapping)
         Indicates whether an object exists in scope.
    string getCacheBox()
    any getFromScope(any<Mapping> mapping, [struct initArguments])
         Retrieve an object from scope or create it if not found in scope.
    string getInjector()
    string getLog()
    any setCacheBox(any cacheBox)
    any setInjector(any injector)
    any setLog(any log)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any<Injector> injector)

    Configure the scope for operation and returns itself

    Parameters:
    injector - The linked WireBox injector
    Property Detail

    cacheBox

    property any cacheBox

    CacheBox Reference

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

    injector

    property any injector

    Injector linkage

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

    log

    property any log

    Log Reference

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

    exists

    public boolean exists(any<Mapping> mapping)

    Indicates whether an object exists in scope

    Parameters:
    mapping - The linked WireBox injector
    Returns:
    coldbox.system.ioc.scopes.IScope

    getCacheBox

    public string getCacheBox()

    getFromScope

    public any getFromScope(any<Mapping> mapping, [struct initArguments])

    Retrieve an object from scope or create it if not found in scope

    Parameters:
    mapping - The linked WireBox injector
    initArguments - The constructor struct of arguments to passthrough to initialization

    getInjector

    public string getInjector()

    getLog

    public string getLog()

    setCacheBox

    public any setCacheBox(any cacheBox)

    Parameters:
    cacheBox

    setInjector

    public any setInjector(any injector)

    Parameters:
    injector

    setLog

    public any setLog(any log)

    Parameters:
    log