Publishers of technology books, eBooks, and videos for creative people

Home > Articles > Web Design & Development > Adobe ColdFusion

ColdFusion MX and Code Reuse: Custom Tags

The authors of Inside ColdFusion MX show you how to reuse code in ColdFusion MX using custom tags.
Like this article? We recommend

Like this article? We recommend

One of the coolest ways in which you can create code for reuse with ColdFusion is through the use of CFML custom tags. These custom tags enable you to create snippets of code that perform a very specific function and then use that code again and again throughout your application—all without having to rewrite the source code.

At first glance, creating your own custom tags to help modularize your code might seem like a daunting task. However, after you begin to understand how ColdFusion processes these tags, you'll be amazed at how simple the entire process can be.

To demonstrate the concept, let's create a hypothetical situation. Your boss has told you that on all pages throughout your corporate intranet, she wants to see an "Updated by so and so, on such and such a date" line of text so that she can tell when pages were last modified and who made the modification.

Obviously, each member of your intranet team responsible for creating and updating content could go into the source files each time they were modified and create or edit the following line of Hypertext Markup Language (HTML) code:

<H3><I>Last modified by Joe User on April 26, 2002</I></H3>

Although this might work for a while, it might not be the best way to do things. For instance, a programmer could inadvertently damage this line of code as he was modifying it.

Note also that an include wouldn't be the best way to handle this problem because the name of the user modifying the page might differ from page to page, and using an include would affect the intranet globally.

Fortunately, we can create a simple CFML-based custom tag to solve our problem. Take a look at the following code example, which creates the simple customer tag "CF_ModifiedBy". We'll then look at how to use this tag:

<!---Name: ModifiedBy.cfm
Description: Enables us to change the "modified by"
footer at the bottom of all of our intranet pages.
Author: Joe Programmer
Date: 4-26-2002
Attributes:
ModifiedBy: (Required) Specifies the name of the
person who is modifying the HTML code.
DateModified: (Required) Specifies the date that the
Document is being modified.--->
<cfparam name="attributes.modifiedby" default="">
<cfparam name="attributes.datemodified" default="">
<!---If a required parameter does not have a value passed
in, stop processing and throw an error.--->
<cfif NOT Len(attributes.modifiedby) OR NOT
Len(attributes.datemodified)>
<cfabort showerror="You must enter both your name and the
date as attributes!">
</cfif>
<cfoutput>
<h3><i>Last modified by #attributes.modifiedby#, on
#attributes.datemodified#</i></h3>
</cfoutput>

We've created our simple CFML custom tag. Now when someone wants to create a new CFML template that changes the modified-by line displayed at the bottom of the page, he or she can do it by adding this custom tag to the source of the CFML template, as in the following example:

<HTML>
	<HEAD>
		<TITLE>Sample Intranet Page</TITLE>
	</HEAD>
	<BODY>
	----SOME CODE----
<CF_ModifiedBy ModifiedBy="Joe Programmer"
DateModified="April 26, 2002">
</BODY>
</HTML>

After this code is in the source CFML, you can see how easy it is to go back in and change the ModifiedBy or DateModified attributes. This is certainly much easier than rewriting the respective line of code for every CFML document in which it needs to appear.

Now that you understand why you'd want to use CFML custom tags and how they are written, it helps to know how ColdFusion processes these tags.

When you create a CFML custom tag, you name it as you would any other CFML template. As in the previous example, the ModifiedBy tag was simply called ModifiedBy.cfm. By the way that we call it from within our CFML code, ColdFusion knows that we intend for this file to be used as a custom tag. By appending CF_ to the beginning of the template name, omitting the .cfm extension, and enclosing the name in <>, we are signaling to ColdFusion that we are about to invoke a custom tag.

Thus, to call a file named ModifiedBy.cfm as a CFML custom tag, we would place the following line of CFML in the calling template:

<CF_ModifiedBy>

After your custom tags are written, you can place them in the directory from which you are going to call them, or you can put them in a central custom tags directory. Placing custom tags in a central custom tags directory is the recommended method of storage. It provides a simple, easy-to-find repository for all your modular code. By default, this custom tag's directory is CFUSIONMX/CustomTags.

