CFLib.org – Common Function Library Project

Description:
Save yourself a couple lines of coding next time you need to toggle the value of a variable.

Return Values:
Returns a string.

Example:

<cfset action = "On">
<cfset newValue = toggleValue(action,"On","Off")>
<cfoutput>Action = #action#, toggle is #toggleValue(action,"On","Off")#</cfoutput>

Parameters:

Full UDF Source:

<cfscript>
/**
 * Toggles a value (ie: &quot;stop&quot;/&quot;start&quot;) between two options.
 * 
 * @param variable 	 The variable that stores the value you will toggle. (Required)
 * @param value1 	 The first value of the toggle. (Required)
 * @param value2 	 The second value of the toggle. (Required)
 * @return Returns a string. 
 * @author Nathan Dintenfass (&#110;&#97;&#116;&#104;&#97;&#110;&#64;&#99;&#104;&#97;&#110;&#103;&#101;&#109;&#101;&#100;&#105;&#97;&#46;&#99;&#111;&#109;) 
 * @version 1, July 3, 2002 
 */
function toggleValue(variable,value1,value2){
	//make a struct in which the value is the opposite of the key
	var toggler = structNew();
	toggler[value1] = value2;
	toggler[value2] = value1;
	//return whichever value is not the current value
	return toggler[variable];
}
</cfscript>