changedProperties()

Signature

changedProperties() — returns string

Available in: model Category: Change Functions

Description

Returns a list of the object properties that have been changed but not yet saved to the database.

Examples

// 1. Find a member, change some properties, then inspect which ones have changed
member = model("member").findByKey(params.memberId);
member.firstName = params.newFirstName;
member.email = params.newEmail;
changed = member.changedProperties();
// changed -> "firstName,email"

// 2. Only save when there are actually unsaved changes
user = model("User").findByKey(params.userId);
user.lastName = params.lastName;
if (Len(user.changedProperties())) {
    user.save();
}

// 3. Use changedProperties() alongside changedFrom() to build an audit log entry
post = model("Post").findByKey(params.postId);
post.title = params.title;
post.body = params.body;
changedList = post.changedProperties();
for (prop in ListToArray(changedList)) {
    writeOutput("Property '#prop#' was '#post.changedFrom(prop)#', now '#post[prop]#'.");
}