As you saw in our simple example, you can pass attributes into the custom tag from the calling page. After these variables are passed to the custom tag, you reference them by using the attributes scope. This helps differentiate variables being passed into the custom tag from those that are local variables within the custom tag.

Appending any attribute/value pair to a custom tag call causes that attribute/value pair to be passed into the custom tag. As an example, if we were using the CF_ModifiedBy tag in a CFML template, we might call it in the following manner:

<CF_ModifiedBy ModifiedBy="Joe Programmer"
        DateModifed="April 26, 2002"
        FavoriteColor="Green">

In this case, all the following attribute/value pairs are passed into the custom tag:

ModifiedBy=Joe Programmer
DateModified=April 26, 2002
FavoriteColor=Green

Of course, our custom tag is written to make use of only the ModifiedBy and DateModified attributes, so the FavoriteColor attribute is ignored. Nonetheless, it is still important to know that it is present in the attributes scope.

If you want to make a specific attribute a "required" attribute, you can write logic within the custom tag to ensure that all required attributes get passed in. You can see in our CF_ModifiedBy example that we have done this by using CFIF statements to ensure that if the ModifiedBy and DateModified attributes are not present, we stop processing and present the user with an appropriate error.

Peachpit Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Peachpit and its family of brands. I can unsubscribe at any time.

Overview


Pearson Education, Inc., 221 River Street, Hoboken, New Jersey 07030, (Pearson) presents this site to provide information about Peachpit products and services that can be purchased through this site.

This privacy notice provides an overview of our commitment to privacy and describes how we collect, protect, use and share personal information collected through this site. Please note that other Pearson websites and online products and services have their own separate privacy policies.

Collection and Use of Information


To conduct business and deliver products and services, Pearson collects and uses personal information in several ways in connection with this site, including:

Questions and Inquiries

For inquiries and questions, we collect the inquiry or question, together with name, contact details (email address, phone number and mailing address) and any other additional information voluntarily submitted to us through a Contact Us form or an email. We use this information to address the inquiry and respond to the question.

Online Store

For orders and purchases placed through our online store on this site, we collect order details, name, institution name and address (if applicable), email address, phone number, shipping and billing addresses, credit/debit card information, shipping options and any instructions. We use this information to complete transactions, fulfill orders, communicate with individuals placing orders or visiting the online store, and for related purposes.

Surveys

Pearson may offer opportunities to provide feedback or participate in surveys, including surveys evaluating Pearson products, services or sites. Participation is voluntary. Pearson collects information requested in the survey questions and uses the information to evaluate, support, maintain and improve products, services or sites; develop new products and services; conduct educational research; and for other purposes specified in the survey.

Contests and Drawings

Occasionally, we may sponsor a contest or drawing. Participation is optional. Pearson collects name, contact information and other information specified on the entry form for the contest or drawing to conduct the contest or drawing. Pearson may collect additional personal information from the winners of a contest or drawing in order to award the prize and for tax reporting purposes, as required by law.

Newsletters

If you have elected to receive email newsletters or promotional mailings and special offers but want to unsubscribe, simply email ask@peachpit.com.

Service Announcements

On rare occasions it is necessary to send out a strictly service related announcement. For instance, if our service is temporarily suspended for maintenance we might send users an email. Generally, users may not opt-out of these communications, though they can deactivate their account information. However, these communications are not promotional in nature.

Customer Service

We communicate with users on a regular basis to provide requested services and in regard to issues relating to their account we reply via email or phone in accordance with the users' wishes when a user submits their information through our Contact Us form.

Other Collection and Use of Information


Application and System Logs

Pearson automatically collects log data to help ensure the delivery, availability and security of this site. Log data may include technical information about how a user or visitor connected to this site, such as browser type, type of computer/device, operating system, internet service provider and IP address. We use this information for support purposes and to monitor the health of the site, identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents and appropriately scale computing resources.

Web Analytics

Pearson may use third party web trend analytical services, including Google Analytics, to collect visitor information, such as IP addresses, browser types, referring pages, pages visited and time spent on a particular site. While these analytical services collect and report information on an anonymous basis, they may use cookies to gather web trend information. The information gathered may enable Pearson (but not the third party web trend services) to link information with application and system log data. Pearson uses this information for system administration and to identify problems, improve service, detect unauthorized access and fraudulent activity, prevent and respond to security incidents, appropriately scale computing resources and otherwise support and deliver this site and its services.

