CFLib.org – Common Function Library Project

arrayCompact(arr[, delim])

Last updated March 02, 2007

author

M Gillespie for HOUCFUG

Version: 1 | Requires: CF6 | Library: DataManipulationLib

Description:
This function is designed to remove undefined postions from an array. Will not work in CF5, and would not recommend using it for large arrays. Optional argument to pass in delimiter (default is Pipe symbol).

Return Values:
Returns an array.

Example:

<!--- create the array --->
<cfset tmp=arraynew(1)>
<cfset tmp[1]="a">
<cfset tmp[3]="c">
<cfset tmp[4]="d">
<!--- let's see it in all it's un-glory --->
<cfdump var="#tmp#" label="original array">
<!--- compacting - grindgrindgrind --->
<cfset newTmp=arrayCompact(tmp)>
<!--- show me --->
<cfdump var="#Newtmp#" label="New Compacted array">
<!--- now, the pudding --->
<cfoutput>
Looping new Array<br />
<cfloop from="1" to="#arraylen(newTmp)#" index="i">
index #i# = #newTmp[i]#<br />
</cfloop>
</cfoutput>

Parameters:

Name Description Required
arr Array to compact. Yes
delim Temporary list delimiter. Defaults to |. No

Full UDF Source:

/**
 * Used to remove missing positions from an array.
 * 
 * @param arr      Array to compact. (Required)
 * @param delim      Temporary list delimiter. Defaults to |. (Optional)
 * @return Returns an array. 
 * @author M Gillespie for HOUCFUG (houcfug@yahoogroups.com) 
 * @version 1, March 2, 2007 
 */
function arrayCompact(arr) {
    var delim="|";
    if(arraylen(arguments) gt 1) {delim=arguments[2];}
    return listtoarray(arraytolist(arr,delim),delim);
}

Search CFLib.org


Latest Additions

Raymond Camden added
QueryDeleteRows
November 04, 2017

Leigh added
nullPad
May 11, 2016

Raymond Camden added
stripHTML
May 10, 2016

Kevin Cotton added
date2ExcelDate
May 05, 2016

Raymond Camden added
CapFirst
April 25, 2016

Created by Raymond Camden / Design by Justin Johnson