private void checkIfClearDefaultStrategy( )

Parameters:

Code:

	<cffunction name="checkIfClearDefaultStrategy" access="private" returntype="void" output="false"
		hint="Checks and sets if the default strategy should be cleared (e.g. <cache-clear />).">
		
		<cfif NOT isIdsDefined() AND NOT isAliasesDefined() AND NOT isStrategyNamesDefined()>
			<cfset setClearDefaultStrategy(true) />
		</cfif>
	</cffunction> 

private void clearCacheByAliases( CacheManager cacheManager, Event event )

Helper method to clear cache elements by alias/aliases.

Parameters:

CacheManager cacheManager

Event event

Code:

	<cffunction name="clearCacheByAliases" access="private" returntype="void" output="false"
		hint="Helper method to clear cache elements by alias/aliases.">
		<cfargument name="cacheManager" type="MachII.framework.CacheManager" required="true" />
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		
		<cfset var currentAlias = "" />
		
		<cfloop list="#getAliases()#" index="currentAlias">
			<cfset arguments.cacheManager.clearCachesByAlias(currentAlias, arguments.event, getCriteria()) />
		</cfloop>
	</cffunction> 

private void clearCacheByDefaultStrategy( CacheManager cacheManager )

Helper method to clear default cache strategy.

Parameters:

CacheManager cacheManager

Code:

	<cffunction name="clearCacheByDefaultStrategy" access="private" returntype="void" output="false"
		hint="Helper method to clear default cache strategy.">
		<cfargument name="cacheManager" type="MachII.framework.CacheManager" required="true" />
		<cfset arguments.cacheManager.clearCacheByStrategyName(cacheManager.getDefaultCacheName()) />
	</cffunction> 

private void clearCacheByIds( CacheManager cacheManager, Event event )

Helper method to clear cache elements by id/ids.

Parameters:

CacheManager cacheManager

Event event

Code:

	<cffunction name="clearCacheByIds" access="private" returntype="void" output="false"
		hint="Helper method to clear cache elements by id/ids.">
		<cfargument name="cacheManager" type="MachII.framework.CacheManager" required="true" />
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		
		<cfset var currentId = "" />
		
		<cfloop list="#getIds()#" index="currentId">
			<cfset arguments.cacheManager.clearCacheById(currentId, arguments.event, getCriteria()) />
		</cfloop>
	</cffunction> 

private void clearCacheByStrategyNames( CacheManager cacheManager )

Helper method to clear cache elements by strategy name/names.

Parameters:

CacheManager cacheManager

Code:

	<cffunction name="clearCacheByStrategyNames" access="private" returntype="void" output="false"
		hint="Helper method to clear cache elements by strategy name/names.">
		<cfargument name="cacheManager" type="MachII.framework.CacheManager" required="true" />
		
		<cfset var currentStrategyName = "" />
		
		<cfloop list="#getStrategyNames()#" index="currentStrategyName">
			<cfset arguments.cacheManager.clearCacheByStrategyName(currentStrategyName) />
		</cfloop>
	</cffunction> 

public boolean execute( Event event, EventContext eventContext )

Executes a caching block.

Parameters:

Event event

EventContext eventContext

