Home / Articles / Learn to Write Script-Based Syntax in ColdFusion 8: It's Easier Than It Sounds

Learn to Write Script-Based Syntax in ColdFusion 8: It's Easier Than It Sounds

  • Sample Chapter is provided courtesy of Adobe Press.
  • Date: Mar 28, 2008.

Chapter Description

The world's leading ColdFusion experts show you how to use script-based syntax to make writing code just a little easer in ColdFusion 8.

What Is <cfscript>?

ColdFusion scripting allows you to write portions of your templates with script-based syntax, which is often more concise and straightforward than ColdFusion’s traditional tag-based syntax. While you can’t do everything with <cfscript> that you currently do with tag-based syntax, as you will later see, you may find that writing substantial portions of your code using scripting syntax is more natural for you.

Scripting syntax is very similar to JavaScript syntax with a couple of exceptions that we’ll discuss soon. Listing 44.1 is an example of a tag-based index loop and its <cfscript> counterpart. Try running Listing 44.1 by alternately commenting-out the tag-based version and the <cfscript> version, and you’ll see that each version does the same thing.

Listing 44.1. ScriptingExample.cfm—An Example of ColdFusion Scripting

<!--- Author: Charlie Arehart -- carehart.org --->
<!--- Find cookies other than CFID/CFTOKEN --->
<cfparam name="test" default="1">

<!--- Tag-based structure loop --->
<cfloop collection="#cookie#" item="cname">
   <cfif cname neq "cfid" and cname neq "cftoken">
      <cfoutput>
         #cname# <br>
      </cfoutput>
   </cfif>
</cfloop>

<p>

<cfscript>
// Script-based structure loop
for (cname in cookie) {
   if (cname != "cfid" && cname != "cftoken"){
      writeoutput(cname & "<br>");
   }
}
</cfscript>

