coldbox.system.cache.util

Class EventURLFacade

lucee.Component
    extended by coldbox.system.cache.util.EventURLFacade

Copyright Since 2005 ColdBox Framework by Luis Majano and Ortus Solutions, Corp www.ortussolutions.com --- This cfc acts as an URL/FORM facade for event caching. The associated cache will have to implement the IColdboxApplicationCache in order to retrieve the right prefix keys.

Class Attributes:
  • synchronized : false
    •  
  • accessors : true
    •  
  • persistent : false
    •  
    Property Summary
    type property default serializable required
    any cacheProvider


    • access = public
    • returntype = any
    		 true false
    Constructor Summary
    init(any cacheProvider)
          Constructor.
    Method Summary
    string buildBasicCacheKey(any keySuffix, any targetEvent)
         Builds a basic cache key without the hash component.
    string buildEventKey(any keySuffix, any targetEvent, any targetContext)
         Build an event key according to passed in params.
    string buildEventKeyNoContext(any keySuffix, any targetEvent, any targetArgs)
         Build an event key according to passed in params.
    any buildHash(string args)
         Build a unique hash according to an incoming query string, mostly used when calling the clear functions of.
    string getCacheProvider()
    string getUniqueHash(any event)
         Build a unique hash from an incoming request context.
    any setCacheProvider(any cacheProvider)
     
    Methods inherited from class lucee.Component
    None
    Constructor Detail

    init

    public init(any cacheProvider)

    Constructor

    Parameters:
    cacheProvider - Provider to connect to
    Property Detail

    cacheProvider

    property any cacheProvider

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

    buildBasicCacheKey

    public string buildBasicCacheKey(any keySuffix, any targetEvent)

    Builds a basic cache key without the hash component

    Parameters:
    keySuffix - The key suffix used
    targetEvent - The targetged ColdBox event string

    buildEventKey

    public string buildEventKey(any keySuffix, any targetEvent, any targetContext)

    Build an event key according to passed in params

    Parameters:
    keySuffix - The key suffix used in the cache key
    targetEvent - The targeted ColdBox event executed
    targetContext - The targeted request context object

    buildEventKeyNoContext

    public string buildEventKeyNoContext(any keySuffix, any targetEvent, any targetArgs)

    Build an event key according to passed in params

    Parameters:
    keySuffix - The key suffix used in the cache key
    targetEvent - The targeted ColdBox event executed
    targetArgs - A query string based argument collection like a query string

    buildHash

    public any buildHash(string args)

    Build a unique hash according to an incoming query string, mostly used when calling the clear functions of cache providers

    Parameters:
    args - A querystring based argument collection

    getCacheProvider

    public string getCacheProvider()

    getUniqueHash

    public string getUniqueHash(any event)

    Build a unique hash from an incoming request context

    Parameters:
    event - A request context object

    setCacheProvider

    public any setCacheProvider(any cacheProvider)

    Parameters:
    cacheProvider