Cookies and Related Technologies

This site uses cookies and similar technologies to personalize content, measure traffic patterns, control security, track use and access of information on this site, and provide interest-based messages and advertising. Users can manage and block the use of cookies through their browser. Disabling or blocking certain cookies may limit the functionality of this site.

Do Not Track

This site currently does not respond to Do Not Track signals.

Security


Pearson uses appropriate physical, administrative and technical security measures to protect personal information from unauthorized access, use and disclosure.

Children


This site is not directed to children under the age of 13.

Marketing


Pearson may send or direct marketing communications to users, provided that

  • Pearson will not use personal information collected or processed as a K-12 school service provider for the purpose of directed or targeted advertising.
  • Such marketing is consistent with applicable law and Pearson's legal obligations.
  • Pearson will not knowingly direct or send marketing communications to an individual who has expressed a preference not to receive marketing.
  • Where required by applicable law, express or implied consent to marketing exists and has not been withdrawn.

Pearson may provide personal information to a third party service provider on a restricted basis to provide marketing solely on behalf of Pearson or an affiliate or customer for whom Pearson is a service provider. Marketing preferences may be changed at any time.

Correcting/Updating Personal Information


If a user's personally identifiable information changes (such as your postal address or email address), we provide a way to correct or update that user's personal data provided to us. This can be done on the Account page. If a user no longer desires our service and desires to delete his or her account, please contact us at customer-service@informit.com and we will process the deletion of a user's account.

Choice/Opt-out


Users can always make an informed choice as to whether they should proceed with certain services offered by Adobe Press. If you choose to remove yourself from our mailing list(s) simply visit the following page and uncheck any communication you no longer want to receive: www.peachpit.com/u.aspx.

Sale of Personal Information


Pearson does not rent or sell personal information in exchange for any payment of money.

While Pearson does not sell personal information, as defined in Nevada law, Nevada residents may email a request for no sale of their personal information to NevadaDesignatedRequest@pearson.com.

Supplemental Privacy Statement for California Residents


California residents should read our Supplemental privacy statement for California residents in conjunction with this Privacy Notice. The Supplemental privacy statement for California residents explains Pearson's commitment to comply with California law and applies to personal information of California residents collected in connection with this site and the Services.

Sharing and Disclosure


Pearson may disclose personal information, as follows:

  • As required by law.
  • With the consent of the individual (or their parent, if the individual is a minor)
  • In response to a subpoena, court order or legal process, to the extent permitted or required by law
  • To protect the security and safety of individuals, data, assets and systems, consistent with applicable law
  • In connection the sale, joint venture or other transfer of some or all of its company or assets, subject to the provisions of this Privacy Notice
  • To investigate or address actual or suspected fraud or other illegal activities
  • To exercise its legal rights, including enforcement of the Terms of Use for this site or another contract
  • To affiliated Pearson companies and other companies and organizations who perform work for Pearson and are obligated to protect the privacy of personal information consistent with this Privacy Notice
  • To a school, organization, company or government agency, where Pearson collects or processes the personal information in a school setting or on behalf of such organization, company or government agency.

Links


This web site contains links to other sites. Please be aware that we are not responsible for the privacy practices of such other sites. We encourage our users to be aware when they leave our site and to read the privacy statements of each and every web site that collects Personal Information. This privacy statement applies solely to information collected by this web site.

Requests and Contact


Please contact us about this Privacy Notice or if you have any requests or questions relating to the privacy of your personal information.

Changes to this Privacy Notice


We may revise this Privacy Notice through an updated posting. We will identify the effective date of the revision in the posting. Often, updates are made to provide greater clarity or to comply with changes in regulatory requirements. If the updates involve material changes to the collection, protection, use or disclosure of Personal Information, Pearson will provide notice of the change through a conspicuous notice on this site or other appropriate way. Continued use of the site after the effective date of a posted revision evidences acceptance. Please contact us if you have questions or concerns about the Privacy Notice or any objection to any revisions.

Last Update: November 17, 2020