CFLib
CommandBox can install UDFs from the popular site CFLib.org. Each project on CFLib is a single CFML function. You can find UDFs via the web site and copy the URL slug for a given UDF to use in your installation.
For example, if the URL to a given UDF is
http://www.cflib.org/udf/CalculateWindChill, the slug you'll want to use would be CalculateWindChill.Standard Installation
To install a package from CFLib, use the slug from the website's URL like so:
1
install cflib:AreaParallelogram
Copied!
This will create a folder in your installation directory named after the UDF containing a
.cfm file of the same name. The above command would create the following folder:1
AreaParallelogram/AreaParallelogram.cfm
Copied!
That file contains a single function that you can call. It is up to you to include that file where ever you want to use the UDF.
1
include '/AreaParallelogram/AreaParallelogram.cfm';
2
var area = AreaParallelogram( base, height );
Copied!
ColdBox Installation
If you're using ColBox, you can use a slightly different version of the CFLib endpoint called
CFLib-ColdBox which will wrap up the UDF inside a CFC and place it in an ad-hoc module which automatically registers the model with WireBox.1
install cflib-coldbox:AreaParallelogram
Copied!
This frees you up from needing to manually include the file. Once you install the module, you can immediately ask WireBox for the UDF using the convention
[email protected]. WireBox will register this mapping by convention so there is no additional setup required to use the UDF.1
var area = getInstance( `[email protected]` ).AreaParallelogram( base, height );
Copied!
Or inject the wrapped UDF to use in your handlers or models.
1
component {
2
// Inject the UDF wrapped in a CFC
3
property name='areaHelper' inject='[email protected]';
4
​
5
function onDIComplete() {
6
var area = areaHelper.AreaParallelogram( base, height );
7
}
8
}
Copied!
Package Metadata
Packages installed from the CFLib endpoint don't have any way to get new version information. They will always show as outdated using the
outdated or update commands and their downloads will not get stored in the artifact cache.In box.json
You can specify packages from the CFLib endpoint as dependencies in your
box.json in this format.1
{
2
"dependencies" : {
3
"AreaParallelogram" : "cflib:AreaParallelogram"
4
"FahrenheitToCelsius" : "cflib-coldbox:FahrenheitToCelsius"
5
}
6
}
Copied!
Last modified 11d ago
Copy link
Edit on GitHub