Return to v2.1 docs

toggle()


Model Object CRUD Functions boolean model


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.

Name Type Required Default Description
property string Yes
save boolean No true Argument to decide whether save the property after it has been toggled.
// 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();

Related Functions

CRUD Functions