For many, the scripted loop is more readable and intuitive than the tag-based loop. It uses familiar constructs from other script-based languages (such as // for comments, != for “not equal,” && for “and,” semicolons to end each statement, bracketed loop and if blocks, and not a single pound-sign needed). While this sort of syntax may be foreign to long-time ColdFusion developers, it’s found in many other languages and so makes some developers more comfortable.

Even so, scripting may also appeal to traditional CFML developers, at least in some circumstances. Often, a block of code will simply look cleaner if replaced with a script-based equivalent (a good example is a long list of <cfset> tags.) Similarly, ColdFusion 8’s new implicit array and structure creation tags, though not unique to CFSCRIPT, do add to the improved experience of creating cleaner, more concise CFML code. (Implicit array and structure creation is discussed in Chapter 8, “The Basics of CFML,” in Adobe ColdFusion 8 Web Application Construction Kit, Volume 1: Getting Started.)

As you’ll learn while you read this chapter, ColdFusion scripting has various differences (some advantages and disadvantages) compared to tag-based CFML.

What You Can and Cannot Do with <cfscript>

<cfscript> is a useful alternative to tag-based CFML, but you can’t just replace all your tag-based CFML with scripting because there are things you can do with tags that you can’t do with scripting. For example, scripting can only contain variable assignments, flow-control logic, exception handling, and function calls. You can’t directly query a database, read a file from disk, or perform any other task that requires the use of CFML tags.

The following section explains the differences between <cfscript> and tag-based syntax. In each section, the <cfscript> example is shown first, followed by the tag-based version.

Assignment

   myVariable = "Value";

   <cfset myVariable = "Value">

Output

   Writeoutput(somevar);

   <cfoutput>#somevar#</cfoutput>

If-Elseif-Else

   if(condition1) {
     [logic];
   } else if(condition2) {
     [logic];
   } else {
     [logic];
   }

   <cfif condition1>
     [logic]
   <cfelseif condition2>
     [logic]
   <cfelse>
     [logic]
   </cfif>

Switch-Case

   switch(expression) {
     case "value1":
       [logic];
       break;
     case "value2":
       [logic];
       break;
     default:
       [logic];
   }

   <cfswitch expression="">
     <cfcase value="value1">
       [logic]
     </cfcase>
     <cfcase value="value2">
       [logic]
     </cfcase>
     <cfdefaultcase>
       [logic]
     </cfdefaultcase>
   </cfswitch>

For Loops

   for(i=1; i <= 10; i++) {
     [logic];
   }

   <cfloop index="i" from="1" to="10">
     [logic]
   </cfloop>

While Loops

   while(expression) {
     [logic];
   }

   <cfloop condition="#expression#">
     [logic];
   </cfloop>

Do-While Loops

   do {
     [logic];
   } while(expression);

   (No tag-based equivalent)

For-In Loops

   for(key in structure) {
     [logic];
   }

   <cfloop collection="#structure#" item="key">
     [logic]
   </cfloop>

Array Loops

   for(i=1; i <= ArrayLen(array); i++) {
     [logic]
   }

   <cfloop array="#array#" index="currentArrayElement">
     [logic]
   </cfloop>

List Loops

   for(i=1; i <= ListLen(list); i++) {
     [logic]
   }

   <cfloop list="#listOfValues#" index="currentListItem">
     [logic]
   </cfloop>

Query Loops

   (no script-based equivalent)

   <cfloop query="queryName">
     [logic]
   </cfloop>

Break

   break;

   <cfbreak>

Continue

   continue;

   (No tag-based equivalent)

Object Processing

   cfobject(...);

   <cfobject ...>

Exception Handling

   try {
     [logic];
   }
   catch(Expression exception) {
     [logic];
   }
   catch(Any exception) {
     [logic];
   }

   <cftry>
     [logic]
     <cfcatch type="Expression">
       [logic];
     </cfcatch>
     <cfcatch type="Any">
       [logic];
     </cfcatch>
   </cftry>

Throwing a Custom Exception

   (no script-based equivalent)

   <cfthrow
     type="BusinessRule.Customer"
     errorCode="66020"
     message="Non-wholesale customer"
     detail="Only registered wholesale customers may place bulk orders.">

Rethrowing a Caught Exception

   (no script-based equivalent)

   <cfrethrow>

Functions

   function myFunction(arg1, arg2) {
     var value = 0;
     [logic];
     return value;
   }

   <cffunction name="myFunction" returntype="numeric">
     <cfargument name="arg1" type="numeric">
     <cfargument name="arg2" type="numeric">
     <cfset var value = 0>
     [logic]
     <cfreturn value>
   </cffunction>

Besides the few examples above which indicate no script-based equivalent, there are some other differences between CFML tags and Script-based alternatives, such as with switch-case and try-catch processing, which will be explored later in the sections, “Flow Control Using <cfscript>”and “Exception Handling in <cfscript>,” respectively,

Differences Between <cfscript> and JavaScript

You’ll notice that <cfscript> looks a lot like JavaScript and other familiar scripting languages, but there are some differences compared to those as well. First, a difference compared to JavaScript is that ColdFusion is absolutely fanatical about terminating all statements with a semicolon. Another major difference is that ColdFusion scripting is executed entirely on the server side, as opposed to JavaScript, which is executed entirely in the user’s browser. There is no Document Object Model (DOM) for ColdFusion scripting to access or manipulate, because ColdFusion has no sense of a “document.”

Why Use <cfscript>?

Sure, ColdFusion scripting does offer a few things that tag-based CFML lacks, such as do-while loops and the ability to skip loop iterations using continue. On the other hand, there are just as many if not more things offered by tag-based CFML that ColdFusion scripting lacks. So why use <cfscript> for anything other than its few unique capabilities?

  • <cfscript> integrates a familiar, JavaScript-like syntax into ColdFusion.
  • <cfscript> provides access to all ColdFusion variables and objects, using a more-intuitive and easier-to-read format.
  • <cfscript> supports all ColdFusion functions and introduces a few features and functions not available to its tag-based counterpart.
2. Implementing <cfscript> | Next Section

Adobe Press Promotional Mailings & Special Offers

I would like to receive exclusive offers and hear about products from Adobe Press 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 Adobe Press 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.adobepress.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