Variables
name = "Amazing Programmer"
In CFML, variables are just pointers to a piece of data. They can hold any value you like and even change their value or type at runtime. In some languages, you need to specify the type of data you want your variable to hold at compile-time. You do not need to assign one in CFML, as everything is dynamic or inferred. The Lucee and Adobe 2021 servers infer types according to the initial value you assign to your variable.
a = "string"; // string
b = now(); // datetime
c = 123; // integer
d = 1.34; // float
f = false; // boolean, or a string for Adobe :)
Please note that assignments are evaluated from right to left instead of traditional reading from left to right.
Open up the CommandBox Shell and go into CommandBox REPL mode by typing
repl. Every time you assign a value to a variable, the CommandBox REPL will output or echo the variable for you. Please note that in REPL mode, the termination for a line of code is omitted. A line terminator in ColdFusion is the ;.
The CommandBox REPL is based on a Lucee 5 server, which is why semi-colons are optional, and the default syntax is script and not tags.
CFML is a case-insensitive language as well. Meaning if you create a variable
a and reference it as A they are the same. This can be a big gotcha for developers from languages like Java or JavaScript. However, as best practice, we would recommend ALWAYS using the same case as when you define the variable:Don't do this
a = "Hola Luis";
writeOutput( A );
Do this
a = "Hola Luis";
writeOutput( a );
Most CFML variables have a few requirements imposed by the Virtual Machine (VM)
- It must begin with a letter, underscore, or Unicode currency symbol.
- It can contain letters, numbers, underscore characters, and Unicode currency symbols.
- NO SPACES!
- Not case-sensitive
As with any programming language, there are specific names you just can't use, and some you can use, but they can be very confusing for developers or the engine. Here is a list of some of those:
- The name of any of the internal ColdFusion engine scopes:
form, session, cgi, client, url, application, function- Technically you can create the variable by long scoping (
local.form), but it is confusing and error-prone. So please be careful.
Reserved Word | Lucee | Adobe |
|---|---|---|
abstract | | √ |
and | | √ |
break | | √ |
case | | √ |
catch | | √ |
continue | | √ |
contains | | √ |
default | | √ |
do | | √ |
else | | √ |
eq | | √ |
eqv | | √ |
false | √ | √ |
finally | | √ |
final | | √ |
for | | √ |
function | | √ |
gt | | √ |
gte | | √ |
import | | √ |
imp | | √ |
in | | √ |
is | | √ |
if | | √ |
interface | | √ |
lt | | √ |
lte | | √ |
local (within a function) | | √ |
neq | | √ |
not | | √ |
null (If null support is on) | √ | √ |
pageenconding | | √ |
or | | √ |
return | | v |
switch | | √ |
true | √ | √ |
try | | √ |
while | | √ |
xor | | √ |
You can also create a variable with one type and then switch it to another dynamically:
As you can see, the last equality wins! In this case,
a is now an array.As we are now seeing, CFML is a typeless language, but internal types always exist. CFML will automatically cast so you can do flexible typing assignments when evaluating expressions. It does all the tedious and hard job for you. If we were to categorize CFML variables into categories, these would be:
Category | Description |
|---|---|
Binary | Raw data from files such as images, pdfs, etc |
Complex | A data container that represents more than one value: structures, arrays, queries, XML document objects, etc. |
Objects | Complex constructs representing data and functional operations. ColdFusion Components or Java Objects. |
Simple | One value and used directly in expressions. These include numbers, strings, floats, booleans, and date-time values. |
CFML also includes many validation functions available to you to test for the type of variable you are working with. You can also use the
getmetdata() function to get the metadata about the variable as well.qData = getMetadata( query )
a = now()
writedump( a.getMetadata() )
isArray()isBinary()isBoolean()isCustomFunction()isClosure()isDate()isDateObject()isDDX()isJSON()isNumeric()isNumericDate()isObject()isNull()isPDFFile()isPDFObject()isQuery()isSimpleValue()isSpreadsheetFile()isSpreadsheetObject()isStruct()isWDDX()isXML()isXmlDoc()
You can also in CFML convert variables from one type to another. Here are some functions that will assist you in conversions:
arrayToList()binaryDecode()binaryEncode()charsetDecode()charsetEncode()deserializeJSON()entityToQuery()hash()hmac()HTMLParse()lcase()listToArray()parseNumber()serializeJSON()toBase64()toBinary()toScript()toString()URLDecode()URLEncode()URLEncodedFormat()val()XMLFormat()XMLParse()XMLTransform()
Please note that some of them can be used as member functions directly on a specific object type. https://cfdocs.org/conversion%2Dfunctions
You can also output or evaluate variables by using the
# operators and using the variable name. This is referred to as interpolation in some languages:a = "Hola Luis"
writeoutput( "Welcome to CFML: #a#" )
// Echo is the same as writeOutput but LUCEE only
echo( "Welcome" )
Also, note that using the
# hashes for output on assignments can be redundant if you do NOT use string interpolation but just variable assignments.Don't do this
a = "hello luis";
b = #a#;
or
b = "#a#";
Do this
a = "hello luis";
b = a;
CFML offers one of the most used functions/tags ever:
<cfdump>, writeDump() and <cfabort>, abort;. These are used to dump the entire contents of a variable to the browser, console, or even a file. You can then leverage the abort construct to abort the request and see the output of your dumped variables. This will work with both simple and complex variables. However, be very careful when using it with Nested ORM objects, as you can potentially dump your entire database and crash the server. Leverage the top argument to limit dumping.writeDump( complex );abort;
<cfdump var="#server#" abort=true>
writeDump( var=arrayOfORM, top=5 );abort;
CFML Engines also allow you to turn on/off a debugging template that shows up at the bottom of requests when running in server mode. You can activate this debugging by logging in to the appropriate engine administrator and looking for the debugging section. Turn it on and debug like a champ.
Important: Adobe Engines have a very evil setting called Report Execution Times, make sure it is always turned OFF. If you use it with any application that leverages Components, it will slow down your application tremendously.
CFML allows you to set default values for variables in case you use a variable that doesn't exist. You can use the
<cfparam> tag or the param construct:<cfparam name="myVariable" default="luis">
or
param myVariable = "luis";
You can even assign types to parameterize variables and much more. Check out the docs for it: https://cfdocs.org/cfparam
You can verify if variables exist in many different ways. The following section showcases how variables are stored in visibility and persistence scopes which are all structures or hash maps in Java terms. Meaning you can leverage structure operations for checking for existence and much more. Below are several ways to verify variable existence:
isDefined()- Evaluates a string value to determine whether the variablenamed in it exists.isNull()- Returnstrueif the specified object is null, elsefalse.structKeyExists( key, value )- Verifies if the specified key variable exists in a structure.
// Notice the variable name is in quotes
if( isDefined( "myVariable" ) ){
writeOutput( myVariable );
} else {
writeOutput( "Not Defined!" );
}
// Notice that the variable is NOT in quotes
if( isNull( myVariable ) ){
writeOutput( "Not Defined!" );
} else {
writeOutput( myVariable );
}
// What is this variables scopes???
if( structKeyExists( variables, "myVariable" ) ){
writeOutput( myVariable );
} else {
writeOutput( "Not Defined!" );
}
As we have discussed, CFML is a dynamic language built on Java. Thus each variable internally is represented by a native Java data type:
String, Int, Float, Array, Vector, HashMap, etc. This is important because each variable you create has member functions available to you that delegate or reflect its native Java class.a = "hello";
writeOutput( a.getClass().getName() );
If you run the script above in the REPL tool, you will see the output as
java.lang.String. Therefore, the variable is typed as a String and can call on any method that java.lang.String implements. You can try this for the many types in CFML, like structs, arrays, objects, etc.Besides the native Java member functions available to you, CFML also allows you to call on each variable's data type functions and chain them to create friendly language DSLs. This way, you do not have to pass variables into functions but treat the variables as objects. You can see all the member functions available according to data type here: https://cfdocs.org/member
Here are some examples:
// Function passing
var myArray = [];
ArrayAppend( myArray, "objec_new" );
ArraySort( myArray, "ASC" );
// Member Functions
myArray.append( "objec_new" );
myArray.sort( "ASC" );
// Java Functions + CFML Functions
var myProductObject = createObject( "java", "myJavaclass" );
myjavaList = myProductObject.getProductList();
myjavaList.add( "newProduct" ); // Java API
myjavaList.append( "newProduct" ); // CF API
myjavaList.sort( "ASC" );
// DSL Chaining
s="the";
s = s.listAppend("quick brown fox", " ")
.listAppend("jumps over the lazy dog", " ")
.ucase()
.reverse();
- Array
- String
- List
- Struct
- Date
- Spreadsheet
- XML
- Query
- Image
At Ortus Solutions, we have developed a set of development standards for many languages. You can find our ColdFusion standards here: https://github.com/Ortus-Solutions/coding-standards
Last modified 2mo ago