text: sorts text alphabetically, taking case into account
(also known as case-sensitive). All letters of one case
precede the first letter of the other case:
- aabzABZ, if sort_order = "asc" (ascending sort)
- ZBAzbaa, if sort_order = "desc" (descending sort)
textnocase: sorts text alphabetically, without regard to
case (also known as case-insensitive). A letter in varying
cases precedes the next letter:
- aAaBbBzzZ, in an ascending sort; preserves original
intra-letter order
- ZzzBbBaAa, in a descending sort; reverses original
intra-letter order | +| sortOrder | string | No | asc | asc: ascending sort order. Default.
- aabzABZ or aAaBbBzzZ, depending on value of sort_type,
for letters
- from smaller to larger, for numbers
desc: descending sort order.
- ZBAzbaa or ZzzBbBaAa, depending on value of sort_type,
for letters
- from larger to smaller, for numbers | +| callback | function | No | | CF10+ A function that uses two elements of an array. `function(element1, element2)`. Returns whether the first is less than (-1), equal to (0) or greater than (1) the second one (like the compare functions). | +| localeSensitive | boolean | No | false | CF10+ Specify if you wish to do a locale sensitive sorting. | + +## Simple example for arraySort function + +Uses the arraySort() function to get the sorted array and which sorted by type numeric + +```javascript +someArray = [10,20,-99,46,50]; +arraySort(someArray, "numeric", "desc"); +writeOutput( serializeJSON(someArray) ); +``` + +### Expected Result: [50,46,20,10,-99] + +## Simple example with member function + +CF11+ Lucee4.5+ + +```javascript +someArray = ["COLDFUSION","coldfusion","adobe","LucEE","RAILO"]; +someArray.sort("text","desc"); +writeOutput( serializeJSON(someArray) ); +``` + +### Expected Result: ["coldfusion","adobe","RAILO","LucEE","COLDFUSION"] + +## Simple example with callback function + +Uses the callback function + +```javascript +someArray = [ + {name="testemployee", age="32"}, + {name="employeetest", age="36"} +]; +arraySort( + someArray, + function (e1, e2){ + return compare(e1.name, e2.name); + } +); +writeOutput( serializeJSON(someArray) ); +``` + +### Expected Result: [{"NAME":"employeetest","AGE":"36"},{"NAME":"testemployee","AGE":"32"}] + +## Script member syntax: sort array of structs by multiple keys + +Takes an array of structs and sorts by multiple different keys, similar to the way a query allows. + +```javascript +arrayOfStructs = [ + { + "userId": 1, + "firstName": "John", + "lastName": "Doe", + "departmentName": "Sales", + "active": 1 + }, + { + "userId": 2, + "firstName": "Jane", + "lastName": "Smith", + "departmentName": "Marketing", + "active": 1 + }, + { + "userId": 3, + "firstName": "Alice", + "lastName": "Johnson", + "departmentName": "Sales", + "active": 0 + }, + { + "userId": 4, + "firstName": "Bob", + "lastName": "Brown", + "departmentName": "Sales", + "active": 1 + }, + { + "userId": 5, + "firstName": "Charlie", + "lastName": "Davis", + "departmentName": "Marketing", + "active": 0 + } +]; +arrayOfStructs.sort((user1,user2) => { + if (user1.active != user2.active) { + return user2.active - user1.active; + } + if (user1.departmentName == user2.departmentName || user1.active == 0) { + if (user1.lastName == user2.lastName) { + return user1.firstName.compare(user2.firstName); + } + return user1.lastName.compare(user2.lastName); + } + return user1.departmentName.compare(user2.departmentName); +}); +writeDump(arrayOfStructs); +``` + +### Expected Result: Sorts by active employees, then by their last name and finally by their first name diff --git a/docs/functions/arraysplice.md b/docs/functions/arraysplice.md new file mode 100644 index 000000000..bb0f81146 --- /dev/null +++ b/docs/functions/arraysplice.md @@ -0,0 +1,81 @@ +# arraySplice + +Modifies an array by removing elements and adding new elements. It starts from the index, removes as many elements as specified by elementCountForRemoval, and puts the replacements starting from index position. + +```javascript +arraySplice(array, index[, elementCountForRemoval, replacements]) +``` + +```javascript +returns array +``` + +## Member Function Syntax + +```javascript +someArray.splice(index[, elementCountForRemoval, replacements]) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | The array to splice and modify. | +| index | numeric | Yes | | The position at which to start modifying the array. If the position is greater than the length of the array, the replacement elements will be inserted after the last array element. If the position is less than 0, the start is set to the end of the array and the origin is set accordingly. | +| elementCountForRemoval | numeric | No | | The number of elements to be removed starting with the start index. | +| replacements | array | No | | Array of elements to be added to the array starting with index start. | + +## arraySplice inserting replacements at position 2 while removing 0 elements + +```javascript +months = ['Jan', 'March', 'April', 'June']; +item = ["Feb"]; +arraySplice( months, 2, 0, item ); +writedump(months); +``` + +### Expected Result: ["Jan","Feb","March","April","June"] + +## arraySplice inserting replacements at position 3 while removing 2 elements + +```javascript +months = ['Jan', 'March', 'April', 'June']; +item = ["Feb"]; +arraySplice( months, 3, 2, item ); +writedump(months); +``` + +### Expected Result: ["Jan","March","Feb"] + +## arraySplice inserting replacements at position -3 while removing 0 elements + +```javascript +months = ['Jan', 'March', 'April', 'June']; +item = ["Feb"]; +arraySplice( months, -3, 0, item ); +writedump(months); +``` + +### Expected Result: ["Jan","Feb","March","April","June"] + +## arraySplice inserting replacements at position 5 which is greater than the length of the array + +```javascript +months = ['Jan', 'March', 'April', 'June']; +item = ["Feb"]; +arraySplice( months, 5, 0, item ); +writedump(months); +``` + +### Expected Result: ["Jan","March","April","June","Feb"] + +## Splice an array using member function + +```javascript +months = ['Jan', 'March', 'April', 'June']; +item = ["Feb"]; +months.splice( 2, 0, item ); +writedump(months); +``` + +### Expected Result: ["Jan","Feb","March","April","June"] diff --git a/docs/functions/arraysum.md b/docs/functions/arraysum.md new file mode 100644 index 000000000..32a7b871e --- /dev/null +++ b/docs/functions/arraysum.md @@ -0,0 +1,58 @@ +# arraySum + +The sum of values in an array. If the array parameter value is + an empty array, returns zero. + +```javascript +arraySum(array) +``` + +```javascript +returns numeric +``` + +## Member Function Syntax + +```javascript +someArray.sum() +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | An array name or variable name | +| ignoreEmpty | boolean | No | NO | CF2016.0.3+ Whether to ignore empty string or null values | + +## Sum of values in an array + +Uses the arraySum function to get sum of values in an array + +```javascript +numberArray = [10,99,27,72]; +writeOutput( arraySum(numberArray)); +``` + +### Expected Result: 208 + +## Sum of values in an array + +To get sum of values in an empty array + +```javascript +numberArray = []; +writeOutput( arraySum(numberArray)); +``` + +### Expected Result: 0 + +## Sum of values in an array + +CF11+ Lucee4.5+ Uses the sum member function is the same as running arraySum. + +```javascript +numberArray = [10,99,27,72]; +writeOutput( numberArray.sum() ); +``` + +### Expected Result: 208 diff --git a/docs/functions/arrayswap.md b/docs/functions/arrayswap.md new file mode 100644 index 000000000..7c5012189 --- /dev/null +++ b/docs/functions/arrayswap.md @@ -0,0 +1,47 @@ +# arraySwap + +Swaps array values of an array at specified positions. This function is more efficient than multiple cfset tags + +```javascript +arraySwap(array, position1, position2) +``` + +```javascript +returns boolean +``` + +## Member Function Syntax + +```javascript +someArray.swap(position1, position2) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | The array for which positions will be swapped | +| position1 | numeric | Yes | | Position of 1st element to swap. | +| position2 | numeric | Yes | | Position of 2nd element to swap. | + +## Swap the position of two values in an array + +```javascript +superiorArray = ['Spider-Man','Green Goblin','Doctor Octopus','Venom']; +arraySwap(superiorArray,1,3); +writeDump(superiorArray); +``` + +### Expected Result: ['Doctor Octopus', 'Green Goblin', 'Spider-Man', 'Venom'] + +## Swap the position of two values in an array using the member function + +CF11+ or Lucee4.5+ + +```javascript +superiorArray = ['Spider-Man','Green Goblin','Doctor Octopus','Venom']; +superiorArray.swap(1,3); +writeDump(superiorArray); +``` + +### Expected Result: ['Doctor Octopus', 'Green Goblin', 'Spider-Man', 'Venom'] diff --git a/docs/functions/arraytolist.md b/docs/functions/arraytolist.md new file mode 100644 index 000000000..e4e9dbe3a --- /dev/null +++ b/docs/functions/arraytolist.md @@ -0,0 +1,48 @@ +# arrayToList + +Converts a one-dimensional array to a list. + +```javascript +arrayToList(array [, delimiter]) +``` + +```javascript +returns string +``` + +## Member Function Syntax + +```javascript +someArray.toList([delimiter]) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | | +| delimiter | string | No | , | | + +## Retrieve an array as a list + +Uses the arrayToList function with a pipe delimiter to retrieve an array as a list + +```javascript +someArray = [1,2,3,4]; +someList = arrayToList(someArray,"|"); +writeOutput(someList); +``` + +### Expected Result: "1|2|3|4" + +## Retrieve an array as a list using the Array member function + +CF11+ Lucee4.5+ Uses the Array member function to retrieve an array as a list + +```javascript +seinfeldArray = ["Jerry","Elaine","Kramer","George"]; +seinfeldList = seinfeldArray.toList(); +writeOutput(seinfeldList); +``` + +### Expected Result: "Jerry,Elaine,Kramer,George" diff --git a/docs/functions/arraytostruct.md b/docs/functions/arraytostruct.md new file mode 100644 index 000000000..f94ae415c --- /dev/null +++ b/docs/functions/arraytostruct.md @@ -0,0 +1,31 @@ +# arrayToStruct + +Transform the array to a struct, the index of the array is the key of the struct + +```javascript +arrayToStruct(array) +``` + +```javascript +returns struct +``` + +## Member Function Syntax + +```javascript +array.toStruct() +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | | + +## Convert an array to a struct using arrayToStruct() + +```javascript +serializeJSON(arrayToStruct(["a","b"])); +``` + +### Expected Result: {"2":"b","1":"a"} diff --git a/docs/functions/arrayunshift.md b/docs/functions/arrayunshift.md new file mode 100644 index 000000000..918e39be7 --- /dev/null +++ b/docs/functions/arrayunshift.md @@ -0,0 +1,48 @@ +# arrayUnshift + +This function adds one or more elements to the beginning of the original array and returns the length of the modified array. + +```javascript +arrayUnshift(array,object) +``` + +```javascript +returns numeric +``` + +## Member Function Syntax + +```javascript +array.unshift(object) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| array | array | Yes | | The original array to be added to. | +| object | any | Yes | | The new object to be added. | + +## Example with simple values + +Add a new element to an array. + +```javascript +arr=[1,2,3]; +newArrLen=arrayUnshift(arr,0); +writeOutput(newArrLen); +``` + +### Expected Result: 4 + +## Using a member function + +This is the same example as above, but using a member function on the array instead of a standalone function. + +```javascript +arr=[1,2,3]; +newArrLen=arr.unshift(0); +writeOutput(newArrLen); +``` + +### Expected Result: 4 diff --git a/docs/functions/asc.md b/docs/functions/asc.md new file mode 100644 index 000000000..c106ba257 --- /dev/null +++ b/docs/functions/asc.md @@ -0,0 +1,26 @@ +# asc + +Determines the ASCII value of a character. + +```javascript +asc(string) +``` + +```javascript +returns numeric +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| string | string | Yes | | | + +## character and value of Korean currency symbol ( unicode number 8361 ) + +```javascript +x = chr( 8361 ); + writeoutput( 'character: #x#' ); + x = asc( x ); + writeoutput( '
Unicode value: #x#'); +``` diff --git a/docs/functions/ascii.md b/docs/functions/ascii.md new file mode 100644 index 000000000..02465fe10 --- /dev/null +++ b/docs/functions/ascii.md @@ -0,0 +1,26 @@ +# ascii + +Determines the ASCII value of a character. + +```javascript +ascii(string) +``` + +```javascript +returns numeric +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| string | string | Yes | | | + +## character and value of Korean currency symbol ( unicode number 8361 ) + +```javascript +x = chr( 8361 ); + writeoutput( 'character: #x#' ); + x = asc( x ); + writeoutput( '
Unicode value: #x#'); +``` diff --git a/docs/functions/asin.md b/docs/functions/asin.md new file mode 100644 index 000000000..9c2ab79dc --- /dev/null +++ b/docs/functions/asin.md @@ -0,0 +1,25 @@ +# asin + +Determines the arcsine of a number. The arcsine is the angle whose sine is `number`. + +```javascript +asin(number) +``` + +```javascript +returns numeric +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| number | numeric | Yes | | | + +## Arcsine of 0.3 + +```javascript +asin(0.3) +``` + +### Expected Result: 0.304692654015 diff --git a/docs/functions/atn.md b/docs/functions/atn.md new file mode 100644 index 000000000..17073aac5 --- /dev/null +++ b/docs/functions/atn.md @@ -0,0 +1,25 @@ +# atn + +Arctangent function. The arctangent is the angle whose tangent is `number`. + +```javascript +atn(number) +``` + +```javascript +returns numeric +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| number | numeric | Yes | | | + +## Arctangent of 0.3 + +```javascript +atn(0.3) +``` + +### Expected Result: 0.291456794478 diff --git a/docs/functions/beat.md b/docs/functions/beat.md new file mode 100644 index 000000000..f291efb0e --- /dev/null +++ b/docs/functions/beat.md @@ -0,0 +1,31 @@ +# beat + +Outputs the swatch internet time (or beat time) of the passed local time. + +```javascript +beat([time]) +``` + +```javascript +returns numeric +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| time | any | No | | The local time to get beat time from | + +## Now in swatch internet time + +```javascript +beat() +``` + +## 14:02 in swatch internet time + +```javascript +beat("14:02") +``` + +### Expected Result: 626.388 diff --git a/docs/functions/binarydecode.md b/docs/functions/binarydecode.md new file mode 100644 index 000000000..cc057951e --- /dev/null +++ b/docs/functions/binarydecode.md @@ -0,0 +1,60 @@ +# binaryDecode + +Converts a string to a binary object. Used to convert + binary data that has been encoded into string format + back into binary data. + +```javascript +binaryDecode(string, encoding) +``` + +```javascript +returns binary +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | Values | +| --- | --- | --- | --- | --- | --- | +| string | string | Yes | | A string containing encoded binary data. | | +| encoding | string | Yes | | A string specifying the algorithm used to encode the original
binary data into a string; must be one of the following:
- hex: characters 0-9 and A-F represent the hexadecimal value
of each byte; for example, 3A.
- UU: data is encoded using the UNIX UUencode algorithm.
- base64: data is encoded using the Base64 algorithm.
- base64URL: modification of the main Base64 standard, which uses the encoding result as filename or URL address. | /Users/garethedwards/development/github/cfdocs/docs/functions/binarydecode.md|base64URL | + +## Decode a string using hex back into binary encoding of the string + +use binaryDecode to decode with hex + +```javascript +binaryDecode('F62B','hex'); +``` + +### Expected Result: [BINARY] + +## Decode a string using UNIX UUencode (UU) back into binary encoding of the string + +use binaryDecode to decode with UNIX UUencode (UU) + +```javascript +binaryDecode('&
- hex: use characters 0-9 and A-F represent the hexadecimal value
of each byte; for example, 3A.
- UU: use the UNIX UUencode algorithm to convert the data.
- base64: use the Base64 algorithm to convert the data.
- base64URL: modification of the main Base64 standard, which uses the encoding result as filename or URL address. | /Users/garethedwards/development/github/cfdocs/docs/functions/binaryencode.md|base64URL | + +## Encode a binary string back to a string using hex + +use binaryEncode to Encode with hex + +```javascript +s = binaryDecode('737472696E67','hex'); + binaryEncode(s,'hex'); +``` + +### Expected Result: 737472696E67 + +## Encode a binary using UNIX UUencode (UU) back into string + +use binaryEncode to Encode with UNIX UUencode (UU) + +```javascript +s = binaryDecode('&
"" or not set - information to all default caches
object - information to "Default Object" Cache
template - information to "Default Template" Cache
query - information to "Default Query" Cache
resource - information to "Default Resource" Cache
{cache name} - information to a specific cache | /Users/garethedwards/development/github/cfdocs/docs/functions/cachegetproperties.md|query | diff --git a/docs/functions/cachegetsession.md b/docs/functions/cachegetsession.md new file mode 100644 index 000000000..f51371935 --- /dev/null +++ b/docs/functions/cachegetsession.md @@ -0,0 +1,37 @@ +# cacheGetSession + +Lets you retrieve the underlying cache object to access additional cache functionality that is not implemented in the tag cfcache. + +Note: Caution! Using the cacheGetSession function might pose security vulnerabilities. If you wish to disable the usage of this function, add it to Sandbox Security. + +```javascript +cacheGetSession(objectType) +``` + +```javascript +returns any +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| objectType | string | Yes | | Any of the following values: object, template, or name of the user-defined cache | +| isKey | boolean | No | false | Set to true if objectType is user-defined cache. | + +## The following example shows how to use the function cacheGetSession to operate on default caches: + +```javascript + +
+
+
+
+
'); + +// clear all objects from the cache +cacheRemoveAll(); + +writeOutput('After cacheRemove() :: #_numCacheObj# #cacheObjCount()#
'); +``` diff --git a/docs/functions/cachesetproperties.md b/docs/functions/cachesetproperties.md new file mode 100644 index 000000000..ce9e57bf7 --- /dev/null +++ b/docs/functions/cachesetproperties.md @@ -0,0 +1,18 @@ +# cacheSetProperties + +Set multiple cache settings + +```javascript +cacheSetProperties(properties) +``` + +```javascript +returns void +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| properties | struct | Yes | | Structure of properties to be changed | +| region | string | No | | CF10+ Indicates the cache region for which to set the properties. | diff --git a/docs/functions/callstackdump.md b/docs/functions/callstackdump.md new file mode 100644 index 000000000..0d8106d13 --- /dev/null +++ b/docs/functions/callstackdump.md @@ -0,0 +1,52 @@ +# callStackDump + +Similar to the function callStackGet except that it outputs a string representation of the call stack. + +```javascript +callStackDump(output) +``` + +```javascript +returns void +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | Values | +| --- | --- | --- | --- | --- | --- | +| output | string | No | browser | If you chose "file" and do not provide the complete path to the file, the file is written to the temp directory as determined by the function `getTempDirectory()`. | /Users/garethedwards/development/github/cfdocs/docs/functions/callstackdump.md|file | + +## Tag Syntax + +In this example, the factorial of a number is computed. The example is similar to the example for CallStackGet except that the function used here is callStackDump.callfact.cfm + +```javascript +
#cfcatch.detail# +
+
#cfcatch.detail#
+
'); + return 1; + } + else { + writeDump(callStackGet()); + writeOutput('
'); + return n * factorial(n-1); + } + } + factorial(5); +
If the value of this argument is false, an empty string will be returned instead of an exception. | + +## Canonicalize the simple HTML entity encoded string + +Canonicalize the simple HTML entity encoded string. + +```javascript +
+
+
+
+
+
Unicode value: #x#'); +``` diff --git a/docs/functions/cjustify.md b/docs/functions/cjustify.md new file mode 100644 index 000000000..70424212a --- /dev/null +++ b/docs/functions/cjustify.md @@ -0,0 +1,25 @@ +# cJustify + +Centers a string in a given field length by adding spaces to either side. + +```javascript +cJustify(string, length) +``` + +```javascript +returns string +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| string | string | Yes | | The string that is to be centered | +| length | numeric | Yes | | The length of the field in which the string should be centered | + +## Tag Syntax + +```javascript +
- algorithm : algorithm used for signing.
- encryption : algorithm used for encrypting the payload.
- generateIssuedAt : boolean to indicate whether to generate "iat" field
- generateJti : boolean to indicate whether to generate "jti" field | diff --git a/docs/functions/createguid.md b/docs/functions/createguid.md new file mode 100644 index 000000000..99d6de451 --- /dev/null +++ b/docs/functions/createguid.md @@ -0,0 +1,17 @@ +# createGUID + +Creates a globally unique identifier (32 character hexadecimal string) + +```javascript +createGUID() +``` + +```javascript +returns guid +``` + +## Creates a Globally Unique Identifier (GUID). Each GUID will be unique + +```javascript +createGUID() +``` diff --git a/docs/functions/createobject.md b/docs/functions/createobject.md new file mode 100644 index 000000000..34657542c --- /dev/null +++ b/docs/functions/createobject.md @@ -0,0 +1,64 @@ +# createObject + +The createObject function takes different arguments depending on the value of the type argument: + + createObject('component', cfcName) + createObject('java', class) + createObject('java', class, bundleName, bundleVersion) (Lucee only) + createObject('webservice', urltowsdl, [, portname]) + createObject('.NET', class, assembly [, server, port, protocol, secure]) + createObject('com', class, context, serverName) + +```javascript +createObject(type, className) +``` + +```javascript +returns any +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| type | string | Yes | | The type of object | +| className | string | Yes | | | +| context | string | Yes | | | +| locale | string | Yes | | | +| servername | string | Yes | | | +| component_name | string | Yes | | | +| urltowsdl | string | Yes | | WSDL file URL; location of web service | +| portname | string | No | | The port name for the web service. This value is case-sensitive
and corresponds to the port element's name attribute under the
service element.
Specify this parameter if the web service contains multiple ports.
If no port name is specified, ColdFusion uses the first port found
in the WSDL. | +| bundleName | string | No | | Bundle where the object has to be located | +| bundleVersion | string | No | | Specific version to | + +## Create a CFC / Component Instance + +createObject Component + +```javascript +
- algorithm : algorithm used for signing.
- generateIssuedAt : boolean to indicate whether to generate "iat" field
- generateJti : boolean to indicate whether to generate "jti" field | diff --git a/docs/functions/createtime.md b/docs/functions/createtime.md new file mode 100644 index 000000000..142f61580 --- /dev/null +++ b/docs/functions/createtime.md @@ -0,0 +1,28 @@ +# createTime + + Creates a time variable. + +```javascript +createTime(hour, minute, second) +``` + +```javascript +returns date +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| hour | numeric | Yes | | Hour of the day in 24-hour notation (0-23) | +| minute | numeric | Yes | 0 | Minute within the hour | +| second | numeric | Yes | 0 | Second within the minute | +| millisecond | numeric | No | 0 | | +| timezone | numeric | No | | | + +## Tag Syntax + +```javascript +
`q` - Quarter
`m` - Month
`y` - Day of year
`d` - Day
`w` - Week day
`ww` - Week
`h` - Hour
`n` - Minute
`s` - Second
`l` - Millisecond | +| number | numeric | Yes | | The number of datepart units to add to the provided date.
Number must be an integer.
Negative integers move the date into the past, positive into the future. | +| date | date | Yes | | A datetime object in the range of 100AD-9999AD.
NOTE: When passing a datetime object as a string, enclose it in quotation marks. Otherwise, it is interpreted as a numeric representation of a datetime object. | + +## Add Days to a Date + +Add 30 days to August 3rd, 2014. + +```javascript +dateAdd('d', 30, '8/3/2014') +``` + +### Expected Result: {ts '2014-09-02 00:00:00'} + +## Subtract Days from a Date + +Subtract 30 days from August 3rd, 2014. + +```javascript +dateAdd('d', -30, '8/3/2014') +``` + +### Expected Result: {ts '2014-07-04 00:00:00'} + +## Add Weeks to a Date + +Here we're adding 8 weeks to the date August 3rd, 2014. + +```javascript +dateAdd('ww', 8, '8/3/2014') +``` + +### Expected Result: {ts '2014-09-28 00:00:00'} + +## Add Days to a Date (Member Function) + +Here we're adding 1 day to the current date/time. + +```javascript +createDate( 2022, 10, 1 ).add( 'd', 1 ) +``` + +### Expected Result: {ts '2022-10-02 00:00:00'} diff --git a/docs/functions/datecompare.md b/docs/functions/datecompare.md new file mode 100644 index 000000000..ae62bf5fe --- /dev/null +++ b/docs/functions/datecompare.md @@ -0,0 +1,57 @@ +# dateCompare + +Performs a full date/time comparison of two dates. + `-1` if date1 is less than date2 + `0` if date1 is equal to date2 + `1` if date1 is greater than date2 + [DatePart] `yyyy`: Year; `m`: Month; `d`: Day; `h`: Hour; `n`: Minute; `s`: Second + +```javascript +dateCompare(date1, date2 [, datePart]) +``` + +```javascript +returns numeric +``` + +## Member Function Syntax + +```javascript +date1.compare(date2 [, datePart]) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | Values | +| --- | --- | --- | --- | --- | --- | +| date1 | date | Yes | | A date to compare | | +| date2 | date | Yes | | Another date to compare | | +| datePart | string | No | s | | /Users/garethedwards/development/github/cfdocs/docs/functions/datecompare.md|s | + +## Compare Two Dates by Year + +```javascript +dateCompare('12/30/2015', '12/02/2015', 'yyyy') +``` + +### Expected Result: 0 + +## Compare Two Dates by Day + +Returns 1 because date1 is greater than date 2 + +```javascript +dateCompare('12/30/2015', '12/02/2015', 'd') +``` + +### Expected Result: 1 + +## Member function example + +```javascript +d1 = createDate("2024","01","01"); +d2 = createDate("2024","02","14"); +d1.compare(d2) +``` + +### Expected Result: -1 diff --git a/docs/functions/dateconvert.md b/docs/functions/dateconvert.md new file mode 100644 index 000000000..956746d48 --- /dev/null +++ b/docs/functions/dateconvert.md @@ -0,0 +1,38 @@ +# dateConvert + +Converts local time to Coordinated Universal Time (UTC), or UTC to local time. The function uses the daylight savings settings in the executing computer to compute daylight savings time, if required. + +```javascript +dateConvert(conversionType, date) +``` + +```javascript +returns date +``` + +## Member Function Syntax + +```javascript +date.convert(conversionType) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| conversionType | string | Yes | | `local2Utc` : Converts local time to UTC time.
`utc2Local` : Converts UTC time to local time. | +| date | date | Yes | | | + +## Converting Local to UTC + +```javascript +utc_datetime = dateConvert('local2Utc', now()); +``` + +## Converting UTC to Local + +This example makes sense only if your server time is UTC. now() uses your server settings when creating a datetime object. + +```javascript +local_datetime = dateConvert('utc2Local', now()); +``` diff --git a/docs/functions/datediff.md b/docs/functions/datediff.md new file mode 100644 index 000000000..dd3d8d3ba --- /dev/null +++ b/docs/functions/datediff.md @@ -0,0 +1,55 @@ +# dateDiff + +Determines the integer number of datepart units by which date1 is less than date2. + +```javascript +dateDiff(datepart, date1, date2) +``` + +```javascript +returns numeric +``` + +## Member Function Syntax + +```javascript +date2.diff(datepart, date1) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| datepart | string | Yes | | yyyy: Year
q: Quarter
m: Month
y: Day of year
d: Day
w: Week (Weekday cf2018+)
ww: Week
h: Hour
n: Minute
s: Second | +| date1 | date | Yes | | The smaller date to diff
Can be either a string or a date object whereas member function only accept the latter | +| date2 | date | Yes | | The bigger date to diff
Can be either a string or a date object whereas member function only accept the latter | + +## dateDiff Example + +Find the difference between two dates. + +```javascript +dateDiff("d", "2013-01-15", "2013-01-25") +``` + +### Expected Result: 10 + +## How old are they? + +Calculates a persons age based on a variable birthDate which contains a date. Uses the now function to get current date. + +```javascript +birthDate = createDate( 1972, 5, 20 ); +age = dateDiff('yyyy', birthDate, now()); +writeoutput( age ); +``` + +## dateDiff member function + +Note the different behavior between ColdFusion and Lucee. + +```javascript +testDate = now(); +diffDate = dateAdd('d', 1, testDate); +writeOutput(testDate.diff('d', diffDate)); // this returns 1 on Lucee, and -1 on ColdFusion +``` diff --git a/docs/functions/dateformat.md b/docs/functions/dateformat.md new file mode 100644 index 000000000..a758b1597 --- /dev/null +++ b/docs/functions/dateformat.md @@ -0,0 +1,56 @@ +# dateFormat + +Formats a date value using U.S. date formats. When formatting both date and time, use dateTimeFormat. For international date support, use lsDateFormat. + +```javascript +dateFormat(date [, mask]) +``` + +```javascript +returns string +``` + +## Member Function Syntax + +```javascript +date.dateFormat([mask]) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| date | date | Yes | | The datetime object (100AD-9999AD) | +| mask | string | No | dd-mmm-yy | Each keyword below will be replaced in the string by its respective datepart:
-d: Day of the month as digits; no leading zero for single-digit days.
-dd: Day of the month as digits; leading zero for single-digit days.
-ddd: Day of the week as a three-letter abbreviation.
-dddd: Day of the week as its full name.
-e: Day in a week (CF2016u3+).
-f: Day of a week in a month (CF2016u3+).
-D: Day in year. (pre-CF2016u3)
-m: Month as digits; no leading zero for single-digit months.
-mm: Month as digits; leading zero for single-digit months.
-mmm: Month as a three-letter abbreviation.
-mmmm: Month as its full name.
-M: Month in year. (pre-CF2016u3)
-k: Hour in a day (CF2016u3+).
-W: Week in a month (CF2016u3+).
-w: Week in a year (CF2016u3+).
-yy: Year as last two digits; leading zero for years less than 10.
-yyyy,YYYY: Year represented by four digits.
-gg: Period/era string.
-z: Time zone in unstandardized abbreviated format, for example, `EST` (CF2016u3+).
-Z: Time zone in hours of offset (RFC 822 TimeZone), for example, `+0530` (CF2016u3+).
-X: Time zone in hours of offset in ISO 8601 format. (CF2016u3+).
-X: `+05`
-XX: `+0530`
-XXX: `+5:30`
The following keywords are shorthand for specific full formats and cannot be combined with other masks:
-short: equivalent to `m/d/y`
-medium: equivalent to `mmm d, yyyy`
-long: equivalent to `mmmm d, yyyy`
-full: equivalent to `dddd, mmmm d, yyyy` | + +## Using the short mask + +```javascript +dateFormat("2015-04-11", "short") +``` + +### Expected Result: 4/11/15 + +## Using the long mask + +```javascript +dateFormat("2015-04-11", "long") +``` + +### Expected Result: April 11, 2015 + +## Using the full mask + +```javascript +dateFormat("2015-04-11", "full") +``` + +### Expected Result: Saturday, April 11, 2015 + +## Using the member function + +```javascript +createDate( 2022, 10, 1 ).dateFormat( 'mm/dd/yyyy' ) +``` + +### Expected Result: 10/01/2022 diff --git a/docs/functions/datepart.md b/docs/functions/datepart.md new file mode 100644 index 000000000..e3477c712 --- /dev/null +++ b/docs/functions/datepart.md @@ -0,0 +1,49 @@ +# datePart + +Extracts a part from a datetime value as a numeric. + +```javascript +datePart(datepart, date [,timezone]) +``` + +```javascript +returns numeric +``` + +## Member Function Syntax + +```javascript +date.datePart(datepart) +``` + +## Argument Reference + +| Name | Type | Required | Default | Description | +| --- | --- | --- | --- | --- | +| datepart | string | Yes | | yyyy: Year
q: Quarter
m: Month
y: Day of year
d: Day
w: Weekday
ww: Week
h: Hour
n: Minute
s: Second
l: Millisecond | +| date | date | Yes | | Datetime object (100AD-9999AD). | +| timezone | string | No | Timezone Specified in Lucee Administrator | This is only available in Lucee.
A datetime object is independent of a specific timezone; it is only an offset in milliseconds from `1970-1-1 00.00:00 UTC`.
The timezone only comes into play when you need specific information like hours in a day, minutes in an hour or which day it is, as these calculations depend on the timezone.
A timezone must be specified in order to translate the date object to something else. If you do not provide the timezone in the function call, it will default to the timezone specified in the Lucee Administrator (Settings/Regional), or the timezone specified for the current request using the function `setTimezone()`. | + +## All dateparts + +This example shows information available from datePart + +```javascript +
datePart Example
+Today's date is
Using datePart, we extract an integer representing the dateparts from that value Total offset in seconds is #info.utcTotalOffset#. Offset in hours is #info.utcHourOffset#. Offset in minutes minus the offset in hours is #info.utcMinuteOffset#. Is Daylight Savings Time in effect? #info.isDSTOn#. world This is example text
+
+
NOTE: This parameter is named `datetime` in Lucee. |
+| mask | string | No | dd-mmm-yyyy HH:nn:ss | The mask used to format the datetime output.
- d : Day of the month as digits; no leading zero for single-digit days.
- dd : Day of the month as digits; leading zero for single-digit days.
- EEE : Day of the week as a three-letter abbreviation.
- EEEE : Day of the week as its full name.
- m : Month as digits; no leading zero for single-digit months.
- mm : Month as digits; leading zero for single-digit months.
- mmm : Month as a three-letter abbreviation. (Dec)
- mmmm : Month as its full name.
- M : Month in year. (pre-CF2016u3)
- D : Day in year. (pre-CF2016u3)
- yy : Year as last two digits; leading zero for years less than 10.
- yyyy : Year represented by four digits.
- YYYY : Week year represented by four digits. (pre-CF2016u3)
- Y : Week year. (pre-CF2016u3)
- YY : Week Year as last two digits; leading zero for years less than 10. (pre-CF2016u3)
- G : Period/era string. (e.g. BC/AD)
- h : hours; no leading zero for single-digit hours. (12-hour clock)
- hh : hours; leading zero for single-digit hours. (12-hour clock)
- H : hours; no leading zero for single-digit hours. (24-hour clock)
- HH : hours; leading zero for single-digit hours. (24-hour clock)
- n : minutes; no leading zero for single-digit minutes.
- nn : minutes; leading zero for single-digit minutes.
- s : seconds; no leading zero for single-digit seconds.
- ss : seconds; leading zero for single-digit seconds.
- l or L : milliseconds, with no leading zeros.
- t : one-character time marker string, such as A or P.
- tt : multiple-character time marker string, such as AM or PM.
- w : Week of the year as digit. (JDK7+)
- ww : Week of the year as digits; leading zero for single-digit week. (JDK7+)
- W : Week of the month as digit. (JDK7+)
- WW : Week of the month as digits; leading zero for single-digit week. (JDK7+)
The following masks tell how to format the full date and time and cannot be combined with other masks:
- `short` : equivalent to `"m/d/y h:nn tt"`
- `medium` : equivalent to `"mmm d, yyyy h:nn:ss tt"`
- `long` : `medium` with full month name rather than abbreviation, followed by three-letter time zone; as in, `"mmmm d, yyyy h:mm:ss tt EST"`
- `full` : equivalent to `"EEEE, mmmm d, yyyy h:mm:ss tt EST"`
- `iso` CF2016+ Lucee5.3.8+ Formats the date time in ISO8601 format
- `iso8601` Lucee4.5+ Formats the date time in ISO8601 format
The function also follows Java date time mask, except for mask "a". For more information, refer to Date and Time Patterns topic in `SimpleDateFormat` Java API page.
JDK7 and JDK8 introduces the masks "w", "ww", "W", and "WW". |
+| timezone | string | No | System time-zone | The timezone to use. Can be the 3 letter code ("EST","UTC") or the full name full {"America/New_York") |
+
+## Mask = Short Example
+
+On Lucee with Java 11 adds a comma after year bug: LDEV-3744
+
+```javascript
+dateTimeFormat("2015-04-11 19:02", "short")
+```
+
+### Expected Result: 4/11/15 7:02 PM
+
+## Mask = Medium Example
+
+On Lucee with Java 11 adds a comma after year bug: LDEV-3744
+
+```javascript
+dateTimeFormat("2015-04-11 19:02", "medium")
+```
+
+### Expected Result: Apr 11, 2015 7:02:00 PM
+
+## Mask = Long Example
+
+On Lucee with Java 11 adds at before the time bug: LDEV-3744
+
+```javascript
+dateTimeFormat("2015-04-11 19:02", "long")
+```
+
+### Expected Result: April 11, 2015 7:02:00 PM UTC
+
+## Mask = Full Example
+
+On Lucee with Java 11 adds at before the time bug: LDEV-3744
+
+```javascript
+dateTimeFormat("2015-04-11 19:02", "full")
+```
+
+### Expected Result: Saturday, April 11, 2015 7:02:00 PM UTC
+
+## Date Time Format in ISO 8601
+
+Uses the CF2016+ `iso` or the Lucee4.5+ `iso8601` format depending on the engine. Note the depending on Java version the timezone format may differ (on Lucee at least, possible due to LDEV-3744)
+
+```javascript
+dateTimeFormat("2015-04-11 19:02", (server.keyExists("lucee")) ? "iso8601" : "iso")
+```
+
+### Expected Result: 2015-04-11T19:02:00+0000
+
+## Date Time Format member function syntax
+
+Simple date/time formatting using the member function syntax
+
+```javascript
+createDateTime( 2022, 10, 1, 9, 30, 0 ).dateTimeFormat( 'mm/dd/yyyy hh:nn:ss tt' )
+```
+
+### Expected Result: 10/01/2022 09:30:00 AM
diff --git a/docs/functions/day.md b/docs/functions/day.md
new file mode 100644
index 000000000..b7e4a6a09
--- /dev/null
+++ b/docs/functions/day.md
@@ -0,0 +1,46 @@
+# day
+
+ Determines the day of the month, in a date.
+ The ordinal for the day of the month, ranging from 1 to 31.
+
+```javascript
+day(date)
+```
+
+```javascript
+returns numeric
+```
+
+## Member Function Syntax
+
+```javascript
+date.day()
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| date | date | Yes | | Date or datetime object (100AD-9999AD).
When passing a datetime object as a string, enclose it in quotation marks. Otherwise, it is interpreted as a numeric representation of a datetime object. |
+
+## Determines the day of the month
+
+Uses the day function to determine the day of the month
+
+```javascript
+
When passing a datetime object as a string, enclose it in quotation marks. Otherwise, it is interpreted as a numeric representation of a datetime object. | |
+| calendar | string | No | gregorian | CF2016u8+ Indicates whether the week starts on Sunday (gregorian) or Monday (iso) | /Users/garethedwards/development/github/cfdocs/docs/functions/dayofweek.md|iso |
+
+## Determines the day of the week
+
+Uses the dayOfWeek function to determine the day of the week
+
+```javascript
+
Week starting with 1 for Sunday and ends with 7 for Saturday:
- 1 = Sunday
- 2 = Monday
- 3 = Tuesday
- 4 = Wednesday
- 5 = Thursday
- 6 = Friday
- 7 = Saturday |
+| locale | string | No | Default JVM Locale | Locale to use instead of the default JVM locale. |
+
+## Get Sunday
+
+```javascript
+dayOfWeekAsString(1)
+```
+
+### Expected Result: Sunday
diff --git a/docs/functions/dayofweekshortasstring.md b/docs/functions/dayofweekshortasstring.md
new file mode 100644
index 000000000..dc3489143
--- /dev/null
+++ b/docs/functions/dayofweekshortasstring.md
@@ -0,0 +1,34 @@
+# dayOfWeekShortAsString
+
+Returns the first three letters of the day of the week passed to the function
+
+```javascript
+dayOfWeekShortAsString(day_of_week [, locale])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| day_of_week | numeric | Yes | | Only values from 1 to 7 are valid.
Week starting with 1 for Sunday and ends with 7 for Saturday. |
+| locale | string | No | | |
+
+## Get Sunday
+
+```javascript
+dayOfWeekShortAsString(1)
+```
+
+### Expected Result: Sun
+
+## Get Sunday with french locale
+
+```javascript
+dayOfWeekShortAsString(1,"fr")
+```
+
+### Expected Result: dim.
diff --git a/docs/functions/dayofyear.md b/docs/functions/dayofyear.md
new file mode 100644
index 000000000..039d7a5d1
--- /dev/null
+++ b/docs/functions/dayofyear.md
@@ -0,0 +1,35 @@
+# dayOfYear
+
+ Determines the day of the year, in a date.
+
+```javascript
+dayOfYear(date)
+```
+
+```javascript
+returns numeric
+```
+
+## Member Function Syntax
+
+```javascript
+date.dayOfYear()
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| date | date | Yes | | Date or datetime object (100AD-9999AD). |
+
+## Determines the day of the year
+
+Uses the dayOfYear function to determine the day of the year
+
+```javascript
+
When passing a datetime object as a string, enclose it in quotation marks, otherwise, it is interpreted as a numeric representation of a datetime object. |
+
+## Determines the number of days in a month
+
+Uses the daysInMonth function to determine the number of days in a month
+
+```javascript
+
");
+
+formattedWithSeparators = decimalFormat(1000000); // 1,000,000.00
+writeOutput(formattedWithSeparators & "
");
+
+formattedDecimal = decimalFormat(987.15); // 987.15
+writeOutput(formattedDecimal & "
");
+
+formattedRoundedUp = decimalFormat(456.789); // 456.79 - rounds up
+writeOutput(formattedRoundedUp & "
");
+```
diff --git a/docs/functions/decodeforhtml.md b/docs/functions/decodeforhtml.md
new file mode 100644
index 000000000..dcc7e177a
--- /dev/null
+++ b/docs/functions/decodeforhtml.md
@@ -0,0 +1,33 @@
+# decodeForHTML
+
+ Decodes an HTML encoded string.
+
+```javascript
+decodeForHTML(string);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | The encoded string to decode. |
+
+## Tag Syntax
+
+```javascript
+
+URL Encoded: #urlencoded#
+URL Decoded: #urldecoded#
+
* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key. |
+| algorithm | string | No | CFMX_COMPAT | The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string. See the `encrypt` function for additional algorithms.
ColdFusion Standard Edition installs the following algorithms:
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
NOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:
* DESX: The extended Data Encryption Standard symmetric encryption algorithm.
* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.
* RC4: The RC4 symmetric encryption algorithm.
* RC5: The RC5 encryption algorithm.
* PBE: Password-based encryption algorithm defined in PKCS #5.
* AES/GCM/NoPadding: Encryption algorithm.
NOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms. |
+| encoding | string | No | UU | The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.
* Base64: the Base64 algorithm, as specified by IETF RFC 2045.
* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
* UU: the UNIX standard UUEncode algorithm (default).
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iv | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `SALT`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| salt | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `IV`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iterations | numeric | No | 0 | The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.
NOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.
NOTE: You must use the same value to encrypt and decrypt the data. |
+
+## Encrypt and Decrypt a Secret
+
+Generate an AES 128 bit key and then use it to encrypt and decrypt a secret.
+
+```javascript
+ex={};
+ex.key = generateSecretKey("AES");
+ex.secret = "top secret";
+ex.encrypted=encrypt(ex.secret, ex.key, "AES", "Base64");
+ex.decrypted=decrypt(ex.encrypted, ex.key, "AES", "Base64");
+writeDump(ex);
+```
diff --git a/docs/functions/decryptbinary.md b/docs/functions/decryptbinary.md
new file mode 100644
index 000000000..3f50abb48
--- /dev/null
+++ b/docs/functions/decryptbinary.md
@@ -0,0 +1,23 @@
+# decryptBinary
+
+Decrypts encrypted binary data with the specified key, value, algorithm, salt, and iterations.
+
+```javascript
+decryptBinary(binaryData, key [, algorithm [, encoding] [, iv | salt [, iterations]]])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| binaryData | string | Yes | | Binary data to decrypt. |
+| key | string | Yes | | Key or seed used to encrypt the string.
* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key. |
+| algorithm | string | No | CFMX_COMPAT | The algorithm to use to decrypt the string. Must be the same as the algorithm used to encrypt the string. See the `encrypt` function for additional algorithms.
ColdFusion Standard Edition installs the following algorithms:
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option and not recommended. (default).
* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
NOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:
* DESX: The extended Data Encryption Standard symmetric encryption algorithm.
* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.
* RC4: The RC4 symmetric encryption algorithm.
* RC5: The RC5 encryption algorithm.
* PBE: Password-based encryption algorithm defined in PKCS #5.
* AES/GCM/NoPadding: Encryption algorithm.
NOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms. |
+| encoding | string | No | UU | The binary encoding used to represent the data as a string. Must be the same as the algorithm used to encrypt the string.
* Base64: the Base64 algorithm, as specified by IETF RFC 2045.
* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
* UU: the UNIX standard UUEncode algorithm (default).
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iv | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `salt`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| salt | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `iv`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iterations | numeric | No | 0 | The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.
NOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.
NOTE: You must use the same value to encrypt and decrypt the data. |
diff --git a/docs/functions/deleteclientvariable.md b/docs/functions/deleteclientvariable.md
new file mode 100644
index 000000000..a0a480a14
--- /dev/null
+++ b/docs/functions/deleteclientvariable.md
@@ -0,0 +1,18 @@
+# deleteClientVariable
+
+ Deletes a client variable. Returns `true` if variable was successfully deleted; `false` if it was not deleted.
+NOTE: To test for the existence of a variable, use `IsDefined` or `structKeyExists`.)
+
+```javascript
+deleteClientVariable(name)
+```
+
+```javascript
+returns boolean
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| name | string | Yes | | The name of a client variable to delete, surrounded by double-quotation marks. |
diff --git a/docs/functions/deserialize.md b/docs/functions/deserialize.md
new file mode 100644
index 000000000..54a86eb58
--- /dev/null
+++ b/docs/functions/deserialize.md
@@ -0,0 +1,19 @@
+# deserialize
+
+Deserializes a string.
+
+```javascript
+deserialize(string, type, useCustomSerializer);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | A string that needs to be deserialized. |
+| type | string | Yes | | The type of the data to be deserialized. ColdFusion by default supports XML and JSON formats. You can also implement support for other types in the CustomSerializer CFC. |
+| useCustomSerializer | boolean | Yes | true | Whether to use the custom serializer or not. The custom serializer will always be used for deserialization.
If false, the XML/JSON deserialization will be done using the default ColdFusion behavior.
If any other type is passed with `useCustomSerializer` as false, then `TypeNotSupportedException` will be thrown. |
diff --git a/docs/functions/deserializeavro.md b/docs/functions/deserializeavro.md
new file mode 100644
index 000000000..3b1b565e8
--- /dev/null
+++ b/docs/functions/deserializeavro.md
@@ -0,0 +1,36 @@
+# deserializeAvro
+
+Converts an Avro data representation into CFML data.
+
+```javascript
+deserializeAvro(data, readerSchema [, strictMapping, useCustomSerialization])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| data | any | Yes | | Avro serialized data |
+| readerSchema | string | Yes | | The Avro schema as a string or the absolute path to the schema |
+| strictMapping | boolean | No | YES | Specifies whether to convert the Avro strictly. If true, converts the Avro binary to matching ColdFusion data types. |
+| useCustomSerialization | boolean | No | YES | Whether to use the customSerializer |
+
+## Deserialize an Avro serialized query (Script syntax)
+
+```javascript
+news = queryNew("id,title",
+ "integer,varchar",
+ [ {"id":1,"title":"Dewey defeats Truman"}, {"id":2,"title":"Man walks on Moon"} ]);
+newsSchema = '{
+ "namespace": "my.example",
+ "type": "record",
+ "name": "News",
+ "fields": [ {"name":"id","type":"int"}, {"name":"title","type":"string"} ]
+}';
+avro = serializeAvro(news, newsSchema);
+writeDump(deserializeAvro(avro, newsSchema));
+```
diff --git a/docs/functions/deserializejson.md b/docs/functions/deserializejson.md
new file mode 100644
index 000000000..874f0b207
--- /dev/null
+++ b/docs/functions/deserializejson.md
@@ -0,0 +1,28 @@
+# deserializeJSON
+
+ Converts a JSON (JavaScript Object Notation) string data representation into CFML data, such as a CFML structure or array.
+
+```javascript
+deserializeJSON(json [, strictMapping, useCustomSerializer])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| json | string | Yes | | A string that contains a valid JSON construct or variable that represents one. |
+| strictMapping | boolean | No | true | A Boolean value that specifies whether to convert the JSON strictly. If true, everything becomes structures. |
+| useCustomSerializer | boolean | No | true | CF11+ Use custom serializer if defined. See: https://helpx.adobe.com/coldfusion/developing-applications/changes-in-coldfusion/restful-web-services-in-coldfusion.html |
+
+## Convert JSON into CF Structure
+
+```javascript
+person = deserializeJSON( '{"company":"Foundeo","name":"Pete Freitag"}' );
+writeOutput( person.company );
+```
+
+### Expected Result: Foundeo
diff --git a/docs/functions/deserializeprotobuf.md b/docs/functions/deserializeprotobuf.md
new file mode 100644
index 000000000..3ee5c9100
--- /dev/null
+++ b/docs/functions/deserializeprotobuf.md
@@ -0,0 +1,34 @@
+# deserializeProtobuf
+
+Converts a Protobuf data representation into CFML data.
+
+```javascript
+serializeProtobuf(data, schema [, messageType, queryFormat, useCustomSerialization, protoPath])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| data | any | Yes | | Protobuf serialized data |
+| schema | string | Yes | | The Protobuf schema as a string or the absolute path to the schema |
+| messageType | string | No | | A message type from given schema as string. This is optional if schema contains one and only one message type. |
+| strictMapping | boolean | No | YES | Specifies whether to convert the Protobuf strictly. If true, converts the Protobuf binary to matching ColdFusion data types. |
+| useCustomSerialization | boolean | No | YES | Whether to use the customSerializer |
+| protoPath | string | No | | Specifies a directory in which the compiler looks for imported files defined in the schema. By default, it will be the current schema's parent path. |
+
+## Deserialize a Protobuf serialized query (Script syntax)
+
+```javascript
+news = queryNew("id,title",
+ "integer,varchar",
+ [ {"id":1,"title":"Dewey defeats Truman"}, {"id":2,"title":"Man walks on Moon"} ]);
+newsSchema = 'syntax = "proto3";
+message News { int32 id = 1; string title = 2; }';
+protobuf = serializeProtobuf(news, newsSchema);
+writeDump(deserializeProtobuf(protobuf, newsSchema));
+```
diff --git a/docs/functions/deserializexml.md b/docs/functions/deserializexml.md
new file mode 100644
index 000000000..38779660b
--- /dev/null
+++ b/docs/functions/deserializexml.md
@@ -0,0 +1,24 @@
+# deserializeXML
+
+Deserializes a string in XML format to a ColdFusion object.
+
+```javascript
+deserializeXML(string [,useCustomSerializer]);
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | A string that needs to be deserialized. |
+| useCustomSerializer | boolean | Yes | YES | This identifies whether or not to use the custom serializer. The default value is true. The custom serializer will be always used for XML deserialization. If false, the XML/JSON deserialization will be done using the default ColdFusion behavior. If any other type is passed with `useCustomSerializer` as false, then `TypeNotSupportedException` will be thrown. |
+
+## Tag Syntax
+
+```javascript
+
")
+```
+
+### Expected Result: <br>
diff --git a/docs/functions/encodeforcss.md b/docs/functions/encodeforcss.md
new file mode 100644
index 000000000..554007526
--- /dev/null
+++ b/docs/functions/encodeforcss.md
@@ -0,0 +1,46 @@
+# encodeForCSS
+
+Encodes the input string for safe output in CSS to prevent Cross Site Scripting attacks.
+
+```javascript
+encodeForCSS(string [,canonicalize]);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | The string to encode. |
+| canonicalize | boolean | No | false | If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false.
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Tag Syntax
+
+Encoding CSS values.
+
+```javascript
+
+
+
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Simple encodeForDN Example
+
+```javascript
+encodeForDN("x,y")
+```
+
+### Expected Result: x\,y
diff --git a/docs/functions/encodeforhtml.md b/docs/functions/encodeforhtml.md
new file mode 100644
index 000000000..94f0c1577
--- /dev/null
+++ b/docs/functions/encodeforhtml.md
@@ -0,0 +1,28 @@
+# encodeForHTML
+
+Encodes the input string for safe output in the body of a HTML tag. The encoding in meant to mitigate Cross Site Scripting (XSS) attacks. This function can provide more protection from XSS than the `HTMLEditFormat` or `XMLFormat` functions do.
+
+```javascript
+encodeForHTML(string [, canonicalize])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | A string to encode |
+| canonicalize | boolean | No | false | If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded. The default value for canonicalize is false.
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Simple encodeForHTML Example
+
+Pass in a tag and HTML encode the result.
+
+```javascript
+encodeForHTML("
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Simple encodeForHTMLAttribute Example
+
+Shows how and where encodeForHTMLAttribute would be used.
+
+```javascript
+
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using `canonicalize` method and then do encoding. |
+
+## Simple encodeForJavaScript Example
+
+```javascript
+encodeForJavaScript("foo()")
+```
+
+### Expected Result: foo\x28\x29
diff --git a/docs/functions/encodeforldap.md b/docs/functions/encodeforldap.md
new file mode 100644
index 000000000..5f768859a
--- /dev/null
+++ b/docs/functions/encodeforldap.md
@@ -0,0 +1,26 @@
+# encodeForLDAP
+
+Encodes the input string for safe output in LDAP queries to prevent Cross Site Scripting attacks.
+
+```javascript
+encodeForLDAP(string [,canonicalize]);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | String to encode. |
+| canonicalize | boolean | No | false | If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded.
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Script Syntax
+
+```javascript
+encodeForLDAP("pete) (| (password = * ) )")
+```
+
+### Expected Result: pete\29 \28| \28password = \2a \29 \29
diff --git a/docs/functions/encodeforurl.md b/docs/functions/encodeforurl.md
new file mode 100644
index 000000000..bfebdc7c7
--- /dev/null
+++ b/docs/functions/encodeforurl.md
@@ -0,0 +1,43 @@
+# encodeForURL
+
+Encodes the input string for safe output in URLs to prevent Cross Site Scripting attacks.
+
+```javascript
+encodeForURL(string [,canonicalize]);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | The string to encode. |
+| canonicalize | boolean | No | false | If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded and canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## URL Encode a value
+
+```javascript
+encodeForURL("
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Simple encodeForXML Example
+
+Encodes the ampersand into an XML entity.
+
+```javascript
+encodeForXML("Fred & Ted")
+```
+
+### Expected Result: Fred & Ted
diff --git a/docs/functions/encodeforxmlattribute.md b/docs/functions/encodeforxmlattribute.md
new file mode 100644
index 000000000..46d2cdb63
--- /dev/null
+++ b/docs/functions/encodeforxmlattribute.md
@@ -0,0 +1,28 @@
+# encodeForXMLAttribute
+
+Encodes a string for safe output within an XML attribute to prevent Cross Site Scripting attacks. Use encodeForXML when outputting a variable inside a XML tag body.
+
+```javascript
+encodeForXMLAttribute(string [,canonicalize]);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | The string to encode. |
+| canonicalize | boolean | No | false | If set to true, canonicalization happens before encoding. If set to false, the given input string will just be encoded.
When this parameter is not specified, canonicalization will not happen. By default, when canonicalization is performed, both mixed and multiple encodings will be allowed.
To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Simple encodeForXMLAttribute Example
+
+Encodes the single quote into an XML entity.
+
+```javascript
+encodeForXMLAttribute("It's for use in attribute values")
+```
+
+### Expected Result: It's for use in attribute values
diff --git a/docs/functions/encodeforxpath.md b/docs/functions/encodeforxpath.md
new file mode 100644
index 000000000..3ecad89df
--- /dev/null
+++ b/docs/functions/encodeforxpath.md
@@ -0,0 +1,26 @@
+# encodeForXPath
+
+Returns an encoded string for safe use in an XPATH query.
+
+```javascript
+encodeForXPath(string [,canonicalize]);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | The string to encode. |
+| canonicalize | boolean | No | | If set to true, canonicalization happens before encoding.
If set to false, the given input string will just be encoded.
When this parameter is not specified, canonicalization will not happen.
By default, when canonicalization is performed, both mixed and multiple encodings will be allowed. To use any other combinations you should canonicalize using canonicalize method and then do encoding. |
+
+## Tag Syntax
+
+```javascript
+encodeForXPath("'or 1=1",false)
+```
+
+### Expected Result: 'or 1=1
diff --git a/docs/functions/encrypt.md b/docs/functions/encrypt.md
new file mode 100644
index 000000000..85deb244a
--- /dev/null
+++ b/docs/functions/encrypt.md
@@ -0,0 +1,56 @@
+# encrypt
+
+ Encrypts a string, using a symmetric key-based algorithm, in which the same key is used to encrypt and decrypt a string. The security of the encrypted string depends on maintaining the secrecy of the key, and the algorithm choice. Algorithm support is determined by the installed default JCE provider in Lucee or ColdFusion Standard. On ColdFusion Enterprise the algorithms are provided by the FIPS certified RSA BSafe Crypto-J JCE provider.
+
+```javascript
+encrypt(string, key [, algorithm [, encoding] [, iv | salt [, iterations]]])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | String to encrypt. |
+| key | string | Yes | | Key or seed used to encrypt the string.
* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key. |
+| algorithm | string | No | CFMX_COMPAT | The algorithm to use to encrypt the string.
ColdFusion Standard Edition installs the following algorithms:
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
NOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This includes:
* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
* DESX: The extended Data Encryption Standard symmetric encryption algorithm.
* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.
* RC4: The RC4 symmetric encryption algorithm.
* RC5: The RC5 encryption algorithm.
* PBE: Password-based encryption algorithm defined in PKCS #5.
* AES/GCM/NoPadding: Encryption algorithm.
NOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms. |
+| encoding | string | No | UU | The binary encoding used to represent the data as a string.
* Base64: the Base64 algorithm, as specified by IETF RFC 2045.
* Hex: the characters A-F and 0-9 represent the hexadecimal byte values.
* UU: the UNIX standard UUEncode algorithm (default).
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iv | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `SALT`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| salt | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `IV`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iterations | numeric | No | 0 | The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.
NOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.
NOTE: You must use the same value to encrypt and decrypt the data. |
+
+## Encrypt using AES Encryption in ECB Mode
+
+The key must be generated using the generateSecretKey("AES") function.
+
+```javascript
+encrypt("top secret", "WTq8zYcZfaWVvMncigHqwQ==", "AES", "Base64")
+```
+
+### Expected Result: keciULin7bxOWvN/BOarWw==
+
+## Encrypt using AES Cipher Block Chaining (CBC) mode
+
+By default encrypt() uses the Electronic Code Book (ECB) mode for encryption.
+ For increased security you should specify the mode and padding to use. In this example we will use CBC mode and PKCS5Padding. The value of the encrypted string will be different every time it runs because the IV is generated at random.
+
+```javascript
+msg = 'data to encrypt';
+key = generateSecretKey('AES');
+encMsg = encrypt( msg, key, 'AES/CBC/PKCS5Padding', 'HEX');
+writeOutput( encMsg );
+```
+
+## Encrypt using AES Galois/Counter Mode (GCM)
+
+Using GCM mode works CF2016+ after update 2. It does not currently work on Lucee (bug: LDEV-904)
+
+```javascript
+msg = 'data to encrypt';
+key = generateSecretKey('AES');
+encMsg = encrypt( msg, key, 'AES/GCM/NoPadding', 'Base64');
+writeOutput( encMsg );
+```
diff --git a/docs/functions/encryptbinary.md b/docs/functions/encryptbinary.md
new file mode 100644
index 000000000..b6475d1e9
--- /dev/null
+++ b/docs/functions/encryptbinary.md
@@ -0,0 +1,22 @@
+# encryptBinary
+
+Encrypts binary data using a specific algorithm and encoding method.
+
+```javascript
+encryptBinary(binaryData, key [, algorithm [, encoding] [, iv | salt [, iterations]]])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| binaryData | any | Yes | | Binary data to encrypt. |
+| key | string | Yes | | Key or seed used to encrypt the string.
* For the `CFMX_COMPAT` algorithm, any combination of any number of characters; used as a seed used to generate a 32-bit encryption key.
* For all other algorithms, a key in the format used by the algorithm. For these algorithms, use the `GenerateSecretKey` function to generate the key. |
+| algorithm | string | No | CFMX_COMPAT | The algorithm to use to encrypt the string.
ColdFusion Standard Edition installs the following algorithms:
* CFMX_COMPAT: the algorithm used in ColdFusion MX and prior releases. This algorithm is the least secure option (default).
* AES: the Advanced Encryption Standard specified by the National Institute of Standards and Technology (NIST) FIPS-197.
* BLOWFISH: the Blowfish algorithm defined by Bruce Schneier.
* DES: the Data Encryption Standard algorithm defined by NIST FIPS-46-3.
* DESEDE: the "Triple DES" algorithm defined by NIST FIPS-46-3.
NOTE: ColdFusion Enterprise Edition installs RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This also includes:
* DESX: The extended Data Encryption Standard symmetric encryption algorithm.
* RC2: The RC2 block symmetric encryption algorithm defined by RFC 2268.
* RC4: The RC4 symmetric encryption algorithm.
* RC5: The RC5 encryption algorithm.
* PBE: Password-based encryption algorithm defined in PKCS #5.
* AES/GCM/NoPadding: Encryption algorithm.
NOTE: If you install additional cryptography algorithms, you can also specify any of its encryption and decryption algorithms. |
+| iv | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `salt`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Block Encryption Algorithms: This is the binary Initialization Vector value to use with the algorithm. The algorithm must contain a Feedback Mode other than ECB. This must be a binary value that is exactly the same size as the algorithm block size.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| salt | binary | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `iv`.
Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
* For Password Based Encryption Algorithms: This is the binary Salt value to transform the password into a key.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter. |
+| iterations | numeric | No | 0 | The number of iterations to transform the password into a binary key. Specify this parameter to adjust ColdFusion encryption to match the details of other encryption software.
NOTE: If you specify this parameter, you must also specify the `algorithm` parameter with a Password Based Encryption (PBE) algorithm.
NOTE: This parameter is used with the `salt` parameter. Do not specify this parameter for Block Encryption Algorithms.
NOTE: You must use the same value to encrypt and decrypt the data. |
diff --git a/docs/functions/entitydelete.md b/docs/functions/entitydelete.md
new file mode 100644
index 000000000..9ade3be7e
--- /dev/null
+++ b/docs/functions/entitydelete.md
@@ -0,0 +1,26 @@
+# entityDelete
+
+Deletes the record from the database for the specified entity. Depending on the cascade attribute specified in the mapping, it deletes the associated objects also.
+
+```javascript
+entityDelete(entity)
+```
+
+```javascript
+returns void
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| entity | variableName | Yes | | Name of the entity being deleted. |
+
+## Delete an existing entity
+
+Loads an ORM entity from the database, then deletes it
+
+```javascript
+user = entityLoadByPK("User", userID);
+entityDelete(user);
+```
diff --git a/docs/functions/entityload.md b/docs/functions/entityload.md
new file mode 100644
index 000000000..7193f1ace
--- /dev/null
+++ b/docs/functions/entityload.md
@@ -0,0 +1,42 @@
+# entityLoad
+
+Loads and returns an array of entities of the specified entityname or an entity if unique=true or if a primary key id is passed in to filterCriteria.
+
+```javascript
+entityLoad(entityName [,id | Filter ,unique | Order ,options])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| entityName | string | Yes | | Name of CFC / Entity to be loaded. | |
+| id | any | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `Filter`.
The primary key value of the entity to be loaded. Or if the entity has a composite key, then this is specified as a ColdFusion struct (key-value pair). | |
+| Filter | any | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `id`.
This is a ColdFusion struct (key-value pair) of property names and values. If there is more than one key-value pair, then use the `AND` keyword. | |
+| unique | boolean | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `Order`.
When true a single entity is returned, otherwise an array is returned.
If you are sure only one record exists for the `Filter`, then you can specify `unique=true` to return a single entity instead of an array. If you set `unique=true` and multiple records are returned, then an exception occurs. | |
+| Order | string | No | | THIS PARAMETER IS MUTUALLY EXCLUSIVE WITH `unique`.
String used to specify the sort order of the entities that are returned.
If this is specified, the function returns an array of entities that satisfy the `Filter` and is sorted as specified by `Order`.
Usage example: LastName ASC, FirstName ASC | |
+| options | struct | No | | A struct with possible keys:
ignorecase : Ignores the case of sort order when set to true. Use only if you've specified the `Order` parameter.
offset : Specifies the position from which to retrieve the objects.
maxResults : Specifies the maximum number of objects to be retrieved.
cacheable : Whether the result has to be cached in secondary cache. Default is `false`.
cachename : Name of the cache in secondary cache.
timeout : Specified the timeout value (in seconds) for the query | /Users/garethedwards/development/github/cfdocs/docs/functions/entityload.md|timeout |
+
+## Load by PK
+
+Loads an entity by primary key value
+
+```javascript
+entityLoad("Employee", url.employee_id)
+```
+
+### Expected Result: An Employee CFC Instance
+
+## Get multiple entities
+
+Returns an array of Employee instances with last name Smith
+
+```javascript
+entityLoad("Employee", {LastName="Smith"})
+```
+
+### Expected Result: array
diff --git a/docs/functions/entityloadbyexample.md b/docs/functions/entityloadbyexample.md
new file mode 100644
index 000000000..92f68a71a
--- /dev/null
+++ b/docs/functions/entityloadbyexample.md
@@ -0,0 +1,28 @@
+# entityLoadByExample
+
+Loads and returns an array of objects that match the `sampleEntity`.
+
+```javascript
+entityLoadByExample(sampleEntity [, unique, matchCriteria])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| sampleEntity | string | Yes | | No Help Available |
+| unique | boolean | No | | When true a single entity is returned, otherwise an array is returned.
If you are sure only one record exists for the `Filter`, then you can specify `unique=true` to return a single entity instead of an array. If you set `unique=true` and multiple records are returned, then an exception occurs. |
+| matchCriteria | any | No | | No Help Available |
+
+## Tag Syntax
+
+```javascript
+
* Lucee4, Lucee5+ url
* Lucee5+ HTML |
+| string | string | Yes | | string to encode |
diff --git a/docs/functions/esapiencode.md b/docs/functions/esapiencode.md
new file mode 100644
index 000000000..1acb3c53f
--- /dev/null
+++ b/docs/functions/esapiencode.md
@@ -0,0 +1,18 @@
+# esapiEncode
+
+Calling the various encodeFor functions: encodeForHTML, etc.
+
+```javascript
+esapiEncode(encodeFor,string)
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| encodeFor | string | Yes | | Encode for what, valid values are:
- css: for output inside Cascading Style Sheets (CSS)
- dn: for output in LDAP Distinguished Names
- html: for output inside HTML
- html_attr: for output inside HTML Attributes
- javascript: for output inside JavaScript
- ldap: for output in LDAP queries
- url: for output in URL
- vbscript: for output inside vbscript
- xml: for output inside XML
- xml_attr: for output inside XML Attributes
- xpath: for output in XPath. |
+| string | string | Yes | | String to encode. |
diff --git a/docs/functions/evaluate.md b/docs/functions/evaluate.md
new file mode 100644
index 000000000..2ec91a75c
--- /dev/null
+++ b/docs/functions/evaluate.md
@@ -0,0 +1,29 @@
+# evaluate
+
+Evaluates one or more string expressions, dynamically, from left to right. (The results of an evaluation on the left can have meaning in an expression to the right.) Returns the result of evaluating the rightmost expression.
+
+```javascript
+evaluate(expression)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| expression | string | Yes | | Expression to evaluate. String expressions can be complex. If a string expression contains a single- or double-quotation mark, the mark must be escaped. This function is useful for forming one variable from multiple variables. |
+
+## Tag Syntax
+
+```javascript
+
+
Each position specifies who is granted the access:
* 1st position: owner
* 2nd position: group
* 3rd position: other
The number at each position specifies which right is granted:
* 4: read (r)
* 2: write (w)
* 1: execute (x)
Let's assume that matrix as seen on Linux systems: rwxrwxrwx. You can combine the numbers for read, write and execute permissions to achieve combined permissions:
* 3: write & execute
* 5: read & execute
* 6: read & write
* 7: read, write and execute
For example, 400 specifies that only the owner can read the file; 004 specifies that anyone can read the file.
In rwe-notation 400 means r-------- and 004 ------r-- whereas 751 means rwxr-er--. |
+
+## Grant read access to everyone
+
+```javascript
+
readonly/hidden sets the given attribute to `true` and the other one to `false`
normal sets both to false | /Users/garethedwards/development/github/cfdocs/docs/functions/filesetattribute.md|normal |
+
+## Create a temporary file and then change read-only mode
+
+```javascript
+myFile = getTempFile(getTempDirectory(),"testFile");
+writeOutput('is writable: '&getFileInfo(myFile).canWrite);
+fileSetAttribute(myFile,'readOnly');
+writeOutput(' → '&getFileInfo(myFile).canWrite);
+```
+
+### Expected Result: is writable: YES → NO
diff --git a/docs/functions/filesetlastmodified.md b/docs/functions/filesetlastmodified.md
new file mode 100644
index 000000000..16ac2d970
--- /dev/null
+++ b/docs/functions/filesetlastmodified.md
@@ -0,0 +1,27 @@
+# fileSetLastModified
+
+Sets the date when an on-disk or in-memory file was most recently modified.
+
+```javascript
+fileSetLastModified(filePath, date)
+```
+
+```javascript
+returns void
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| filePath | string | Yes | | An absolute path to an on-disk or in-memory file on the server |
+| date | date | Yes | | The date to set for when the file was last modified |
+
+## Script Syntax
+
+```javascript
+
If you specify file extensions, use this format: `.txt,.jpg`, not `txt`, `*.txt`, or `*.*`. You can use `*` as a wildcard to accept all files. |
+| onConflict | string | No | error | Action to take if file has the same name of a file in the directory. |
+| strict | boolean | No | true | CF10+ Defines which method is used to determine the file type to check against the value of the `mimeType` parameter.
`true`: The first few bytes of the uploaded file are used to determine the MIME type.
`false`: The MIME type provided by the browser in the request payload is used. |
+
+## Upload form with strict check on MIME type
+
+```javascript
+
+
+
`true`: The first few bytes of the uploaded file are used to determine the MIME type.
`false`: The MIME type provided by the browser in the request payload is used. |
+| continueOnError | boolean | No | false | CF11+ Whether to continue uploading the remaining files when uploading one of the files fails. |
+| errorVariable | variableName | No | cffile.uploadAllErrors | CF11+ The name of the variable in which the array of structs of file upload errors will be stored.
The upload failure information error structure contains the following fields:
`REASON` - The reason for the failure
`DETAIL` - File upload failure detail
MESSAGE - A detailed message depicting the failure
CLIENTFILE - Name of the file uploaded from the client's system
`CLIENTFILEEXT` - Extension of the uploaded file on the client system (without a period)
`CLIENTFILENAME` - Name of the uploaded file on the client system (without an extension)
`INVALID_FILE_TYPE` - If the file mime type or extension is not in the specified accept attribute. If the reason is INVALID_FILE_TYPE, two additional keys will be available in the structure.
--`ACCEPT`: list of mime types or file extensions given in the tag
--`MIMETYPE`: mime type of the uploaded file
`EMPTY_FILE` - If the uploaded file is an empty file
`FILE_EXISTS` - If any file with the given name already exists in the destination and the overwritepolicy is error
`DEST` - The destination where file is copied
`FORM_FILE_NOT_FOUND` - If the uploaded file is not found on the server |
+| allowedExtensions | string | No | | CF2018+ A comma-separated list of file extensions, which will be allowed for upload.
For example, .png, .jpg, or, .jpeg.
You can use `*` (star) to allow all files, except where you specify the MIME type in the accept attribute.
Values specified in the attribute allowedExtensions override the list of blocked extensions in the server or application settings. |
diff --git a/docs/functions/filewrite.md b/docs/functions/filewrite.md
new file mode 100644
index 000000000..324caac23
--- /dev/null
+++ b/docs/functions/filewrite.md
@@ -0,0 +1,25 @@
+# fileWrite
+
+Writes the data to the file object or file path specified using the charset specified or the java default character set if unspecified.
+
+```javascript
+fileWrite(filePath, data [, charset])
+```
+
+```javascript
+returns void
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| filePath | any | Yes | | A file object or a file system path string. |
+| data | any | Yes | | The variable to write to the file. |
+| charset | string | No | | An optional character set that the data is encoded with. Defaults to the Java default character set (which is usually UTF-8). |
+
+## Write a Temporary File
+
+```javascript
+fileWrite( getTempFile( getTempDirectory(), "tempFile"), "My Data" );
+```
diff --git a/docs/functions/filewriteline.md b/docs/functions/filewriteline.md
new file mode 100644
index 000000000..c89f4c241
--- /dev/null
+++ b/docs/functions/filewriteline.md
@@ -0,0 +1,26 @@
+# fileWriteLine
+
+Appends content to an existing file
+
+```javascript
+fileWriteLine(file, data)
+```
+
+```javascript
+returns void
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| file | any | Yes | | The file where you want to add your content |
+| data | string | Yes | | Content to add to the file |
+
+## Script Syntax
+
+```javascript
+myfile = fileOpen("c:\temp\test1.txt", "write");
+fileWriteLine(myfile,"This line is new.");
+fileClose(myfile);
+```
diff --git a/docs/functions/find.md b/docs/functions/find.md
new file mode 100644
index 000000000..e6b747598
--- /dev/null
+++ b/docs/functions/find.md
@@ -0,0 +1,29 @@
+# find
+
+Finds the first occurrence of a substring in a string, from a specified start position. If substring is not in string, returns zero. The search is case-sensitive.
+
+```javascript
+find(substring, string [, start])
+```
+
+```javascript
+returns numeric
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| substring | string | Yes | | The string you are looking for. |
+| string | string | Yes | | The string to search in. |
+| start | numeric | No | 1 | The position from which to start searching in the string |
+
+## Find apple in the string
+
+Returns the index of apple in the string.
+
+```javascript
+find("apple", "An apple a day keeps the doctor away.")
+```
+
+### Expected Result: 4
diff --git a/docs/functions/findnocase.md b/docs/functions/findnocase.md
new file mode 100644
index 000000000..9b794359a
--- /dev/null
+++ b/docs/functions/findnocase.md
@@ -0,0 +1,27 @@
+# findNoCase
+
+Finds the first occurrence of a substring in a string, from a specified start position. If substring is not in string, returns zero. The search is case-insensitive.
+
+```javascript
+findNoCase(substring, string [, start])
+```
+
+```javascript
+returns numeric
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| substring | string | Yes | | The string for which you are looking |
+| string | string | Yes | | The string in which to search |
+| start | numeric | No | 1 | The position from which to start searching in the string |
+
+## Script Syntax
+
+```javascript
+findNoCase("s", "cfdocs.org", 0)
+```
+
+### Expected Result: 6
diff --git a/docs/functions/findoneof.md b/docs/functions/findoneof.md
new file mode 100644
index 000000000..114b747c9
--- /dev/null
+++ b/docs/functions/findoneof.md
@@ -0,0 +1,55 @@
+# findOneOf
+
+Finds the first occurrence of any one of a set of characters in a string, from a specified start position. The search is case-sensitive.
+
+ Returns the position of the first member of set found in string; or 0, if no member of set is found in string.
+
+```javascript
+findOneOf(set, string [, start])
+```
+
+```javascript
+returns numeric
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| set | string | Yes | | String which contains one or more characters to search for. |
+| string | string | Yes | | String in which to search. |
+| start | numeric | No | 1 | Start position of search. Can be 1 through the length of the string to search. Choosing a start index greater than the length of the string to search will return a 0. |
+
+## Find first instance starting from beginning of string.
+
+We're not passing a start index in this example.
+
+```javascript
+string_to_search = 'The rain in Spain falls mainly in the plains.';
+writeOutput( findOneOf('in', string_to_search) );
+```
+
+### Expected Result: 7
+
+## Find first instance starting from the twelfth character.
+
+Let's pass in a starting index of 12. The search will start at the twelfth character, just before the word 'Spain'.
+
+```javascript
+string_to_search = 'The rain in Spain falls mainly in the plains.';
+writeOutput( findOneOf('in', string_to_search, 12) );
+```
+
+### Expected Result: 16
+
+## Example showing this function will search all characters from the 'set' argument in the 'string' argument.
+
+This function is case-sensitive so 't' does NOT match the first 'T'. It's the same for 'H' NOT matching the first 'h'. But 'e' matches the 'e' at the third position.
+Since this is the first match, this is the index that is returned.
+
+```javascript
+string_to_search = 'The rain in Spain falls mainly in the plains.';
+writeOutput( findOneOf('tHe', string_to_search, 1) );
+```
+
+### Expected Result: 3
diff --git a/docs/functions/firstdayofmonth.md b/docs/functions/firstdayofmonth.md
new file mode 100644
index 000000000..6f6a14490
--- /dev/null
+++ b/docs/functions/firstdayofmonth.md
@@ -0,0 +1,35 @@
+# firstDayOfMonth
+
+Determines the ordinal (day number, in the year) of the first day of the month in which a given date falls.
+
+```javascript
+firstDayOfMonth(date)
+```
+
+```javascript
+returns numeric
+```
+
+## Member Function Syntax
+
+```javascript
+date.firstDayOfMonth()
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| date | date | Yes | | Date or date/time object. |
+
+## Simple example
+
+To determine the ordinal (day number, in the year).
+
+```javascript
+
--version - Version of BCrypt hash to generate ($2a,$2y or $2b). (Default is "$2a". The most current version is "$2b")
--rounds - Number of rounds to run the hash functions. (Default is 10.) | /Users/garethedwards/development/github/cfdocs/docs/functions/generatebcrypthash.md|rounds |
+
+## Example of BCrypt Hashing - No Options
+
+This is an example of using the function with no options.
+
+```javascript
+secretMsg=generateBCryptHash("My voice is my passport. Verify me.");writeDump(secretMsg)
+```
+
+### Expected Result: $2a$10$.jQX1KnwPzhvVet0vEENnOlO8C70oM8GQhu0MQnCgcIlWhguWb3q.
+
+## Example of BCrypt Hashing - With Version Option
+
+This is an example of using the function with optional version specified.
+
+```javascript
+secretMsg=generateBCryptHash("My voice is my passport. Verify me.",{"version":"$2b"});
+writeDump(secretMsg)
+```
+
+### Expected Result: $2b$10$wkfNE0B2hP/GMqQPWRvTte87F/PlEZwetaDPnVwW5OjBRAPiGKZp.
+
+## Example of BCrypt Hashing - With Rounds Option
+
+This is an example of using the function with optional rounds specified.
+
+```javascript
+secretMsg=generateBCryptHash("Setec Astronomy",{"rounds":15});writeDump(secretMsg)
+```
+
+### Expected Result: $2a$15$yBUewN8dYFd9QawytI5SO.MIq0hO65TXEoVyUAZRlK.oTHZ4Dwa0i
diff --git a/docs/functions/generategraphqlmodels.md b/docs/functions/generategraphqlmodels.md
new file mode 100644
index 000000000..4940a297f
--- /dev/null
+++ b/docs/functions/generategraphqlmodels.md
@@ -0,0 +1,24 @@
+# generateGraphQLModels
+
+This generates models for all queries, mutations, and subscriptions. Call this method every time if there is a change in the query or you've added a new query in the GraphQL file.
+
+```javascript
+generateGraphQLModels()
+```
+
+```javascript
+returns void
+```
+
+## Generate GraphQL models (Script syntax)
+
+Creates a GraphQL client with specified properties and calls generateGraphQLModels
+
+```javascript
+gqlClient = getGraphQLClient({
+ service_url: "https://apollo-fullstack-tutorial.herokuapp.com/graphql",
+ root_folder: "root",
+ headers: { keys: "key", values: "value" }
+});
+generateGraphQLModels();
+```
diff --git a/docs/functions/generatepbkdfkey.md b/docs/functions/generatepbkdfkey.md
new file mode 100644
index 000000000..e7d5eb33b
--- /dev/null
+++ b/docs/functions/generatepbkdfkey.md
@@ -0,0 +1,58 @@
+# generatePBKDFKey
+
+CFML implementation of Password-Based Key-Derivation Function (PBKDF)
+
+```javascript
+generatePBKDFKey(algorithm, passphrase, salt, iterations, keySize);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| algorithm | string | Yes | | Hashing algorithm used for generating key |
+| passphrase | string | Yes | | Passphrase used for the key. KEEP THIS SECRET. |
+| salt | string | Yes | | A string which will be added to the passphrase before encryption.
The standard recommends a salt length of at least 64 bits (8 characters). The salt needs to be generated using a pseudo-random number generator (e.g. SHA1PRNG) |
+| iterations | numeric | Yes | | The number of PBKDEF iterations to perform. A minimum recommended value is 1000 |
+| keySize | numeric | Yes | | The length in bits of the key to generate |
+
+## Example PBKDF2 With HMAC SHA1
+
+The `PBKDF2WithHmacSHA1` algorithm will work on older JVMs, or older versions of CF
+
+```javascript
+generatePBKDFKey("PBKDF2WithHmacSHA1", "secret", "salty", 5000, 128)
+```
+
+### Expected Result: Y0MCpCe3zb0CNJvyXNUWEQ==
+
+## More complex encryption example
+
+```javascript
+// some variables
+password = "top_secret";
+dataToEncrypt= "the most closely guarded secret";
+encryptionAlgorithm = "AES";
+keysize = 128;
+algorithmVersion = 512;
+PBKDFalgorithm = 'PBKDF2WithHmacSHA' & algorithmVersion;
+
+// Generate key as recommended in docs
+length = keysize / 8;
+multiplicator = 10 ^ length;
+salt = Round(Randomize(5,'SHA1PRNG') * multiplicator);
+
+// The magic happens here
+PBKDFKey = GeneratePBKDFKey(PBKDFalgorithm, password, salt, algorithmVersion, keysize);
+encryptedData = encrypt(dataToEncrypt, PBKDFKey, encryptionAlgorithm, "BASE64");
+decryptedData = decrypt(encryptedData, PBKDFKey, encryptionAlgorithm, "BASE64");
+
+//Output
+writeOutput("Generated PBKDFKey (Base 64): " & PBKDFKey);
+writeOutput("
Data After Encryption: " & encryptedData);
+writeOutput("
Data After Decryption: " & decryptedData);
+```
diff --git a/docs/functions/generatescrypthash.md b/docs/functions/generatescrypthash.md
new file mode 100644
index 000000000..54cef65db
--- /dev/null
+++ b/docs/functions/generatescrypthash.md
@@ -0,0 +1,41 @@
+# generateSCryptHash
+
+It is a salted password-hashing cryptographic function that takes an input and hashes it into a fixed size output.
+NOTE: This function is less secure than BCrypt.
+
+```javascript
+generateSCryptHash(plaintext,options);
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| plaintext | string | Yes | | The input string to hash. |
+| options | struct | No | {"memorycost":8,"CpuCost":16348,"Parallel":1,"KeyLength":32,"saltLength":8} | A struct containing the optional values:
- memorycost - Default is 8.
- CpuCost - CPU cost of the algorithm (as defined in scrypt, this is `N`) that must be a power of 2 and greater than 1. Default is currently 16,348 or 2^14.
- Parallel - the parallelization of the algorithm (as defined in scrypt, this is `P`). Default is currently 1.
- Keylength - key length for the algorithm (as defined in scrypt, this is `dkLen`). Default is currently 32.
- saltLength - length of the salt to use. Default is 8. |
+
+## Example of SCrypt Hashing - No Options
+
+This is an example of using the function with no options.
+
+```javascript
+secretMsg=generateSCryptHash("My voice is my passport. Verify me.");
+writeOutput(secretMsg)
+```
+
+### Expected Result: $e0801$BEJ9Ob8ZvoY=$LpQ79jMomeePrvBjcWRl3SrVf69962Ztn4WV/Sse4jg=
+
+## Example of SCrypt Hashing - With Options
+
+This is an example of using the function with options specified.
+
+```javascript
+secretMsg=generateBCryptHash("My voice is my passport. Verify me.",{"memorycost":4,"CpuCost":4096,"Parallel":1,"KeyLength":28,"saltLength":10});
+writeOutput(secretMsg)
+```
+
+### Expected Result: $c0401$6TTkF3GRLGrHAw==$NGPASIOKsgNLDOZPyTvn9rrSW3F+IkHLlPWevQ==
diff --git a/docs/functions/generatesecretkey.md b/docs/functions/generatesecretkey.md
new file mode 100644
index 000000000..48f62f516
--- /dev/null
+++ b/docs/functions/generatesecretkey.md
@@ -0,0 +1,31 @@
+# generateSecretKey
+
+Generates a secure random key value for use in the encrypt and decrypt functions.
+
+```javascript
+generateSecretKey([algorithm] [,keysize])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| algorithm | string | No | | The encryption algorithm used to generate the key.
NOTE: You cannot use `generateSecretKey()` to create a key for the `CFMX_COMPAT` default algorithm in `encrypt()` and `decrypt()` functions. | /Users/garethedwards/development/github/cfdocs/docs/functions/generatesecretkey.md|DESEDE |
+| keysize | numeric | No | 128 | Number of bits requested in the key for the specified algorithm (when allowed by JDK). | /Users/garethedwards/development/github/cfdocs/docs/functions/generatesecretkey.md|512 |
+
+## Generate an AES 128 bit Key
+
+Generate an AES key and use it to encrypt and decrypt a secret.
+
+```javascript
+ex={};
+ex.key = generateSecretKey("AES");
+ex.secret = "top secret";
+ex.encrypted=encrypt(ex.secret, ex.key, "AES", "Base64");
+ex.decrypted=decrypt(ex.encrypted, ex.key, "AES", "Base64");
+writeDump(ex);
+```
diff --git a/docs/functions/getapplicationmetadata.md b/docs/functions/getapplicationmetadata.md
new file mode 100644
index 000000000..7898c5280
--- /dev/null
+++ b/docs/functions/getapplicationmetadata.md
@@ -0,0 +1,29 @@
+# getApplicationMetadata
+
+Returns the application settings that you have specified in the application, either in the Application.cfc or Application.cfm. Contains application settings such as name, sessionManagement, or invokeImplicitAccessor.
+
+```javascript
+getApplicationMetadata()
+```
+
+```javascript
+returns struct
+```
+
+## Simple Example
+
+Prints the statements using application meta data.
+
+```javascript
+// Fetch application meta data
+data = getApplicationMetadata();
+
+// Print application name
+writeOutput("Application name is " & (data.name.length() ? data.name : "unspecified") & "
");
+
+// Print session timeout
+writeOutput("Session timeout is " & data.sessionTimeout & "
");
+
+// Print session management
+writeOutput("Session management is " & (data.sessionManagement ? "enabled" : "disabled"));
+```
diff --git a/docs/functions/getapplicationsettings.md b/docs/functions/getapplicationsettings.md
new file mode 100644
index 000000000..1d8c4bc0d
--- /dev/null
+++ b/docs/functions/getapplicationsettings.md
@@ -0,0 +1,17 @@
+# getApplicationSettings
+
+return all data from this scope, when using a application.cfc or all setting defined in tag cfapplication
+
+```javascript
+getApplicationSettings()
+```
+
+```javascript
+returns struct
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| suppressFunction | boolean | Yes | false | if true only data members from this scope are returned (no functions), default is false |
diff --git a/docs/functions/getauthuser.md b/docs/functions/getauthuser.md
new file mode 100644
index 000000000..980b557c3
--- /dev/null
+++ b/docs/functions/getauthuser.md
@@ -0,0 +1,11 @@
+# getAuthUser
+
+Gets the name of an authenticated user.
+
+```javascript
+getAuthUser()
+```
+
+```javascript
+returns string
+```
diff --git a/docs/functions/getbasetagdata.md b/docs/functions/getbasetagdata.md
new file mode 100644
index 000000000..8af606c0b
--- /dev/null
+++ b/docs/functions/getbasetagdata.md
@@ -0,0 +1,40 @@
+# getBaseTagData
+
+Used within a custom tag. Finds calling (ancestor) tag by name and accesses its data.
+
+```javascript
+getBaseTagData(tagname [, level])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| tagname | string | Yes | | Specify the parent tag name, starting with CF_. |
+| level | numeric | No | 1 | Specify the nth-level ancestor to retrieve variables from. |
+
+## Retrieve parent tag thisTag scope
+
+Use getBaseTagData() to retrieve the execution mode of the parent CF_MAPPER custom tag.
+
+```javascript
+
Free Hard Disk Space = #decimalFormat(freeDiskSpace / (1024 * 1024 * 1024))# GB
+```
diff --git a/docs/functions/getfunctioncalledname.md b/docs/functions/getfunctioncalledname.md
new file mode 100644
index 000000000..6330d2b07
--- /dev/null
+++ b/docs/functions/getfunctioncalledname.md
@@ -0,0 +1,80 @@
+# getFunctionCalledName
+
+ Returns the name of the variable used to call a defined function. This function can be used to return data from CFCs by simulating getters and setters.
+
+```javascript
+getFunctionCalledName()
+```
+
+```javascript
+returns string
+```
+
+## getFunctionCalledName Basic Example
+
+Show results of calling a function directly versus by reference
+
+```javascript
+void function actualFunctionName(){
+ writeOutput("actualFunctionName() was called as: #getFunctionCalledName()#
");
+}
+writeOutput("Calling actualFunctionName()
");
+actualFunctionName();
+writeOutput("Calling actualFunctionName() via reference
");
+referenceToFunction = actualFunctionName;
+referenceToFunction();
+```
+
+## Getters and Setters Example
+
+Example of using getFunctionCalledName to create dynamic getters and setters
+
+```javascript
+//callednamedemo.cfc
+component
+{
+ variables.x1 = 1;
+ variables.y1 = 2;
+
+ function init() {
+ return this;
+ }
+
+ function get() {
+ var name = getFunctionCalledName();
+ return variables[mid(name,4,len(name)-3)];
+ }
+
+ function set(value) {
+ var name = getFunctionCalledName();
+ variables[mid(name,4,len(name)-3)] = value;
+ }
+
+ this.getX1 = get;
+ this.getY1 = get;
+ this.setX1 = set;
+ this.setY1 = set;
+}
+
+
+
+
"); // test
+a = test;
+
+writeOutput(variables.a() & "
"); // a
+o = new callednamedemo();
+
+// shows *real* methods get(), SetX1() and getY1(), etc.
+writeDump(o);
+o.setX1(10);
+o.setY1(20);
+
+writeOutput(o.getX1() & "
"); // 10
+writeOutput(o.getY1() & "
") ; // 20
+
NOTE: This can only be done once.
If you expect the body to contain content which causes an exception in ColdFusion, set it to false as well and process it yourself. | /Users/garethedwards/development/github/cfdocs/docs/functions/gethttprequestdata.md|false |
+
+## GetHttpRequestData Example
+
+Returns HTTP request headers and request body in structure format.
+
+```javascript
+writeDump(GetHttpRequestData());
+```
diff --git a/docs/functions/gethttptimestring.md b/docs/functions/gethttptimestring.md
new file mode 100644
index 000000000..3046440a1
--- /dev/null
+++ b/docs/functions/gethttptimestring.md
@@ -0,0 +1,25 @@
+# getHTTPTimeString
+
+ Gets the current time, in the Universal Time code (UTC).
+
+```javascript
+getHTTPTimeString(DateTime)
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| DateTime | date | No | now() | |
+
+## Output UTC Date of 2017/8/8 14:12:10
+
+```javascript
+getHTTPTimeString("2017/8/8 14:12:10")
+```
+
+### Expected Result: Tue, 08 Aug 2017 14:12:10 GMT
diff --git a/docs/functions/getk2serverdoccount.md b/docs/functions/getk2serverdoccount.md
new file mode 100644
index 000000000..0e7cdb0c8
--- /dev/null
+++ b/docs/functions/getk2serverdoccount.md
@@ -0,0 +1,11 @@
+# getK2ServerDocCount
+
+Determines the number of documents that can be searched by the CFML registered K2 Server. This function is used primarily by the CFML Verity and K2Server Administrator pages, and requires significant processing time. Avoid using it in production applications. This function uses Verity K2Server Release K2.2.0.
+
+```javascript
+getK2ServerDocCount()
+```
+
+```javascript
+returns numeric
+```
diff --git a/docs/functions/getk2serverdoccountlimit.md b/docs/functions/getk2serverdoccountlimit.md
new file mode 100644
index 000000000..caf88d46e
--- /dev/null
+++ b/docs/functions/getk2serverdoccountlimit.md
@@ -0,0 +1,11 @@
+# getK2ServerDocCountLimit
+
+Gets the maximum number of documents that the CFML registered K2 Server is permitted to return from a search. This function is used primarily by the CFML Verity and K2Server Administrator pages. This function uses Verity K2Server Release K2.2.0.
+
+```javascript
+getK2ServerDocCountLimit()
+```
+
+```javascript
+returns numeric
+```
diff --git a/docs/functions/getlocale.md b/docs/functions/getlocale.md
new file mode 100644
index 000000000..13add13e2
--- /dev/null
+++ b/docs/functions/getlocale.md
@@ -0,0 +1,25 @@
+# getLocale
+
+ Gets the current geographic/language locale value.
+ To set the default display format of date, time, number, and
+ currency values in a CFML application session, you use
+ the SetLocale function.
+
+```javascript
+getLocale()
+```
+
+```javascript
+returns string
+```
+
+## Output current Locale than set it to swiss locale
+
+```javascript
+writeOutput(getlocale());
+writeOutput(' → ');
+setLocale('de_ch');
+writeOutput(getlocale());
+```
+
+### Expected Result: english (us) → german (swiss)
diff --git a/docs/functions/getlocalecountry.md b/docs/functions/getlocalecountry.md
new file mode 100644
index 000000000..014e3ef3e
--- /dev/null
+++ b/docs/functions/getlocalecountry.md
@@ -0,0 +1,20 @@
+# getLocaleCountry
+
+Gets the country where the locale belongs to.
+
+```javascript
+getLocaleCountry()
+```
+
+```javascript
+returns string
+```
+
+## Output current Locale's display name than set it to swiss locale
+
+```javascript
+writeOutput(getLocaleCountry());
+writeOutput(' → ');
+setLocale('de_ch');
+writeOutput(getLocaleCountry());
+```
diff --git a/docs/functions/getlocaledisplayname.md b/docs/functions/getlocaledisplayname.md
new file mode 100644
index 000000000..859494a36
--- /dev/null
+++ b/docs/functions/getlocaledisplayname.md
@@ -0,0 +1,29 @@
+# getLocaleDisplayName
+
+Gets a locale value and displays the name in a manner that is appropriate to a specific locale. By default, gets the current locale in the current locale's language.
+
+```javascript
+getLocaleDisplayName([locale, inLocale])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| locale | string | No | | The locale whose name you want. The default is the current ColdFusion locale, or if no ColdFusion locale has been set, the JVM locale. |
+| inLocale | string | No | | The locale in which to return the name. The default is the current ColdFusion locale, or if no ColdFusion locale has been set, the JVM locale. |
+
+## Output current Locale's display name than set it to swiss locale
+
+```javascript
+writeOutput(getLocaleDisplayName());
+writeOutput(' → ');
+setLocale('de_ch');
+writeOutput(getLocaleDisplayName());
+```
+
+### Expected Result: English (United States) → Deutsch (Schweiz)
diff --git a/docs/functions/getlocaleinfo.md b/docs/functions/getlocaleinfo.md
new file mode 100644
index 000000000..9559148c9
--- /dev/null
+++ b/docs/functions/getlocaleinfo.md
@@ -0,0 +1,44 @@
+# getLocaleInfo
+
+Returns a structure containing info to a specific locale. This function combines the locale functions `getLocaleCountry`, `getLocaleDisplayName`, and `getLocaleLanguage` to a single function.
+
+```javascript
+getLocaleInfo()
+```
+
+```javascript
+returns struct
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| locale | string | No | getLocale() | Geographic/language locale value, where the format is a combination of an ISO 639-1 code and an optional ISO 3166-1 code separated by a dash or an underscore. | /Users/garethedwards/development/github/cfdocs/docs/functions/getlocaleinfo.md|... |
+| dspLocale | string | No | getLocaleDisplayName() | Locale's display name/output language | /Users/garethedwards/development/github/cfdocs/docs/functions/getlocaleinfo.md|... |
+
+## Get information about the page's locale
+
+```javascript
+getLocaleInfo()
+```
+
+## Output page's locale in a divergent language
+
+Outputs the language locale of the page in German.
+
+```javascript
+getLocaleInfo(dspLocale='German').display.language
+```
+
+### Expected Result: Englisch
+
+## Output German locale in a page's language
+
+Outputs the German locale in the language defined for the page.
+
+```javascript
+getLocaleInfo(locale='de-DE', dspLocale=getLocaleDisplayName()).display.country
+```
+
+### Expected Result: Germany
diff --git a/docs/functions/getlocalelanguage.md b/docs/functions/getlocalelanguage.md
new file mode 100644
index 000000000..e9655d3f1
--- /dev/null
+++ b/docs/functions/getlocalelanguage.md
@@ -0,0 +1,20 @@
+# getLocaleLanguage
+
+Gets the language from where the locale belongs to.
+
+```javascript
+getLocaleLanguage()
+```
+
+```javascript
+returns string
+```
+
+## Output current Locale's display name than set it to swiss locale
+
+```javascript
+writeOutput(getLocaleLanguage());
+writeOutput(' → ');
+setLocale('de_ch');
+writeOutput(getLocaleLanguage());
+```
diff --git a/docs/functions/getlocalhostip.md b/docs/functions/getlocalhostip.md
new file mode 100644
index 000000000..ab4b02e72
--- /dev/null
+++ b/docs/functions/getlocalhostip.md
@@ -0,0 +1,19 @@
+# getLocalhostIP
+
+Returns the localhost IP address, which is 127.0.0.1 for IPv4 and ::1 for IPv6 addresses.
+
+```javascript
+getLocalhostIP()
+```
+
+```javascript
+returns string
+```
+
+## getLocalhostIP Example
+
+Here we've example to get localhost ip address using getLocalhostIP()
+
+```javascript
+writeOutput(getLocalhostIP());
+```
diff --git a/docs/functions/getluceeid.md b/docs/functions/getluceeid.md
new file mode 100644
index 000000000..7d3b86f3c
--- /dev/null
+++ b/docs/functions/getluceeid.md
@@ -0,0 +1,19 @@
+# getLuceeID
+
+Get ID, ApiKey and SecurityKey for the Server and the current Web-Context.
+
+```javascript
+getLuceeID()
+```
+
+```javascript
+returns struct
+```
+
+## Dump getLuceeID
+
+Display ID, ApiKey and SecurityKey for the Server and Web-Context.
+
+```javascript
+dump( getLuceeID() )
+```
diff --git a/docs/functions/getmemoryusage.md b/docs/functions/getmemoryusage.md
new file mode 100644
index 000000000..b159a77e6
--- /dev/null
+++ b/docs/functions/getmemoryusage.md
@@ -0,0 +1,23 @@
+# getMemoryUsage
+
+Return detailed information to the memory usage of the container.
+
+```javascript
+getMemoryUsage([type])
+```
+
+```javascript
+returns query
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| type | string | No | | Specify the type of memory information to return. If not specified, both types are returned. | /Users/garethedwards/development/github/cfdocs/docs/functions/getmemoryusage.md|non_heap |
+
+## Dump memory usage query
+
+```javascript
+writeDump(getMemoryUsage());
+```
diff --git a/docs/functions/getmetadata.md b/docs/functions/getmetadata.md
new file mode 100644
index 000000000..8dc1a1718
--- /dev/null
+++ b/docs/functions/getmetadata.md
@@ -0,0 +1,25 @@
+# getMetadata
+
+Gets metadata (the methods, properties, and parameters of a component) associated with an object that is deployed on the CFML server.
+
+```javascript
+getMetadata(value)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| value | any | Yes | | A ColdFusion component, user-defined function, or ColdFusion query. Within a CFC, the parameter can also specify the `this` scope. |
+
+## Dump Metadata of CFC Instance
+
+CF9+
+
+```javascript
+writeDump(getMetadata(new Query()));
+```
diff --git a/docs/functions/getmetricdata.md b/docs/functions/getmetricdata.md
new file mode 100644
index 000000000..b373b203f
--- /dev/null
+++ b/docs/functions/getmetricdata.md
@@ -0,0 +1,18 @@
+# getMetricData
+
+Gets server performance metrics
+ [mode - quickly]
+
+```javascript
+getMetricData(mode)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| mode | string | Yes | | perf_monitor - Returns internal data, in a structure.
simple_load - Returns an integer value that is computed
from the state of the server's internal
queues. Indicates the overall server load.
prev_req_time - Returns the time, in milliseconds, that it
took the server to process the previous
request.
avg_req_time - Returns the average time, in milliseconds,
that it takes the server to process a
request. | /Users/garethedwards/development/github/cfdocs/docs/functions/getmetricdata.md|avg_req_time |
diff --git a/docs/functions/getnumericdate.md b/docs/functions/getnumericdate.md
new file mode 100644
index 000000000..e9c1c590c
--- /dev/null
+++ b/docs/functions/getnumericdate.md
@@ -0,0 +1,27 @@
+# getNumericDate
+
+Returns a real number whose integer part represents the number of days since the EPOCH and whose fractional part represents the time value expressed in hours then divided by 24.
NOTE: Lucee (and ACF) uses 12/30/1899 00:00:00 as it's epoch time. See links below.
+
+```javascript
+getNumericDate(arg1)
+```
+
+```javascript
+returns numeric
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| arg1 | any | Yes | | A datetime object or a date-parsable String. |
+
+## Convert a date string to a numeric date - Tag Syntax
+
+This numeric date represents the number of days between December 30, 1899 and January 1, 2008.
+
+```javascript
+getNumericDate('2018-01-01')
+```
+
+### Expected Result: 43101
diff --git a/docs/functions/getpagecontext.md b/docs/functions/getpagecontext.md
new file mode 100644
index 000000000..39b9243f3
--- /dev/null
+++ b/docs/functions/getpagecontext.md
@@ -0,0 +1,11 @@
+# getPageContext
+
+ Gets the current java PageContext object that provides access to page attributes and configuration, request and response objects.
+
+```javascript
+getPageContext()
+```
+
+```javascript
+returns any
+```
diff --git a/docs/functions/getprinterinfo.md b/docs/functions/getprinterinfo.md
new file mode 100644
index 000000000..0440dfdf7
--- /dev/null
+++ b/docs/functions/getprinterinfo.md
@@ -0,0 +1,31 @@
+# getPrinterInfo
+
+Determines which print attributes are supported by a selected printer.
+
+```javascript
+getPrinterInfo([printer])
+```
+
+```javascript
+returns struct
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| printer | string | No | | Name of the printer |
+
+## Output printer info if exists
+
+```javascript
+try {
+ writeDump(getPrinterInfo());
+}
+catch (Application e) {
+ writeOutput(e.message & "
" & e.detail);
+}
+catch (any e) {
+ rethrow;
+}
+```
diff --git a/docs/functions/getprinterlist.md b/docs/functions/getprinterlist.md
new file mode 100644
index 000000000..7b5bb6472
--- /dev/null
+++ b/docs/functions/getprinterlist.md
@@ -0,0 +1,25 @@
+# getPrinterList
+
+Returns list of printers accessible by the ColdFusion server
+
+```javascript
+getPrinterList([delimiter])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| delimiter | string | No | | list separator |
+
+## Return comma separated printer list
+
+On a server with printers, this will display a result. If there are none, it will be an empty string.
+
+```javascript
+getPrinterList();
+```
diff --git a/docs/functions/getprofilesections.md b/docs/functions/getprofilesections.md
new file mode 100644
index 000000000..03efb3326
--- /dev/null
+++ b/docs/functions/getprofilesections.md
@@ -0,0 +1,21 @@
+# getProfileSections
+
+Gets all the sections of an initialization file.
+Returns a struct whose format is as follows:
+- Each initialization file section name is a key in the struct
+- Each list of entries in a section of an initialization file is a value in the struct
+
+```javascript
+getProfileSections(path [,encoding])
+```
+
+```javascript
+returns struct
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| path | string | Yes | | Absolute path of initialization file | |
+| encoding | string | No | | CF11+ Encoding of the initialization (ini) file | /Users/garethedwards/development/github/cfdocs/docs/functions/getprofilesections.md|utf-16 |
diff --git a/docs/functions/getprofilestring.md b/docs/functions/getprofilestring.md
new file mode 100644
index 000000000..3600e7bdd
--- /dev/null
+++ b/docs/functions/getprofilestring.md
@@ -0,0 +1,28 @@
+# getProfileString
+
+Gets an initialization file entry. An initialization file assigns values to configuration variables, also known as entries, that are set when the system
+ boots, the operating system comes up, or an application starts. Returns the entry - if no value, returns an empty string.
+
+```javascript
+getProfileString(inipath, section, entry)
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| inipath | string | Yes | | |
+| section | string | Yes | | |
+| entry | string | Yes | | |
+
+## Tag Syntax
+
+```javascript
+
if false (default), the header is returned as a Java object. |
diff --git a/docs/functions/getsoapresponse.md b/docs/functions/getsoapresponse.md
new file mode 100644
index 000000000..3137f51b3
--- /dev/null
+++ b/docs/functions/getsoapresponse.md
@@ -0,0 +1,29 @@
+# getSOAPResponse
+
+Returns an XML object that contains the entire SOAP response after invoking a web service.
+
+```javascript
+getSOAPResponse(webservice)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| webservice | any | Yes | | A webservice object as returned from the cfobject tag or the createObject function. |
+
+## Create a SOAP call and retrieve the response
+
+Create a SOAP webservice to call, then we can use getSOAPResponse() to view the full response
+
+```javascript
+soapURL = "https://graphical.weather.gov/xml/SOAP_server/ndfdXMLserver.php?wsdl";
+ws = createObject("webservice", soapURL);
+zipLatLong = ws.LatLonListZipCode("10001");
+res = getSOAPResponse(ws);
+writeDump(res);
+```
diff --git a/docs/functions/getsoapresponseheader.md b/docs/functions/getsoapresponseheader.md
new file mode 100644
index 000000000..0bdfd29d8
--- /dev/null
+++ b/docs/functions/getsoapresponseheader.md
@@ -0,0 +1,20 @@
+# getSOAPResponseHeader
+
+Returns a SOAP response header. Call this function from within code that is invoking a web service after making a web service request.
+
+```javascript
+getSOAPResponseHeader(webservice, namespace, name [, asXML])
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| webservice | any | Yes | | A webservice object as returned from the cfobject tag or the createObject function. |
+| namespace | string | Yes | | A String that is the namespace for the header. |
+| name | string | Yes | | A String that is the name of the SOAP header. |
+| asXML | boolean | No | NO | If True, the header is returned as a CFML XML object;
if false (default), the header is returned as a Java object. |
diff --git a/docs/functions/getsystemfreememory.md b/docs/functions/getsystemfreememory.md
new file mode 100644
index 000000000..c636cb05a
--- /dev/null
+++ b/docs/functions/getsystemfreememory.md
@@ -0,0 +1,17 @@
+# getSystemFreeMemory
+
+Gets details of free memory.
+
+```javascript
+getSystemFreeMemory();
+```
+
+```javascript
+returns numeric
+```
+
+## Get free memory in MB
+
+```javascript
+#NumberFormat(getSystemFreeMemory() / 1000 / 1000,"0.00")# MB
+```
diff --git a/docs/functions/getsystemtotalmemory.md b/docs/functions/getsystemtotalmemory.md
new file mode 100644
index 000000000..b083fd8e4
--- /dev/null
+++ b/docs/functions/getsystemtotalmemory.md
@@ -0,0 +1,23 @@
+# getSystemTotalMemory
+
+ Gets details of the memory that is available for the operating system, in bytes.
+
+```javascript
+getSystemTotalMemory();
+```
+
+```javascript
+returns numeric
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| region | string | No | | Indicates the cache region from which to remove the stored objects. If no value is specified, default cache region is considered by default. |
+
+## The in-memory file system memory set in cfadmin
+
+```javascript
+#NumberFormat(getSystemTotalMemory() / 1000 / 1000,"0.00")# MB
+```
diff --git a/docs/functions/gettagdata.md b/docs/functions/gettagdata.md
new file mode 100644
index 000000000..76bf7da82
--- /dev/null
+++ b/docs/functions/gettagdata.md
@@ -0,0 +1,27 @@
+# getTagData
+
+Return information to a Tag as Struct
+
+```javascript
+getTagData(nameSpaceWithSeperator, tagName)
+```
+
+```javascript
+returns struct
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| nameSpaceWithSeperator | string | Yes | | | |
+| tagName | string | Yes | | | |
+| dialect | string | No | current template's dialect | Define the dialect you want details for | /Users/garethedwards/development/github/cfdocs/docs/functions/gettagdata.md|Lucee |
+
+## Output information about a tag
+
+Returns a structure storing information about <cfmail>
+
+```javascript
+getTagData('cf','mail')
+```
diff --git a/docs/functions/gettaglist.md b/docs/functions/gettaglist.md
new file mode 100644
index 000000000..232e53ec9
--- /dev/null
+++ b/docs/functions/gettaglist.md
@@ -0,0 +1,20 @@
+# getTagList
+
+Gets a struct that contains a list CF language tags
+
+```javascript
+getTagList()
+```
+
+```javascript
+returns struct
+```
+
+## Simple example of getTagList function
+
+Uses the getTagList function to return a list of CF tags
+
+```javascript
+list = gettagList();
+writeDump(list);
+```
diff --git a/docs/functions/gettempdirectory.md b/docs/functions/gettempdirectory.md
new file mode 100644
index 000000000..d3348c0e9
--- /dev/null
+++ b/docs/functions/gettempdirectory.md
@@ -0,0 +1,23 @@
+# getTempDirectory
+
+Gets the path of the directory that CFML uses for
+ temporary files. Before using this function in an application,
+ test to determine the directory it returns under your account.
+ Returns the absolute pathname of a directory, including a
+ trailing slash.
+
+```javascript
+getTempDirectory()
+```
+
+```javascript
+returns string
+```
+
+## Show temp directory path
+
+File system path where temporary files are stored
+
+```javascript
+getTempDirectory()
+```
diff --git a/docs/functions/gettempfile.md b/docs/functions/gettempfile.md
new file mode 100644
index 000000000..a5a725e07
--- /dev/null
+++ b/docs/functions/gettempfile.md
@@ -0,0 +1,27 @@
+# getTempFile
+
+ Creates a temporary file in a directory whose name starts with
+ (at most) the first three characters of prefix.
+
+```javascript
+getTempFile(dir, prefix)
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| dir | string | Yes | | |
+| prefix | string | Yes | | |
+
+## Create temp file in temp dir
+
+Returns path of file created
+
+```javascript
+getTempFile(getTempDirectory(),"testFile")
+```
diff --git a/docs/functions/gettemplatepath.md b/docs/functions/gettemplatepath.md
new file mode 100644
index 000000000..7a76493cc
--- /dev/null
+++ b/docs/functions/gettemplatepath.md
@@ -0,0 +1,17 @@
+# getTemplatePath
+
+Returns the filepath of the base template in this request
+
+```javascript
+getTemplatePath()
+```
+
+```javascript
+returns string
+```
+
+## Show template path
+
+```javascript
+getTemplatePath()
+```
diff --git a/docs/functions/gettickcount.md b/docs/functions/gettickcount.md
new file mode 100644
index 000000000..6d5959c31
--- /dev/null
+++ b/docs/functions/gettickcount.md
@@ -0,0 +1,31 @@
+# getTickCount
+
+ Returns the current value of an internal millisecond timer.
+
+```javascript
+getTickCount()
+```
+
+```javascript
+returns numeric
+```
+
+## Script Syntax
+
+Outputs the current value of the internal millisecond timer
+
+```javascript
+writeOutput( getTickCount() )
+```
+
+## A simple timer
+
+Outputs the millisecond difference between a starting point and end point
+
+```javascript
+start = getTickCount();
+ sleep( 1000 );
+ writeOutput( getTickCount() - start );
+```
+
+### Expected Result: 1000 (note: may be off by a few ms depending on the environment)
diff --git a/docs/functions/gettimezone.md b/docs/functions/gettimezone.md
new file mode 100644
index 000000000..49e2263a0
--- /dev/null
+++ b/docs/functions/gettimezone.md
@@ -0,0 +1,22 @@
+# getTimeZone
+
+Returns the time zone for the current request.
+
+```javascript
+getTimeZone()
+```
+
+```javascript
+returns string
+```
+
+## What is the current time zone that's set?
+
+Set the time zone, then retrieve it.
+
+```javascript
+setTimeZone("Etc/UTC");
+writeOutput(getTimeZone().timezone);
+```
+
+### Expected Result: Etc/UTC
diff --git a/docs/functions/gettimezoneinfo.md b/docs/functions/gettimezoneinfo.md
new file mode 100644
index 000000000..b24fe019e
--- /dev/null
+++ b/docs/functions/gettimezoneinfo.md
@@ -0,0 +1,47 @@
+# getTimezoneInfo
+
+ Gets local time zone information for the computer on which it
+ is called, relative to Universal Time Coordinated (UTC). UTC is
+ the mean solar time of the meridian of Greenwich, England.
+
+```javascript
+getTimezoneInfo(text)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| timezone | string | Yes | | Lucee Specify a timezone to return info from |
+| locale | string | Yes | | Lucee Locale used to format the output |
+
+## Output timezone information
+
+This example shows the use of GetTimeZoneInfo
+
+```javascript
+
NOTE: The Enterprise Edition of ColdFusion installs the RSA BSafe Crypto-J library, which provides FIPS-140 Compliant Strong Cryptography. This includes additional algorithms. You can also install additional cryptography algorithms and use those hashing algorithms. |
+| encoding | string | No | UTF-8 | CF7+ A string specifying the encoding to use when converting the string to byte data used by the hash algorithm.
Must be a character encoding name recognized by the Java runtime.
NOTE: The default is specified by the value of `defaultCharset` in the `neo-runtime.xml` file, which is normally `UTF-8`.
NOTE: This is ignored when using the `CFMX_COMPAT` algorithm. |
+| additionalIterations | numeric | No | 0 | CF10+ Iterates the number of times the hash is computed to create a more computationally intensive hash. Lucee and Adobe CF implement this differently (off by one), see compatibility notes below.
NOTE: This parameter appears to be ignored if the `CFMX_COMPAT` default algorithm is used. |
+
+## SHA-256 Hash Example
+
+Returns 64 character hex result.
+
+```javascript
+hash("something", "SHA-256", "UTF-8")
+```
+
+### Expected Result: 3FC9B689459D738F8C88A3A48AA9E33542016B7A4052E001AAA536FCA74813CB
+
+## MD5 Hash Example
+
+MD5 is not recommended for use requiring security.
+
+```javascript
+hash("something")
+```
+
+### Expected Result: 437B930DB84B8079C2DD804A71936B5F
diff --git a/docs/functions/hash40.md b/docs/functions/hash40.md
new file mode 100644
index 000000000..bf7dbccfa
--- /dev/null
+++ b/docs/functions/hash40.md
@@ -0,0 +1,21 @@
+# hash40
+
+Converts a variable-length string to a 32-byte, hexadecimal string, using the MD5 algorithm.
+Note: It is not possible to convert the hash result back to the source string.
+
+```javascript
+hash40(input [, algorithm] [, encoding] [, numIterations])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| input | any | Yes | | String for hashing |
+| algorithm | string | No | | The algorithm to use to hash the string. Supported are the following algorithms:
- CFMX_COMPAT: generating a hash string using classic CFML algorithm.
- MD5: (default) Generates a 32-character, hexadecimal string, using the MD5 algorithm.
- SHA: Generates a 28-character string using the Secure Hash Standard SHA-1 algorithm specified by Nation Institute of Standards and Technology (NIST) FIPS-180-2.
- SHA-256: Generates a 44-character string using the SHA-256 algorithm specified by FIPS-180-2.
- SHA-384: Generates a 64-character string using the SHA-384 algorithm specified by FIPS-180-2.
- SHA-512: Generates an 88-character string using the SHA-1 algorithm specified by FIPS-180-2. |
+| encoding | string | No | | Encoding which will be used by the hash algorithm |
+| numIterations | numeric | No | 1 | number of iterations |
diff --git a/docs/functions/hmac.md b/docs/functions/hmac.md
new file mode 100644
index 000000000..1272e9585
--- /dev/null
+++ b/docs/functions/hmac.md
@@ -0,0 +1,28 @@
+# hmac
+
+Creates a keyed-hash message authentication code (HMAC), which can be used to verify authenticity and integrity of a message by two parties that share the key.
+
+```javascript
+hmac(message, key [, algorithm] [, encoding] )
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| message | any | Yes | | The message or data to authenticate. This can be a String or a byte array. | |
+| key | any | Yes | | The secret key. The key can be a String or byte array. | |
+| algorithm | string | No | HMACMD5 | An algorithm supported by the java crypto provider. | /Users/garethedwards/development/github/cfdocs/docs/functions/hmac.md|HMACSHA512 |
+| encoding | string | No | utf-8 | The character encoding to use when converting the message to bytes. Must be a character encoding name recognized by the Java runtime. | /Users/garethedwards/development/github/cfdocs/docs/functions/hmac.md|utf-16 |
+
+## Example HMAC Using HMACSHA256
+
+```javascript
+hmac("msg", "secret", "HMACSHA256")
+```
+
+### Expected Result: FE4F9C418F683F034F6AF90D1DD5B86AC0355DD96332C59CC74598D0736107F6
diff --git a/docs/functions/hour.md b/docs/functions/hour.md
new file mode 100644
index 000000000..91b48d46c
--- /dev/null
+++ b/docs/functions/hour.md
@@ -0,0 +1,40 @@
+# hour
+
+Extracts the hour of the day from a date/time object.
+ Ordinal value of the hour, in the range 0 - 23.
+
+```javascript
+hour(date)
+```
+
+```javascript
+returns numeric
+```
+
+## Member Function Syntax
+
+```javascript
+date.hour()
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| date | date | Yes | | Date/time object, in the range 100 AD-9999 AD.
NOTE: When passing a date/time value as a string, enclose it in quotation marks. Otherwise, it is interpreted as a number representation of a date/time object. |
+
+## Hour of a datetime object
+
+```javascript
+dt = createdatetime(2016,1,1,5,30,25);
+h = hour( dt );
+writeoutput( h );
+```
+
+### Expected Result: 5
+
+## Current Hour of the day
+
+```javascript
+hour( now() )
+```
diff --git a/docs/functions/htmlcodeformat.md b/docs/functions/htmlcodeformat.md
new file mode 100644
index 000000000..70101a533
--- /dev/null
+++ b/docs/functions/htmlcodeformat.md
@@ -0,0 +1,25 @@
+# htmlCodeFormat
+
+Replaces special characters in a string with their HTML-escaped equivalents and inserts <pre> and </pre> tags at the beginning and end of the string.
+The only difference between this function and `HTMLEditFormat` is that `HTMLEditFormat` doesn't surround the text in HTML `pre` tags.
+
+```javascript
+htmlCodeFormat(string [, version])
+```
+
+```javascript
+returns string
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| string | string | Yes | | A String or variable that contains one. | |
+| version | numeric | No | 2.0 | HTML version to use. Currently ignored.
-1: The latest implementation of HTML
2.0: HTML 2.0 (Default)
3.2: HTML 3.2 | /Users/garethedwards/development/github/cfdocs/docs/functions/htmlcodeformat.md|3.2 |
+
+## Tag Syntax
+
+```javascript
+
+ 
+```
+
+## Using clearRect member function
+
+CF11+ Lucee4.5+ Clears the specified rectangle (50x50) from the center of the image (x=50, y-50)
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+imgObj.clearRect(50,50,50,50);
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imagecopy.md b/docs/functions/imagecopy.md
new file mode 100644
index 000000000..202af3259
--- /dev/null
+++ b/docs/functions/imagecopy.md
@@ -0,0 +1,41 @@
+# imageCopy
+
+ Copies a rectangular area of an image.
+
+```javascript
+imageCopy(name, x, y, width, height [, dx] [, dy])
+```
+
+```javascript
+returns any
+```
+
+## Member Function Syntax
+
+```javascript
+someImage.copy(x, y, width, height [, dx] [, dy])
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| name | string | Yes | | The ColdFusion image on which this operation is performed. |
+| x | numeric | Yes | | The x coordinate of the source rectangle. |
+| y | numeric | Yes | | The y coordinate of the source rectangle. |
+| width | numeric | Yes | | The width of the source rectangle. |
+| height | numeric | Yes | | The height of the source rectangle. |
+| dx | numeric | No | | The x coordinate of the destination rectangle. |
+| dy | numeric | No | | The y coordinate of the destination rectangle. |
+
+## Using copy member function
+
+CF11+ Lucee4.5+ Copy the center of the image, rotate it 180 degrees about its center and paste it back into the original image
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+copiedImgObj = imgObj.copy(50,50,50,50);
+copiedImgObj.rotate(25,25,180,"bicubic");
+imgObj.paste(copiedImgObj,50,50);
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imagecreatecaptcha.md b/docs/functions/imagecreatecaptcha.md
new file mode 100644
index 000000000..578c16733
--- /dev/null
+++ b/docs/functions/imagecreatecaptcha.md
@@ -0,0 +1,34 @@
+# imageCreateCaptcha
+
+ Create a Completely Automated Public Turing test to tell Computers and Humans Apart (CAPTCHA) image, a distorted text image that is human-readable, but not machine-readable, used in a challenge-response test for preventing spam.
+
+```javascript
+imageCreateCaptcha (height, width, text [, difficulty, fonts, fontsize)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| height | numeric | Yes | | Height in pixels of the image. |
+| width | numeric | Yes | | Width in pixels of the image. |
+| text | string | Yes | | Text string displayed in the CAPTCHA image. Use capital letters for better readability. Do not include spaces because users cannot detect them in the resulting CAPTCHA image.. |
+| difficulty | string | No | | Level of complexity of the CAPTCHA text. Specify one of the following levels of text distortion: low, medium, and high |
+| font | string | No | | One or more valid fonts to use for the CAPTCHA text. Separate multiple fonts with commas. ColdFusion supports only the system fonts that the JDK can recognize. For example, TTF fonts in the Windows directory are supported on Windows. |
+| fontsize | numeric | No | | Font size of the text in the CAPTCHA image. The value must be an integer. |
+
+## Tag Syntax
+
+```javascript
+imageCreateCaptcha Method
+ 
+ 
+```
+
+## Using crop member function
+
+CF11+ Lucee4.5+ Crop the image from starting point (x=25, y=25), with width=100 and height=100
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+imgObj.crop(25,25,100,100);
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imagedrawarc.md b/docs/functions/imagedrawarc.md
new file mode 100644
index 000000000..a92840475
--- /dev/null
+++ b/docs/functions/imagedrawarc.md
@@ -0,0 +1,57 @@
+# imageDrawArc
+
+ Draws a circular or elliptical arc.
+
+```javascript
+imageDrawArc(name, x, y, width, height, startAngle, archAngle [, filled])
+```
+
+```javascript
+returns void
+```
+
+## Member Function Syntax
+
+```javascript
+someImage.drawArc(x, y, width, height, startAngle, archAngle [, filled])
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| name | string | Yes | | The image on which this operation is performed. | |
+| x | numeric | Yes | | The x coordinate of the upper-left corner of the arc. | |
+| y | numeric | Yes | | The y coordinate of the upper-left corner of the arc. | |
+| width | numeric | Yes | | The width of the arc. | |
+| height | numeric | Yes | | The height of the arc. | |
+| startAngle | numeric | Yes | | The beginning angle in degrees. | |
+| archAngle | numeric | Yes | | The angular extent of the arc, relative to the start angle. | |
+| filled | boolean | No | false | Specify whether the arc is filled | /Users/garethedwards/development/github/cfdocs/docs/functions/imagedrawarc.md|false |
+
+## Tag Syntax
+
+This example shows how to use the imageNew function to create a blank ColdFusion image that is 250 pixels wide and 180 pixels high.
+
+```javascript
+
font: The name of the font used to draw the text string. If you do not specify the font attribute, the text is drawn in the default system font.
size: The font size for the text string. The default value is 10 points.
style: The style to apply to the font ( bold,italic,boldItalic,plain (default) ).
strikethrough: a boolean that specify whether strikethrough is applied to the text image, default is false.
underline: a boolean that specify whether underline is applied to the text image, default is false. |
+
+## Tag Syntax
+
+This example shows how to create a text string image.
+
+```javascript
+
+
vertical: Flip an image across an imaginary horizontal line that runs through the center of the image.
horizontal: Flip an image across an imaginary vertical line that runs through the center of the image.
diagonal: Flip an image across its main diagonal that runs from the upper-left to the lower-right corner.
antidiagonal: Flip an image across its main diagonal that runs from the upper-right to the lower-left corner.
Or rotate an image clockwise by 90, 180, or 270 degrees. | /Users/garethedwards/development/github/cfdocs/docs/functions/imageflip.md|270 |
+
+## Tag Syntax
+
+This example shows how to rotate an image by 270 degrees.
+
+```javascript
+
+
Hexadecimal value of RGB color. For example, specify the color white as ##FFFFFF or FFFFFF.
String value of color (for example, 'black', 'red', 'green').
List of three numbers for (R,G,B) values. Each value must be in the range 0-255. |
+
+## Tag Syntax
+
+Use the imageNew function to create a 200x200-pixel image in ARGB format.
+
+```javascript
+
+```
diff --git a/docs/functions/imageoverlay.md b/docs/functions/imageoverlay.md
new file mode 100644
index 000000000..0386a396e
--- /dev/null
+++ b/docs/functions/imageoverlay.md
@@ -0,0 +1,54 @@
+# imageOverlay
+
+ Reads two source ColdFusion images and overlays the second source image on the first source image.
+
+```javascript
+imageOverlay(source1, source2 [, rule, alpha])
+```
+
+```javascript
+returns void
+```
+
+## Member Function Syntax
+
+```javascript
+someImage.overlay(source2 [, rule, alpha])
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| source1 | string | Yes | | The image that is the bottom layer in the image. |
+| source2 | string | Yes | | The image that is the top layer (overlaid on the source1 image) in the image. |
+| rule | string | No | | CF10+ Compositing Rule |
+| alpha | string | No | | CF10+ The percentage value of transparency |
+
+## Tag Syntax
+
+This example shows how to overlay a smaller image on a larger image.
+
+```javascript
+
+
+ 
+
+```
+
+## Using paste member function
+
+CF11+ Lucee4.5+ Copy the center of the image, rotate it 180 degrees about its center and paste it back into the original image
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+copiedImgObj = imgObj.copy(50,50,50,50);
+copiedImgObj.rotate(25,25,180,"bicubic");
+imgObj.paste(copiedImgObj,50,50);
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imageread.md b/docs/functions/imageread.md
new file mode 100644
index 000000000..28495a5e0
--- /dev/null
+++ b/docs/functions/imageread.md
@@ -0,0 +1,26 @@
+# imageRead
+
+ Reads the source pathname or URL and creates a ColdFusion image.
+
+```javascript
+imageRead(path)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| path | string | Yes | | On-disk or in-memory pathname or URL of the source image. |
+
+## Using script syntax
+
+Read an image from URL and output
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imagereadbase64.md b/docs/functions/imagereadbase64.md
new file mode 100644
index 000000000..d80b722eb
--- /dev/null
+++ b/docs/functions/imagereadbase64.md
@@ -0,0 +1,26 @@
+# imageReadBase64
+
+ Creates a ColdFusion image from a Base64 string.
+
+```javascript
+imageReadBase64(string)
+```
+
+```javascript
+returns any
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description |
+| --- | --- | --- | --- | --- |
+| string | string | Yes | | a variable or Base64 string |
+
+## Using script syntax
+
+convert base64 representation of a small red dot to an image
+
+```javascript
+imgObj = imageReadBase64('iVBORw0KGgoAAAANSUhEUgAAAAUAAAAFCAYAAACNbyblAAAAHElEQVQI12P4//8/w38GIAXDIBKE0DHxgljNBAAO9TXL0Y4OHwAAAABJRU5ErkJggg==');
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imageresize.md b/docs/functions/imageresize.md
new file mode 100644
index 000000000..f53ff1acd
--- /dev/null
+++ b/docs/functions/imageresize.md
@@ -0,0 +1,51 @@
+# imageResize
+
+ Resizes a ColdFusion image.
+
+```javascript
+imageResize(name, width, height, interpolation, blurfactor)
+```
+
+```javascript
+returns void
+```
+
+## Member Function Syntax
+
+```javascript
+someImage.resize(width, height, interpolation, blurfactor)
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| name | string | Yes | | The image on which this operation is performed. | |
+| width | numeric | Yes | | New width of the image. If this value is blank, the width is calculated proportionately to the height. | |
+| height | numeric | Yes | | New height of the image. If this value is blank, the height is calculated proportionately to the width. | |
+| interpolation | string | No | | The interpolation method for resampling. You can specify a specific interpolation algorithm by name (for example, hamming), by image quality (for example, mediumQuality), or by performance (for example, highestPerformance). | /Users/garethedwards/development/github/cfdocs/docs/functions/imageresize.md|quadratic |
+| blurfactor | boolean | No | | The blur factor used for resampling. The higher the blur factor, the more blurred the image (also, the longer it takes to resize the image). | /Users/garethedwards/development/github/cfdocs/docs/functions/imageresize.md|1-10 |
+
+## Tag Syntax
+
+This example shows how to resize an image to 50% of original size and resize it proportionately to the new width. Notice that the height is blank.
+
+```javascript
+
+
+```
+
+## Using resize member function
+
+CF11+ Resize an image
+
+```javascript
+imgObj = imageRead("http://cfdocs.org/apple-touch-icon.png");
+imgObj.resize(50,50);
+cfimage(action="writeToBrowser", source=imgObj);
+```
diff --git a/docs/functions/imagerotate.md b/docs/functions/imagerotate.md
new file mode 100644
index 000000000..1a5e413d9
--- /dev/null
+++ b/docs/functions/imagerotate.md
@@ -0,0 +1,47 @@
+# imageRotate
+
+Rotates a ColdFusion image at a specified point by a specified angle.
+
+```javascript
+imageRotate(name [, x] [, y] , angle [, interpolation])
+```
+
+```javascript
+returns void
+```
+
+## Member Function Syntax
+
+```javascript
+someImage.rotate([, x] [, y] , angle [, interpolation])
+```
+
+## Argument Reference
+
+| Name | Type | Required | Default | Description | Values |
+| --- | --- | --- | --- | --- | --- |
+| name | string | Yes | | The image on which this operation is performed. | |
+| angle | numeric | Yes | | The rotation angle in degrees. | |
+| x | numeric | No | 2 | The x coordinate for the point of rotation | |
+| y | numeric | No | 2 | The y coordinate for the point of rotation | |
+| interpolation | string | No | nearest | Type of interpolation
nearest: Applies the nearest neighbor method of interpolation. Image quality is lower than the other interpolation methods, but processing is fastest.
bilinear: Applies the bilinear method of interpolation. The quality of the image is less pixelated than the default, but processing is slower.
bicubic: Applies the bicubic method of interpolation. Generally, the quality of image is highest with this method and processing is slowest. | /Users/garethedwards/development/github/cfdocs/docs/functions/imagerotate.md|bicubic |
+
+## Tag Syntax
+
+This example shows how to rotate an image by 10 degrees.
+
+```javascript
+