`toggle()`

Description

Assigns to the property specified the opposite of the property's current boolean value. Throws an error if the property cannot be converted to a boolean value. Returns this object if save called internally is false.

Function Syntax

toggle([ save ])

Parameters

Parameter	Type	Required	Default	Description
`save`	`boolean`	No	`true`	Argument to decide whether save the property after it has been toggled. Defaults to true.

Examples

<!--- Get an object, and toggle a boolean property --->
<cfset user = model("user").findByKey(58)>
<cfset isSuccess = user.toggle("isActive")><!--- returns whether the object was saved properly --->
<!--- You can also use a dynamic helper for this --->
<cfset isSuccess = user.toggleIsActive()>