CFLib.org – arrayDeleteArray

arrayDeleteArray(baseArray, deleteArray)

Last updated April 11, 2008

Download UDF

author

Jason Rushton
Send Email

Version: 1 | Requires: ColdFusion MX | Library: DataManipulationLib

Rated 0 time(s). Average Rating: 0

Description:
Remove elements from one array which exist in another array. Uses Java's array.removeAll(str)

Return Values:
Returns an array.

Example:

view plain print about

<cfset myArray = ListToArray( "Charlie,Jack,Kate,Libby,Sawyer" )>
<cfset deleteArray = ListToArray( "Charlie,Libby" )>
<cfset myArray = arrayDeleteArray( myArray, deleteArray )>

Parameters:

Name	Description	Required
baseArray	Main array of values.	Yes
deleteArray	Array of values to delete.	Yes

Full UDF Source:

	
	
			
			
			
				
				view plain
				
				
				copy to clipboard
				
				
				
				
				print
				
				
				about
				ColdFISH is developed by Jason Delmore.  Source code and license information available at coldfish.riaforge.org.  Version 3.1.1
				
			<cfscript>
/**
 * Remove elements from one array which exist in another array.
 * 
 * @param baseArray 	 Main array of values. (Required)
 * @param deleteArray 	 Array of values to delete. (Required)
 * @return Returns an array. 
 * @author Jason Rushton (&#106;&#97;&#115;&#111;&#110;&#64;&#105;&#119;&#111;&#114;&#107;&#115;&#46;&#99;&#111;&#109;) 
 * @version 1, April 11, 2008 
 */
function arrayDeleteArray( baseArray, deleteArray ) {
	arguments.baseArray.removeAll(arguments.deleteArray);
	return arguments.baseArray;
}
</cfscript>
		<cfscript>
/**
 * Remove elements from one array which exist in another array.
 * 
 * @param baseArray      Main array of values. (Required)
 * @param deleteArray      Array of values to delete. (Required)
 * @return Returns an array. 
 * @author Jason Rushton (jason@iworks.com) 
 * @version 1, April 11, 2008 
 */
function arrayDeleteArray( baseArray, deleteArray ) {
    arguments.baseArray.removeAll(arguments.deleteArray);
    return arguments.baseArray;
}
</cfscript>