3-1-Tags:CFCache

last edited bygef on 06-Dec-2010

Page History

cfcache

Description

Speeds up page rendering when dynamic content does not have to be retrieved each time a user accesses the page. To accomplish this, cfcache creates temporary files that contain the static HTML returned from a ColdFusion page. You can use cfcache for simple URLs and URLs that contain URL parameters.

Category

Other

Implemented

Usage Syntax

<cfcache  
	[action="String"]
	[key="String"]
	[username="String"]
	[password="String"]
	[protocol="String"]
	[timespan="timespan"]
	[idletime="timespan"]
	[directory="String"]
	[cachedirectory="String"]
	[timeout="Any"]
	[expireURL="String"]
	[port="number"]
	[id="String"]
	[name="String"]
	[cachename="String"]
 />

[] = Optional attribute

Attributes

The actions get and put allow you to save and read elements that are stored in the cache specified in the administrator under "template cache". This is not the CFM template cache but the cache used for generating HTML snippets or templates with the help of this tag. In addition to the functions cache*() you can use the tag cfcache for the same purpose.

Example Usage

put

The following example shows you how to put any object into the default Railo template cache.

<cfcache acition="put" id="idforthekey" value="#value2store#" timespan="#createTimeSpan(0,0,10,0)#" idletime="#createTimeSpan(0,0,1,0)#">

If you want to use a different cache provider defined in the admin you need to provide the name attribute as well which specifies the name of one of in the admin defined caches. So the example should look like this:

<cfcache action="put" key="idforthekey" value"#value2store#" timespan="#createTimeSpan(0,0,10,0)#" idletime="#createTimeSpan(0,0,1,0)#" name="someCacheName">

get

This example returns the key stored above from the default cache:

<cfcache action="get" id="idforthekey" name="returnVar" cachename="someCacheName">

cache

clientcache

servercache

flush

optimal

content

The action content allows you to use the end <cfcache> tag as well. This gives you much more flexibility about what things to be cached. You can cache a normal HTML snippet defined by the attribute key. The attribute key can be as individual as needed. As soon as the tag <cfcache> is called within the defined timespan with the same key, it will deliver the content generated exactly for this key.

<cfcache action="content" key="#someKeyThatDistinguishesBetweenCachedValues#" timespan="#createTimeSpan(0,0,15,0)#">
	Something time intense that generates HTML like a header for example
</cfcache>

Here is an example for the same behavior as above but with the usage of a different cache defined in the Railo admin.

<cfcache action="content" key="#someKeyThatDistinguishesBetweenCachedValues#" timespan="#createTimeSpan(0,0,15,0)#" name="cacheName">
	Something time intense that generates HTML like a header for example
</cfcache>

This is how you would assign the cache value to a variable:

<cfsavecontent variable="sCache">
	<cfcache action="content" key="#irgendwaseindeutiges#" timespan="#createTimeSpan(0,0,15,0)#">
		Irgendetwas was einen output generiert	
	</cfcache>
</cfsavecontent>

Download in other Formats:
Markup | PDF | HTML | Word

Comments (2)

You need to login in order to comment!

Justin Stephen said

at 11:29:41 PM 31-Mar-2011

There is a compatibility difference between CF9 and Railo with action="serverCache". In CF9 when you close the cfcache tag while using the action of serverCache, it will only cache the content between that tag. Under Railo, any use of serverCache will cache the entire page, even when used with a closing cfcache tag. To mimic the behavior of CF9 under Railo, use action="content" instead of action="serverCache".

Gert Franz said

at 01:08:03 PM 01-Apr-2011

Yes that's because Adobe added this feature after we did and they decided to implement this differently. So we will I guess mimic the same functionality. We have noticed that quite often, that our implementation has been changed slightly for whatever reasons.