CF_XSLT ColdFusion Custom Tag For Xml Transformations

Posted December 4, 2007 at 7:52 AM

Tags: ColdFusion

I was doing a bunch of stuff with XML and XSL Transformations in ColdFusion the other day and I got really tired of the fact that I had to create an intermediary XSLT variable before I could call the XmlTransform() method. To deal with this, I whipped up a quick little ColdFusion custom tag, xslt.cfm. This tag simply takes, as an attribute, an XML document (or string), and applies the XSL transformation defined within the tag contents to the given XML document. Here's how it works inside:

 Launch code in new window » Download code as text file »

  • <!--- Kill extra output. --->
  • <cfsilent>
  •  
  • <!---
  • Check to see which mode of the tag we are executing.
  • In the Start mode, we want to get the attributes. In
  • the End mode, once we have the XSL transformation,
  • we want to perform the transformation.
  • --->
  • <cfif (THISTAG.ExecutionMode EQ "Start")>
  •  
  • <!--- Param Attributes. --->
  •  
  • <!---
  • This is the XML document that we are going to
  • transform. It can be either an XML document object
  • or an XML string.
  • --->
  • <cfparam
  • name="ATTRIBUTES.XML"
  • type="any"
  • />
  •  
  • <!--- Exit the start mode of the tag. --->
  • <cfexit method="exittemplate" />
  •  
  • <cfelse>
  •  
  • <!---
  • Reset the generated output to be the result of
  • the XML transformation.
  • --->
  • <cfset THISTAG.GeneratedContent = XmlTransform(
  • Trim( ATTRIBUTES.XML ),
  • Trim( THISTAG.GeneratedContent )
  • ) />
  •  
  • </cfif>
  •  
  • </cfsilent>

Notice that in the Start execution mode of the tag, all we do is define the XML attribute. Then, in the End execution mode of the tag we simply replace the generated content with the result of the XmlTranform() method using the passed in the XML document and the existing generated content value.

To use the tag, you could do something like this:

 Launch code in new window » Download code as text file »

  • <!--- Build the XML document. --->
  • <cfxml variable="xmlData">
  •  
  • <page>
  • <navigation>
  • <item on="yes">
  • <text>Home</text>
  • <href>home.cfm</href>
  • </item>
  • <item>
  • <text>About</text>
  • <href>about.cfm</href>
  • </item>
  • <item>
  • <text>Contact Us</text>
  • <href>contact.cfm</href>
  • </item>
  • </navigation>
  • </page>
  •  
  • </cfxml>
  •  
  •  
  • <!--- Transform the xml data. --->
  • <cf_xslt xml="#xmlData#">
  •  
  • <?xml version="1.0" encoding="ISO-8859-1"?>
  •  
  • <xsl:transform
  • version="1.0"
  • xmlns:xsl="http://www.w3.org/1999/XSL/Transform">
  •  
  •  
  • <!--- Match primary navigation. --->
  • <xsl:template match="page/navigation">
  •  
  • <ul class="primarynav">
  • <xsl:apply-templates select="item" />
  • </ul>
  •  
  • </xsl:template>
  •  
  •  
  • <!--- Match primary navigation items. --->
  • <xsl:template match="item">
  •  
  • <li>
  • <xsl:if test="@on = 'yes'">
  • <xsl:attribute name="class">
  • <xsl:text>on</xsl:text>
  • </xsl:attribute>
  • </xsl:if>
  •  
  • <a>
  • <xsl:attribute name="href">
  • <xsl:value-of select="href" />
  • </xsl:attribute>
  •  
  • <xsl:value-of select="text" />
  • </a>
  • </li>
  •  
  • </xsl:template>
  •  
  • </xsl:transform>
  •  
  • </cf_xslt>

Here I am modelling the navigation of an HTML page and then using the CF_XSLT ColdFusion custom tag to render it in place. This might seem like a really small piece of functionality, but it ended up making my life easier.

Download Code Snippet ZIP File

Post Comment  |  Ask Ben  |  Permalink  |  Print Page



Learning ColdFusion 9 - ColdFusion 9 tutorials, samples, examples, demos

Reader Comments

There are no comments posted for this web log entry.


Post Comment  |  Ask Ben

Recent Blog Comments
klore
Nov 22, 2009 at 4:30 AM
jQuery Live() Method And Event Bubbling
dasegtezr ... read »
bloe
Nov 22, 2009 at 4:03 AM
jQuery Live() Method And Event Bubbling
C_fieri ... read »
anang
Nov 22, 2009 at 1:56 AM
Learning ColdFusion 9: Using CFQuery In CFScript Can Enable SQL Injection Attacks
Why adobe would give you script equivalent of cfquery is beyond me. I love cfquery tag because it helps me wriite clean sql, and get away from the horrible jdbc queries If I wanted to write javali ... read »
anang
Nov 22, 2009 at 1:45 AM
Streaming Text Using ColdFusion's CFContent Tag And The Variable Attribute
The reason you would want to do this is to stream. Ack json/xml files to ria clients I used thus technique before because putting json in response stream causes debugging info to come thru As well a ... read »
komik
Nov 21, 2009 at 6:47 PM
Hal Helms - Real World Object Oriented Development, Sarasota - Day Five
@charlie griefer, Thank you.. ... read »
Jody Fitzpatrick
Nov 21, 2009 at 5:15 PM
Using ColdFusion Structures To Remove Duplicate List Values
@Jose Galdamez, Oh heh yeah I didn't paste the whole code. I should have defined the vars -- my bad. It's fixed thou. Thanks. ... read »
Unibands
Nov 21, 2009 at 4:49 PM
Styling The ColdFusion 8 WriteToBrowser CFImage Output
Great work yet again Ben! Whilst I didn't use this whole code, I copied some of your regex code for a similar problem with the lack of an alt attribute and unescaped ampersands in CFIMAGE for Railo 3 ... read »
Justice
Nov 21, 2009 at 1:13 PM
My First ColdFusion Builder Extension - Encrypting And Decrypting CFM / CFC Files
@Ben, Because I am pedantic, I just want to make sure that everyone knows there is absolutely no encryption going on. There is only encoding and obfuscation. The cfencode tool only obfuscates your C ... read »