Welcome!

You will be redirected in 30 seconds or close now.

ColdFusion Authors: Yakov Fain, Jeremy Geelan, Maureen O'Gara, Nancy Y. Nee, Tad Anderson

Related Topics: ColdFusion, Adobe Flex

ColdFusion: Article

Object-Oriented Form Validation in ColdFusion

Validating input with self-contained, reusable objects

For Web developers, form validation is a basic task, and yet one that presents some interesting challenges. Even discounting security issues such as SQL injection attacks and cross-site scripting (XSS), form validation is a critical step in your error handling strategy.

The two criteria I use to plan a form validation approach are extensibility and simplicity. Forms will change over time. It's like death and taxes, and much like those two events it's a lot better to plan for them before the fact, rather than after. When your form changes, how easy will it be to change your validation? When your business rules change, as they often do, how easy will it be to update your validation? How easy will it be for someone else to update your validation code if they were not a part of the original development effort? Fortunately, an object-oriented approach handles all of these questions.

Data validation is really two different activities. First, you need to validate the data. Is a date of birth really a date? Does that credit card number follow the Mod10 algorithm? Second, you need to determine how the data fits into your business rules. Suppose a date of birth of 03/06/1902 was passed in. It's certainly a valid date, but if the point of your application is to sell life insurance policies, then that date will likely not pass your business rules.

Basic data validation and validation of business rules are two different activities, and yet they are so often handled as one. For example, how often have you seen something like this:

<cfif not Isdate(form.dob)>
    <cfset errormsg = "Please enter a valid date of birth">
<cfelse>
    <cfif Year(form.date) GT 1950>
       <cfset errormsg = "Applicant is not eligible for this insurance policy">
    </cfif>
</cfif>

Except for the gross oversimplification of age checking, done for example purposes, this approach is workable, but can be bulky when applied to a large form. Worse, as the business logic is embedded in the datatype validation, the code for the business rule validation must be re-written in order to be used elsewhere.

Thankfully, there's a better way to handle this. To examine a more flexible, reusable approach, let's consider a very simple form. We're going to collect first and last name, date of birth, and country of citizenship, and then we'll validate the input both for correct datatype and business rules.

Validation Bean
Before we start checking for errors, we need some method of collecting errors and error messages. It is so annoying when a Web application tells you that your input was incorrect in some way, but will not tell you what exactly was incorrect or why. Finding errors is only half of the solution; reporting them to the user is the other half. To that end, I use a ValidationBean object (see Listing 1). Using an object to hold validation information creates a standard interface for validation tasks.

The ValidationBean has two properties: Result and Message. Result is a simple Boolean, indicating whether or not the form data passed validation. The Message property is an array of error messages. Along with the necessary getters and setters for these properties, the ValidationBean also has an appendMessage() method, which adds another error message to the Message array, and a Reset() method, which simply clears the error messages and sets the Result to True. I use this method during validation to clear out any results from previous form submissions.

Datatype Validation
The ValidationBean is extremely generic, so at this point you're probably wondering where and how the datatype validation takes place. I put datatype validation within the bean(s) that hold form data. The idea behind this is that the bean should be somewhat self-aware. A bean doesn't need to know how its data is going to be used, but it should have some idea of what its data is and the format for that data.

As you look at the code for formBean.cfc (see Listing 2), a couple of things may stick out. First of all, the setters have an argument with a type of "any" and the getters have a returntype of "any".

Second, all arguments are optional and have a default value, which means that all variables-scoped variables are assured to be assigned a value. This may require some additional explanation, because it may seem better to set the argument types and the returntypes to the datatype that is expected. I find this approach limiting, however. The form bean is a representation of the form data as it was entered. If an incorrect type of data is entered, or if a form control is left blank, I don't want the bean throwing an error. I prefer to find and deal with the problem programmatically.

To handle validation, I include a Validate() method. I pass in a Validation Bean as an argument, and since ColdFusion passes CFCs by reference, it is not necessary for me to return anything from this method. The method can inspect each attribute in the bean and return an error message customized to the form control in question.

At this point what we have is an object that holds the data passed in through a form. This object has an interface for returning data, and the ability to inspect the data it holds to make sure that it is of the expected type. However, it doesn't know how this data is to be used. This is useful if you want to use this form data in several different applications. Consider the example above. Name, address, date of birth and the like are common pieces of information to pass through a form. Using a form bean to hold and validate data commonly passed in through a form, you don't have to duplicate work on other applications that use this same data. Validation rules are consistent from application to application, and you have the advantage of using an object whose behavior is well tested and well known.