Code:

	<cffunction name="execute" access="public" returntype="boolean" output="false"
		hint="Executes a caching block.">
		<cfargument name="event" type="MachII.framework.Event" required="true" />
		<cfargument name="eventContext" type="MachII.framework.EventContext" required="true" />
		
		<cfset var expressionResult = "" />
		<cfset var cacheManager = arguments.eventContext.getAppManager().getCacheManager() />
		<cfset var log = getLog() />
				
		
		<cfif NOT isConditionDefined()>
			
			<cfif getClearDefaultStrategy()>
				<cfif log.isDebugEnabled()>
					<cfset log.debug("Clearing default cache strategy '#cacheManager.getDefaultCacheName()#' (no condition to evaluate).") />
				</cfif>
				<cfset clearCacheByDefaultStrategy(cacheManager) />
			
			<cfelse>
				
				<cfif isIdsDefined()>
					<cfif log.isDebugEnabled()>
						<cfset log.debug("Clearing cache by ids '#getIds()#' (no condition to evaluate).") />
					</cfif>
					<cfset clearCacheByIds(cacheManager, arguments.event) />
				</cfif>
				
				<cfif isAliasesDefined()>
					<cfif log.isDebugEnabled()>
						<cfset log.debug("Clearing cache by aliases '#getAliases()#' (no condition to evaluate).") />
					</cfif>
					<cfset clearCacheByAliases(cacheManager, arguments.event) />
				</cfif>
				
				<cfif isStrategyNamesDefined()>
					<cfif log.isDebugEnabled()>
						<cfset log.debug("Clearing cache by strategyNames '#getStrategyNames()#' (no condition to evaluate).") />
					</cfif>
					<cfset clearCacheByStrategyNames(cacheManager) />
				</cfif>
			</cfif>
		<cfelse>
			<cfif variables.expressionEvaluator.isExpression(getCondition())>
				<cfset expressionResult = variables.expressionEvaluator.evaluateExpression(getCondition(), 
						arguments.event, getPropertyManager()) />
			<cfelse>
				<cfset expressionResult = variables.expressionEvaluator.evaluateExpressionBody(getCondition(), 
						arguments.event, getPropertyManager()) />
			</cfif>
			<cfif isBoolean(expressionResult) AND expressionResult>
				
				<cfif getClearDefaultStrategy()>
					<cfif log.isDebugEnabled()>
						<cfset log.debug("Clearing default cache strategy '#cacheManager.getDefaultCacheName()#' (condition '#getCondition()#' evaluated true).") />
					</cfif>
					<cfset clearCacheByDefaultStrategy(cacheManager) />
				
				<cfelse>
					
					<cfif isIdsDefined()>
						<cfif log.isDebugEnabled()>
							<cfset log.debug("Clearing cache by ids '#getIds()#' (condition '#getCondition()#' evaluated true).") />
						</cfif>
						<cfset clearCacheByIds(cacheManager, arguments.event) />
					</cfif>
					
					<cfif isAliasesDefined()>
						<cfif log.isDebugEnabled()>
							<cfset log.debug("Clearing cache by aliases '#getAliases()#' (condition '#getCondition()#' evaluated true).") />
						</cfif>
						<cfset clearCacheByAliases(cacheManager, arguments.event) />
					</cfif>
					
					<cfif isStrategyNamesDefined()>
						<cfif log.isDebugEnabled()>
							<cfset log.debug("Clearing cache by strategyNames '#getStrategyNames()#' (condition '#getCondition()#' evaluated true).") />
						</cfif>
						<cfset clearCacheByStrategyNames(cacheManager) />
					</cfif>
				</cfif>
			<cfelseif isBoolean(expressionResult) AND NOT expressionResult>
				<cfif log.isDebugEnabled()>
					
					<cfif getClearDefaultStrategy()>
						<cfset log.debug("Cannot clear default cache strategy '#cacheManager.getDefaultCacheName()#' (condition '#getCondition()#' evaluated false).") />
					<cfelse>
						<cfif isIdsDefined()>
							<cfset log.debug("Cannot clear cache by ids '#getIds()#' (condition '#getCondition()#' evaluated false).") />
						</cfif>
						<cfif isAliasesDefined()>
							<cfset log.debug("Cannot clear cache by aliases '#getAliases()#' (condition '#getCondition()#' evaluated false).") />
						</cfif>
						<cfif isStrategyNamesDefined()>
							<cfset log.debug("Cannot clear cache by strategyNames '#getStrategyNames()#' (condition '#getCondition()#' evaluated false).") />
						</cfif>
					</cfif>
				</cfif>
			<cfelse>
				
				<cfif log.isErrorEnabled()>
					<cfif getClearDefaultStrategy()>
						<cfset log.error("Cannot clear default cache strategy '#cacheManager.getDefaultCacheName()#' (condition '#getCondition()#' which evaulated to '#expressionResult#' did not evaluate to a boolean).") />
					<cfelse>
						<cfif isIdsDefined()>
							<cfset log.error("Cannot clear cache by ids '#getIds()#' (condition '#getCondition()#' which evaulated to '#expressionResult#' did not evaluate to a boolean).") />
						</cfif>
						<cfif isAliasesDefined()>
							<cfset log.error("Cannot clear cache by aliases '#getAliases()#' (condition '#getCondition()#' which evaulated to '#expressionResult#' did not evaluate to a boolean).") />
						</cfif>
						<cfif isStrategyNamesDefined()>
							<cfset log.error("Cannot clear cache by strategyNames '#getStrategyNames()#' (condition '#getCondition()#' which evaulated to '#expressionResult#' did not evaluate to a boolean).") />
						</cfif>
					</cfif>
				</cfif>
			</cfif>
		</cfif>
		
		<cfreturn true />
	</cffunction> 

public string getAliases( )

Parameters:

Code:

	<cffunction name="getAliases" access="public" returntype="string" output="false">
		<cfreturn variables.aliases />
	</cffunction> 

public boolean getClearDefaultStrategy( )

Parameters:

Code:

	<cffunction name="getClearDefaultStrategy" access="public" returntype="boolean" output="false">
		<cfreturn variables.clearDefaultStrategy />
	</cffunction> 

public string getCondition( )

Parameters:

