coldfusion-codeguide

KO | EN

gitlite — search

#javascript #hacktoberfest #typescript #llm #golang #go #machine-learning #linux #nodejs #java #windows #security #openai #open-source

coldfusion-codeguide

(★ 11)

Reference for developers who are new to the language or need a quick refresh.

coldfusion-codeguide Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# ColdFusion CodeGuide

ColdFusion code guide for developers who are new to the language or need a quick refresh.

## Table of Contents

* [Variables](#variables)
* [Arrays](#arrays)
* [Structures](#structures)
* [Switch Case](#switch-case)
* [Comparison and Logical Operators](#comparison-and-logical-operators)
* [Loops](#loops)
* [JSON](#json)
* [Functions](#functions)
* [Components](#components)
* [Database Queries](#database-queries)
* [Stored Procedures](#stored-procedures)
* [Catch/Try](#catch-try)
* [Includes](#includes)

---

## <a name="variables">Variables</a>

**Tag notation**
```cfm

<cfset padawan = "Kris">

<cfoutput>#padawan#</cfoutput>

<cfdump var = "#padawan#">
```

**Script notation**
```cfm
<cfscript>
  // Set variable
  master = "Yoda";

// Variable output
  WriteOutput(master);

// Variable dump
  WriteDump(master);
</cfscript>
```

---

## <a name="arrays">Arrays</a>

[Array Functions](http://help.adobe.com/en_US/ColdFusion/10.0/Developing/WSc3ff6d0ea77859461172e0811cbec09f0b-8000.html)

**Tag notation**
```cfm

<cfset padawans = [ "Eric", "Sean", "Jake" ]>

<cfdump var="#padawans#">

<cfloop array="#padawans#" index="padawan">
  <cfoutput>#padawan#</cfoutput>
</cfloop>
```

**Script notation**
```cfm
<cfscript>
  // Set array
  masters = [ "Qui-Gon Jinn", "Obi-Wan Kenobi", "Yoda" ];

// Array dump
  WriteDump(masters);

// Loop over array
  for (master in masters) {
    WriteOutput(master);
  }
</cfscript>
```

---

## <a name="structures">Structures</a>

[Structure Functions](http://help.adobe.com/en_US/ColdFusion/10.0/Developing/WSc3ff6d0ea77859461172e0811cbec22c24-6210.html)

**Tag notation**
```cfm

<cfset padawan = {}>

<cfset padawan["name"] = "Kris">

<cfset padawan.side = "Light">

<cfdump var="#padawan#">

<cfset master = {
  "name": "Yoda",
  "side": "Light"
}>

<cfloop collection="#master#" item="key">
  <cfoutput>#key#: #master[key]#</cfoutput>
</cfloop>
```

**Script notation**
```cfm
<cfscript>
  // Set struct
  sith = {};

// Append item to struct using bracket notation (case sensitive)
  sith["name"] = "Vader";

// Append item to struct using dot notation (case insensitive)
  sith.side = "Dark";

// Dump struct
  WriteDump(sith);

// Set struct and append content in single statement
  lord = {
    "name": "Sidious",
    "side": "Dark"
  };

// Loop over struct
  for (key in lord) {
    WriteOutput("#key#: #lord[key]#");
  }
</cfscript>
```

---

## <a name="switch-case">Switch Case</a>
**Tag notation**
```cfm

<cfset padawan = "Kris">

<cfswitch expression="#padawan#">
  <cfcase value="Kris">

</cfcase>
  <cfcase value="Eric">

</cfcase>
  <cfcase value="Sean, Jake">

</cfcase>
  <cfdefaultcase>

</cfdefaultcase>
</cfswitch>
```

**Script notation**
```cfm
<cfscript>
  // Set variable
  jedi = "Yoda";

// Switch case statement
  switch(jedi) {
    case "Yoda":

break;
    case "Obi-Wan Kenobi":

break;
    case "Qui-Gon Jinn": case "Mace Windu":

break;
    default:

break;
  }
</cfscript>
```

---

## <a name="comparison-and-logical-operators">Comparison and Logical Operators</a>
| Description | Tag operator | Script operator |
| --- | --- | --- |
| Equal | is, equal, eq  | == |
| Not equal | is not, not equal, neq | != |
| Greater than | gt, greater than | > |
| Greater than or equal | greater than or equal to, ge, gte | >= |
| Less than | lt, less than | < |
| Less than or equal | less than or equal to, le, lte | <= |
| And | and | &amp;&amp; |
| Or | or | &#124;&#124; |

[Operator Types](http://help.adobe.com/en_US/ColdFusion/10.0/Developing/WSc3ff6d0ea77859461172e0811cbec09d55-7ffc.html)

**Tag notation**
```cfm

<cfset age = 10>

<cfif age eq 15>

</cfif>

<cfset height = 3>

<cfset jedi = (height lte 3) ? "Yoda" : "Obi-Wan Kenobi">

<cfdump var="#jedi#">
```

**Script notation**
```cfm
<cfscript>
  // Set variable
  count = 10;

// Simple if/elseif/else
  if (count == 15) {

} else if (count >= 30) {

} else if (count <= 5) {

} else if (count > 10 || count < 10) {

} else {

}

// Set variable
  power = 7;

// Ternary operator
  sith = (power <= 8) ? "Sidious" : "Vader";

// Dump sith
  WriteDump(sith);
</cfscript>
```

---

## <a name="loops">Loops</a>

**Tag notation**
```cfm

<cfloop from="1" to="10" index="i">
  <cfoutput>#i#</cfoutput>
</cfloop>

<cfloop from="1" to="10" index="i">
  <cfoutput>#i#</cfoutput>
  <cfbreak>
</cfloop>

<cfloop from="1" to="10" index="i">
  <cfif i mod 2 eq 0>
    <cfcontinue>
  </cfif>
  <cfoutput>#i#</cfoutput>
</cfloop>
```

**Script notation**
```cfm
<cfscript>
  // Loop
  for (i=1; i <= 10; i++) {
    WriteOutput(i);
  }

// Loop break
  for (i=1; i <= 10; i++) {
    WriteOutput(i);
    break;
  }

// Loop skip
  for (i=1; i <= 10; i++) {
    if (i mod 2 == 0) {
      continue;
    }
    WriteOutput(i);
  }

// While loop
  k = 0;
  while (k < 10) {
    k++;
    WriteOutput(k);
  }

// Do/While loop
  s = 0;
  do {
    s++;
    WriteOutput(s);
  } while (s LT 10);
</cfscript>
```

---

## <a name="json">JSON</a>

**Tag notation**
```cfm

<cfset jedi = {
  "name": "Luke Skywalker",
  "side": "Light",
  "starfighter": "X-Wing"
}>

<cfset jediToJSON = serializeJSON(jedi)>

<cfset jediFromJSON = deserializeJSON(jediToJSON)>

<cfdump var = "#jediToJSON#">
<cfdump var = "#jediFromJSON#">
```

**Script notation**
```cfm
<cfscript>
  // Set struct
  sith = {
    "name": "Darth Vader",
    "side": "Dark",
    "starfighter": "TIE fighter"
  };

// Serialize to JSON
  sithToJSON = serializeJSON(sith);

// Deserialize from JSON
  sithFromJSON = deserializeJSON(sithToJSON);

// Dump
  WriteDump(sithToJSON);
  WriteDump(sithFromJSON);
</cfscript>
```

---

## <a name="functions">Functions</a>

**Tag notation**
```cfm

<cffunction name="getJedi" access="public" returnType="struct">

<cfargument name="id" type="numeric" required="true">

<cfset jedi = {
    "id": "5",
    "name": "Yoda"
  }>

<cfreturn jedi>
</cffunction>

<cfset jedi = getJedi(5)>

<cfdump var="#jedi#">
```

**Script notation**
```cfm
<cfscript>
  // Public function
  public struct function getSith(required numeric id) {

// Do something with "id" and create new struct
    sith = {
      "id": "7",
      "name": "Darth Vader"
    };

// Return
    return sith;
  }

// Access function
  sith = getSith(7);

// Dump return
  WriteDump(sith);
</cfscript>
```

---

## <a name="components">Components</a>

**Tag notation**
```cfm
<cfcomponent>

<cfset this.master = "Yoda">

<cfset variables.padawan = "Kris">

<cffunction name="getJedi" access="public" returnType="struct">
    <cfargument name="id" type="numeric" required="true">

</cfcomponent>

<cfset Jedi = CreateObject("Component", "path.to.component.Jedi")>

<cfset master = Jedi.master>

<cfset jedi = Jedi.getJedi(7)>
```

---

## <a name="database-queries">Database Queries</a>

**Tag notation**
```cfm

<cfquery name="myQuery" datasource="myDataSource">
    SELECT id, name FROM jedi
</cfquery>

<cfdump var = "#myQuery#">

<cfoutput query="#myQuery#">
  Id: #id#, Name: #name#
</cfoutput>

<cfloop query="#myQuery#">
  <cfoutput>Id: #id#, Name: #name#</cfoutput>
</cfloop>

<cfquery name="myQuery" datasource="myDataSource" cachedwithin="#createTimespan(0,1,0,0)#">
    SELECT id, name FROM jedi
</cfquery>

<cfquery name="myQuery" datasource="myDataSource">
    SELECT id, name FROM jedi
    WHERE id = <cfqueryparam value="7" cfsqltype="cf_sql_integer">
</cfquery>
```

---

## <a name="stored-procedures">Stored Procedures</a>

**Tag notation**
```cfm

<cfstoredproc procedure="myStoredProcedure" datasource="myDataSource">
  <cfprocparam type="in" cfsqltype="cf_sql_integer" value="7">
  <cfprocresult name="myStoredProcedureResults">
</cfstoredproc>
```

**Script notation**
```cfm
<cfscript>
  // Store procedure using "attribute-value" pairs
  spService = new storedproc();
  spService.setDatasource("myDataSource");
  spService.setProcedure("myStoredProcedure");
  spService.addParam(cfsqltype="cf_sql_integer", type="in", value="7");
  spService.addProcResult(name="myStoredProcedureResults");
  spService.execute();
</cfscript>
```

---

## <a name="catch-try">Catch/Try</a>

**Tag notation**
```cfm
<cftry>

<cfcatch type="any">
    
    <cfoutput>"Type: " & #cfcatch.type#</cfoutput>
    <cfoutput>"Message: " & #cfcatch.message#</cfoutput>
  </cfcatch>

<cffinally>
    
  </cffinally>
</cftry>
```

**Script notation**
```cfm
<cfscript>
  try {

// Do work son!

} catch(database e) {
    throw(message="It broke...", detail="Wasn't me.");
  } catch(any e) {
    // Handle any exception type
    WriteOutput("Type: " & e.type);
    WriteOutput("Message: " & e.message);
  } finally {
    // Always execute
  }
</cfscript>
```

---

## <a name="includes">Includes</a>

**Tag notation**
```cfm

<cfinclude template="path/to/include.cfm">
```

**Script notation**
```cfm

<cfscript>
  // Include
  include "path/to/include.cfm";
</cfscript>
```

coldfusion-codeguide

coldfusion-codeguide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

coldfusion-codeguide

coldfusion-codeguide Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README