Data Types in Lucee

Types in Lucee

This document explains types in Lucee. Lucee is still an untyped language. Types are only a check put on top of the language. The language is not based on types, however there are different places where types come into Lucee. This is explained with some simple examples below:

Example 1 : Function Argument and Return Value

For functions, the return value is returned with the specific type that was defined in that function.

// function1.cfm

<span class="nv">param</span> <span class="nv">application.names</span><span class="o">=</span><span class="p">{};</span>
<span class="nv">boolean</span> <span class="nv">function</span> <span class="nf">recExists</span><span class="p">(</span><span class="nv">string</span> <span class="nv">name</span><span class="p">,</span> <span class="nv">number</span> <span class="nv">age</span><span class="p">)</span> <span class="p">{</span>
	<span class="k">var</span> <span class="nv">exists</span> <span class="o">=</span> <span class="nf">application.names.keyExists</span><span class="p">(</span><span class="nv">name</span><span class="p">);</span>
	<span class="nv">application.names</span><span class="p">[</span><span class="nv">name</span><span class="p">]</span><span class="o">=</span><span class="nv">age</span><span class="p">;</span>
	<span class="nf">dump</span><span class="p">(</span><span class="nv">age</span><span class="p">);</span>
	<span class="nv">return</span> <span class="nv">exists</span><span class="p">;</span>
<span class="p">}</span>
<span class="nf">dump</span><span class="p">(</span><span class="nf">recExists</span><span class="p">(</span><span class="s2">&quot;Susi&quot;</span><span class="p">,</span><span class="s2">&quot;15&quot;</span><span class="p">));</span>
<span class="nv">void</span> <span class="nv">function</span> <span class="nf">test</span><span class="p">(</span><span class="nv">array</span> <span class="nv">arr</span><span class="p">)</span> <span class="p">{</span>
	<span class="nv">arr</span><span class="p">[</span><span class="m">2</span><span class="p">]</span><span class="o">=</span><span class="s2">&quot;two&quot;</span><span class="p">;</span>
<span class="p">}</span>
<span class="nv">arr</span><span class="o">=</span><span class="p">{</span><span class="s1">&#39;1&#39;</span><span class="p">:</span><span class="s1">&#39;one&#39;</span><span class="p">};</span>
<span class="nf">test</span><span class="p">(</span><span class="nv">arr</span><span class="p">);</span>
<span class="nf">dump</span><span class="p">(</span><span class="nv">arr</span><span class="p">);</span>

  • This example function has two arguments: name, age (One is a string, the other is a number). When this example is executed, the recExists() function checks if a certain record exists or not and It returns the boolean value true.
  • When dumping the function recExists() with arguments, if we give age as a string format in the argument, dump(recExists("Susi","15")), it shows string 15 even though we defined it as a number data type in the arguments.
  • The test() function takes an array, but in this example I do not pass an array into the function. I have passed a struct arr={'1':'one'} value into the test() function. The test() function contains an array value arr[2]= "two", so Lucee converts this array value into a structure. So the struct has two values as per keys are 1, 2 and values are one, two.
  • Lucee can handle an array as long as the keys are all numbers, meaning it considers a struct '1' and [2]. Execute this cfm page, the dump shows the structure format.

Example 2 : CFParam

// param.cfm

param name="url.age" type="numeric" default=10;
param name="url.name" type="string" default="Susi";
param name="url.mails" type="array" default=["Susi@lucee.org"];
dump(url);


// convert string to date
d=dateAdd("d",0,"12/1/2018");
dump(d);
// convert date to number
n=d+1;
dump(n);
// convert number to date
d=dateAdd("d",0,n);
dump(d);
sb=createObject("java","java.lang.StringBuilder").init("Susi Sorglos");
dump(sb);
dump(sb.substring("5"));
dump(sb.substring(JavaCast("int","5")));
//sb=createObject("java","java.lang.StringBuilder").init("1");
sb=createObject("java","java.lang.StringBuilder").init(javaCast("int","1"));
dump(sb);

  • Internally every object has a type and Lucee automatically takes care of converting from one type to another if necessary. For example when you define a function with a string, but then pass a number into that function, Lucee automatically converts the number to a string.
  • The above example is useful for converting "string to date", "date to number", "number to date" formats.
  • We have loaded a Java library and string builder. We pass a string into a constructor and execute this. We see that the string builder contains that value. We refer to this string builder method in the Java Doc. The method is called substring. This substring takes an int as its argument. For example, we pass a string value instead of an int value sb.substring("5"). Lucee returns a substring properly.
  • Two constructors are available for string builder. There are StringBuilder(int), StringBuilder(string).
//index.cfm

directory sort="name" action="list" directory=getDirectoryFromPath(getCurrentTemplatePath()) filter="example*.cfm" name="dir";
loop query=dir {
echo('<a href="#dir.name#">#dir.name#</a><br>');
}


// test.cfc

component {
function getName() {
return "Susi";
}
}

These types are on top of the language. Lucee contains some other different types too. Therefore, it is always good to do type checking in your code.

Footnotes

Here you can see above details in video

Types of Lucee

See also