Code:

	<cffunction name="getCondition" access="public" returntype="string" output="false">
		<cfreturn variables.condition />
	</cffunction> 

public string getCriteria( )

Parameters:

Code:

	<cffunction name="getCriteria" access="public" returntype="string" output="false">
		<cfreturn variables.criteria />
	</cffunction> 

public string getIds( )

Parameters:

Code:

	<cffunction name="getIds" access="public" returntype="string" output="false">
		<cfreturn variables.ids />
	</cffunction> 

public string getStrategyNames( )

Parameters:

Code:

	<cffunction name="getStrategyNames" access="public" returntype="string" output="false">
		<cfreturn variables.strategyNames />
	</cffunction> 

public CacheClearCommand init( [string ids=""], [string aliases=""], [string strategyNames=""], [string criteria=""], [string condition=""] )

Initializes the command.

Parameters:

[string ids=""]

[string aliases=""]

[string strategyNames=""]

[string criteria=""]

[string condition=""]

Code:

	<cffunction name="init" access="public" returntype="CacheClearCommand" output="false"
		hint="Initializes the command.">
		<cfargument name="ids" type="string" required="false" default="" />
		<cfargument name="aliases" type="string" required="false" default="" />
		<cfargument name="strategyNames" type="string" required="false" default="" />
		<cfargument name="criteria" type="string" required="false" default="" />
		<cfargument name="condition" type="string" required="false" default="" />
		
		<cfset setIds(arguments.ids) />
		<cfset setAliases(arguments.aliases) />
		<cfset setStrategyNames(arguments.strategyNames) />
		<cfset setCriteria(arguments.criteria) />
		<cfset setCondition(arguments.condition) />
		
		
		<cfset checkIfClearDefaultStrategy() />

		<cfreturn this />
	</cffunction> 

public boolean isAliasesDefined( )

Checks if aliases are defined.

Parameters:

Code:

	<cffunction name="isAliasesDefined" access="public" returntype="boolean" output="false"
		hint="Checks if aliases are defined.">
		<cfreturn Len(variables.aliases) />
	</cffunction> 

public boolean isConditionDefined( )

Checks if a condition is defined.

Parameters:

Code:

	<cffunction name="isConditionDefined" access="public" returntype="boolean" output="false"
		hint="Checks if a condition is defined.">
		<cfreturn Len(variables.condition) />
	</cffunction> 

public boolean isIdsDefined( )

Checks if ids are defined.

Parameters:

Code:

	<cffunction name="isIdsDefined" access="public" returntype="boolean" output="false"
		hint="Checks if ids are defined.">
		<cfreturn Len(variables.ids) />
	</cffunction> 

public boolean isStrategyNamesDefined( )

Checks if a cache strategy names are defined.

Parameters:

Code:

	<cffunction name="isStrategyNamesDefined" access="public" returntype="boolean" output="false"
		hint="Checks if a cache strategy names are defined.">
		<cfreturn Len(variables.strategyNames) />
	</cffunction> 

private void setAliases( string aliases )

Parameters:

string aliases

Code:

	<cffunction name="setAliases" access="private" returntype="void" output="false">
		<cfargument name="aliases" type="string" required="true" />
		<cfset variables.aliases = arguments.aliases />
	</cffunction> 

private void setClearDefaultStrategy( boolean clearDefaultStrategy )

Parameters:

boolean clearDefaultStrategy

Code:

	<cffunction name="setClearDefaultStrategy" access="private" returntype="void" output="false">
		<cfargument name="clearDefaultStrategy" type="boolean" required="true" />
		<cfset variables.clearDefaultStrategy = arguments.clearDefaultStrategy />
	</cffunction> 

private void setCondition( string condition )

Parameters:

string condition

Code:

	<cffunction name="setCondition" access="private" returntype="void" output="false">
		<cfargument name="condition" type="string" required="true" />
		<cfset variables.condition = arguments.condition />
	</cffunction> 

private void setCriteria( string criteria )

Parameters:

string criteria

Code:

	<cffunction name="setCriteria" access="private" returntype="void" output="false">
		<cfargument name="criteria" type="string" required="true" />
		<cfset variables.criteria = arguments.criteria />
	</cffunction> 

private void setIds( string ids )

Parameters:

string ids

Code:

	<cffunction name="setIds" access="private" returntype="void" output="false">
		<cfargument name="ids" type="string" required="true" />
		<cfset variables.ids = arguments.ids />
	</cffunction> 

private void setStrategyNames( string strategyNames )

Parameters:

string strategyNames

Code:

	<cffunction name="setStrategyNames" access="private" returntype="void" output="false">
		<cfargument name="strategyNames" type="string" required="true" />
		<cfset variables.strategyNames = arguments.strategyNames />
	</cffunction>