Model Object
toggle()
Signature
Section titled “Signature”toggle() — returns boolean
Available in: model
Category: CRUD Functions
Description
Section titled “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.
Parameters
Section titled “Parameters”| Name | Type | Required | Default | Description |
|---|---|---|---|---|
property | string | yes | — | |
save | boolean | no | true | Argument to decide whether save the property after it has been toggled. |
Examples
Section titled “Examples”// Get an object, and toggle a boolean property
user = model("user").findByKey(58);
isSuccess = user.toggle("isActive"); // returns whether the object was saved properly
// You can also use a dynamic helper for this
isSuccess = user.toggleIsActive();