propertyNames()

Signature

propertyNames() — returns string

Available in: model Category: Miscellaneous Functions

Description

Returns a list of property names ordered by their respective column’s ordinal position in the database table. Also includes calculated property names that will be generated by the Wheels ORM.

Examples

// 1. Get a comma-delimited list of all property names for the User model
propNames = model("User").propertyNames();
// propNames -> "id,firstName,lastName,email,createdAt,updatedAt"

// 2. Check whether a specific property exists on the model before accessing it
propNames = model("User").propertyNames();
if (listFindNoCase(propNames, "email")) {
    writeOutput("email is a valid property");
}

// 3. Property names include calculated properties defined with property(sql="...")
// In User.cfc config():
//   property(name="fullName", sql="firstName || ' ' || lastName");
propNames = model("User").propertyNames();
// propNames -> "id,firstName,lastName,email,createdAt,updatedAt,fullName"