More Stories By Matt Osbun

Matt Osbun is a Certified ColdFusion developer for Herff Jones, Inc., located in Indianapolis, IN. He has been working as a Web developer for 7 years, specializing in ColdFusion, XML, and AJAX. Matt can be contacted at [email protected] or through his blog at http://www.pteradactylcry.com.

Comments (1)

Share your thoughts on this story.

Add your comment
You must be signed in to add a comment. Sign-in | Register

In accordance with our Comment Policy, we encourage comments that are on topic, relevant and to-the-point. We will remove comments that include profanity, personal attacks, racial slurs, threats of violence, or other inappropriate material that violates our Terms and Conditions, and will block users who make repeated violations. We ask all readers to expect diversity of opinion and to treat one another with dignity and respect.


IoT & Smart Cities Stories
Every organization is facing their own Digital Transformation as they attempt to stay ahead of the competition, or worse, just keep up. Each new opportunity, whether embracing machine learning, IoT, or a cloud migration, seems to bring new development, deployment, and management models. The results are more diverse and federated computing models than any time in our history.
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
At CloudEXPO Silicon Valley, June 24-26, 2019, Digital Transformation (DX) is a major focus with expanded DevOpsSUMMIT and FinTechEXPO programs within the DXWorldEXPO agenda. Successful transformation requires a laser focus on being data-driven and on using all the tools available that enable transformation if they plan to survive over the long term. A total of 88% of Fortune 500 companies from a generation ago are now out of business. Only 12% still survive. Similar percentages are found throug...
Dion Hinchcliffe is an internationally recognized digital expert, bestselling book author, frequent keynote speaker, analyst, futurist, and transformation expert based in Washington, DC. He is currently Chief Strategy Officer at the industry-leading digital strategy and online community solutions firm, 7Summits.
Digital Transformation is much more than a buzzword. The radical shift to digital mechanisms for almost every process is evident across all industries and verticals. This is often especially true in financial services, where the legacy environment is many times unable to keep up with the rapidly shifting demands of the consumer. The constant pressure to provide complete, omnichannel delivery of customer-facing solutions to meet both regulatory and customer demands is putting enormous pressure on...
IoT is rapidly becoming mainstream as more and more investments are made into the platforms and technology. As this movement continues to expand and gain momentum it creates a massive wall of noise that can be difficult to sift through. Unfortunately, this inevitably makes IoT less approachable for people to get started with and can hamper efforts to integrate this key technology into your own portfolio. There are so many connected products already in place today with many hundreds more on the h...
The standardization of container runtimes and images has sparked the creation of an almost overwhelming number of new open source projects that build on and otherwise work with these specifications. Of course, there's Kubernetes, which orchestrates and manages collections of containers. It was one of the first and best-known examples of projects that make containers truly useful for production use. However, more recently, the container ecosystem has truly exploded. A service mesh like Istio addr...
Digital Transformation: Preparing Cloud & IoT Security for the Age of Artificial Intelligence. As automation and artificial intelligence (AI) power solution development and delivery, many businesses need to build backend cloud capabilities. Well-poised organizations, marketing smart devices with AI and BlockChain capabilities prepare to refine compliance and regulatory capabilities in 2018. Volumes of health, financial, technical and privacy data, along with tightening compliance requirements by...
Charles Araujo is an industry analyst, internationally recognized authority on the Digital Enterprise and author of The Quantum Age of IT: Why Everything You Know About IT is About to Change. As Principal Analyst with Intellyx, he writes, speaks and advises organizations on how to navigate through this time of disruption. He is also the founder of The Institute for Digital Transformation and a sought after keynote speaker. He has been a regular contributor to both InformationWeek and CIO Insight...
Andrew Keys is Co-Founder of ConsenSys Enterprise. He comes to ConsenSys Enterprise with capital markets, technology and entrepreneurial experience. Previously, he worked for UBS investment bank in equities analysis. Later, he was responsible for the creation and distribution of life settlement products to hedge funds and investment banks. After, he co-founded a revenue cycle management company where he learned about Bitcoin and eventually Ethereal. Andrew's role at ConsenSys Enterprise is a mul...