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

ColdFusion: Article

component.cfc: The Mother of All Components

component.cfc: The Mother of All Components

Yes, that's right, components have mommies and daddies. Well, not really, but that statement isn't too far from the truth. This article explains "component.cfc", a hidden gem in the ColdFusion Component architecture that is part of ColdFusion MX.

By now, everybody knows that the introduction of the component framework in ColdFusion MX was one of the most radical changes to CFML since its inception. Their introduction was significant for three primary reasons. First, they allow developers to expose functionality to the Flash Gateway and to any other Web service-enabled environment. Second, they offer a level of abstraction far superior to that of custom tags and user-defined functions. The third reason CFCs have made such an impact on CFML is that they offer ColdFusion developers the ability to implement object-oriented features.

These object-oriented features include new variable scopes with varying degrees of exposure outside the component; the "packaging" of functionality, introspection, and the generation of meta data; objectinstance- based programming; and inheritance. In traditional object-oriented programming languages, all objects inherit from a parent "Object" class. What many developers don't realize is that components, too, have a parent "class". Its name is "component.cfc" and it can be a very valuable tool when developing applications.

Where Can I Find component.cfc?
If you create a CFC that does not inherit from any other CFC and you view its meta data, you'll notice that the value for the "hierarchy" meta information defaults to "WEB-INF.cftags.component". You will find this file in the "CfusionMXWWWRootWEBINFcftags" directory if you're running the standalone version of ColdFusion, and in "JRun4servers{your_server_name}cfusion-earcfusion-warWEBINF cftags" if you're running the J2EE version (on top of JRun4). You can view the meta data for component.cfc on a server by browsing http://{server_domain}/CFIDE/componentutils/cfcexplorer.cfc?method=getcf cinhtml&name=WEB-INF.cftags.component, replacing "{server_domain}" with "localhost:8500" or whatever other URL you use to browse to that machine.

What Does component.cfc Do?
Well, nothing really. Not out of the box, anyway. The component.cfc file is empty by default in ColdFusion MX 6.1. In ColdFusion MX it had a tiny bit of encrypted data at the top of the file. As already discussed, all components inherit from component. cfc by default. Think of it as the Application.cfm of components - a place to put code that is implicitly included. The difference is that the code outside of any method in component.cfc is executed only when a ColdFusion Component is first initialized, and that its methods and meta data are inherited by other components. It gives you a single place to put code that must be common to all CFCs on your server.

Why Would I Want to Do That?
Having one place to put functionality and initialization code that will be available to all server components has two important uses. As already mentioned, you can think of it as similar to Application.cfm, which means that if you're running a server that's dedicated to hosting one application and the application is using CFCs for its business logic (as every application should be), it's a very good place to put functionality that all components need to have.

For example, if your server is hosting your company's public Web site, all of your components might need to have access to the current company catalog of products. Creating a method in component.cfc that retrieves the current catalog information from a database and returns it to the caller would ensure that all components have the ability to retrieve the catalog by calling that method. While this is a neat trick, it's not always terribly useful or desirable, especially when your application is running on a server that hosts other completely separate ColdFusion applications.

There's another use for component.cfc though - when wielded properly, it can be a powerful development tool. More than anything else, I like to put debugging methods in my component.cfc file so that they are available in any application I happen to be working on. Extending the component framework with development tools can make a developer's life a little bit easier, as we will soon see.

Coding with component.cfc
It's a little known fact that ColdFusion Components don't technically require a start and end <cfcomponent> tag… they will work without them. That said, without the <cfcomponent> tag, a CFC will not properly inherit from the base component. cfc file nor will it allow the use of <cfproperty> tags if you are defining meta information, so as a best practice, follow the standard recommended practices when creating components.

By default, component.cfc is an empty file. Because it does not inherit from any other component (after all, it is the mother of all components), you can code methods in the file without adding any <cfcomponent> tags. You can optionally add <cfcomponent> tags to component.cfc in order to generate meta data about the component or to enable the use of <cfproperty> tags before your methods. Like inheritence with other CFCs, any meta information, methods, and variables in the component are inherited by all other components on the server.

As you may have guessed, creating a method in one component with the same name as a method in component.cfc will override the method. The original method defined in component.cfc can be accessed with the "super" keyword as "super.methodName()", provided that the component you are in does not inherit from any other component. Let's examine one very practical use for this master component file.

Component.cfc Uses
If you're anything like me, you use <cfscript> a lot. As wonderful as <cfscript> is, it is not without limitations. In particular, the use of tags is strictly forbidden within a <cfscript> block. It is often necessary during the development process to view data in order to determine what's happening in your code. The <cfdump> tag is perfect for this, but wait - you cannot <cfdump> within a <cfscript> block. What to do?

Developers like me who use <cfscript> often, have made it a standard practice to create a function using <cffunction> that accepts a single argument of any data type, <cfdump> that variable, then <cfabort> the page. That function can then be called from <cfscript>, thus giving developers the ability to "see what's happening" within their <cfscript> code.

Here's the code I wrote inside of my component.cfc file so that I can dump a value from any ColdFusion Component <cfscript> block:

<cfcomponent displayname="Root" hint="Root CFC">
<!---:: function to dump then abort ::--->
<cffunction name="dumpIt" output="true" displayname="Dump It" hint="A
debugging tool" access="private" returntype="void">
<cfargument name="it" displayname="It" hint="The Thing To Dump"
required="true" type="any">
<cfdump var="#arguments.it#">
<cfabort>
</cffunction>
</cfcomponent>

You'll notice that the method is private because I do not need nor want to expose it to cfm pages that are instantiating my components. It also means that the method does not display along with the other methods of a component that's inherited it when that component's meta data is browsed.

The "dumpIt()" method is useful for developers who do not use <cfscript> as well. It is generally considered a best practice to encapsulate business logic with components. This means passing a value to a component method, operating on that value, and returning a value to the caller page or application. With this in mind, it's a safe assumption that the components in your application(s) aren't directly outputting anything to the HTTP output stream.

Pretty much every component I create not only uses <cfscript> heavily, but never outputs anything. To make sure nothing is output, I always set my <cffunction> tag "output" attributes to "false". This is definitely a best practice in most scenarios, but not being able to output directly from a component method also means you cannot <cfdump> the value of variables within the component when you're debugging your application. Once again, the "dumpIt()" method is a very handy tool, as from within a "silent" component, you can pass the suspicious variable to this method (which has the "output" attribute set to "true") in order to see what's going on in your code.

Where Do We Go from Here?
Component.cfc is a very practical debugging tool for developers and can also be a powerful part of your applications as well. We have looked at just one way that it can be used as an effective development tool. You could create variations of the "dumpIt()" function so that you have one method to dump and abort and another to dump and allow processing to continue. It wouldn't be difficult to add methods to your component.cfc that allow you to do other useful things such as time blocks of code using the getTickCount() function, for example.

Be forewarned that there are two major drawbacks to placing code, especially application rather than debugging/development code, in component.cfc. One is that from an architectural point of view, you are physically separating your code from the rest of your application business logic. The other is that you are making your code less portable - it's no longer a simple matter of copying a directory structure from one server to another in order to move your application when some of the logic is housed in component. cfc. Other than that, have fun and take advantage of it! The sky's the limit.

More Stories By Simon Horwith

Simon Horwith is the CIO at AboutWeb, LLC, a Washington, DC based company specializing in staff augmentation, consulting, and training. Simon is a Macromedia Certified Master Instructor and is a member of Team Macromedia. He has been using ColdFusion since version 1.5 and specializes in ColdFusion application architecture, including architecting applications that integrate with Java, Flash, Flex, and a myriad of other technologies. In addition to presenting at CFUGs and conferences around the world, he has also been a contributing author of several books and technical papers.

Comments (0)

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.


@ThingsExpo Stories
Just over a week ago I received a long and loud sustained applause for a presentation I delivered at this year’s Cloud Expo in Santa Clara. I was extremely pleased with the turnout and had some very good conversations with many of the attendees. Over the next few days I had many more meaningful conversations and was not only happy with the results but also learned a few new things. Here is everything I learned in those three days distilled into three short points.
In this strange new world where more and more power is drawn from business technology, companies are effectively straddling two paths on the road to innovation and transformation into digital enterprises. The first path is the heritage trail – with “legacy” technology forming the background. Here, extant technologies are transformed by core IT teams to provide more API-driven approaches. Legacy systems can restrict companies that are transitioning into digital enterprises. To truly become a lea...
Why do your mobile transformations need to happen today? Mobile is the strategy that enterprise transformation centers on to drive customer engagement. In his general session at @ThingsExpo, Roger Woods, Director, Mobile Product & Strategy – Adobe Marketing Cloud, covered key IoT and mobile trends that are forcing mobile transformation, key components of a solid mobile strategy and explored how brands are effectively driving mobile change throughout the enterprise.
SYS-CON Events announced today that Roundee / LinearHub will exhibit at the WebRTC Summit at @ThingsExpo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. LinearHub provides Roundee Service, a smart platform for enterprise video conferencing with enhanced features such as automatic recording and transcription service. Slack users can integrate Roundee to their team via Slack’s App Directory, and '/roundee' command lets your video conference ...
24Notion is full-service global creative digital marketing, technology and lifestyle agency that combines strategic ideas with customized tactical execution. With a broad understand of the art of traditional marketing, new media, communications and social influence, 24Notion uniquely understands how to connect your brand strategy with the right consumer. 24Notion ranked #12 on Corporate Social Responsibility - Book of List.
Web Real-Time Communication APIs have quickly revolutionized what browsers are capable of. In addition to video and audio streams, we can now bi-directionally send arbitrary data over WebRTC's PeerConnection Data Channels. With the advent of Progressive Web Apps and new hardware APIs such as WebBluetooh and WebUSB, we can finally enable users to stitch together the Internet of Things directly from their browsers while communicating privately and securely in a decentralized way.
"My role is working with customers, helping them go through this digital transformation. I spend a lot of time talking to banks, big industries, manufacturers working through how they are integrating and transforming their IT platforms and moving them forward," explained William Morrish, General Manager Product Sales at Interoute, in this SYS-CON.tv interview at 18th Cloud Expo, held June 7-9, 2016, at the Javits Center in New York City, NY.
A strange thing is happening along the way to the Internet of Things, namely far too many devices to work with and manage. It has become clear that we'll need much higher efficiency user experiences that can allow us to more easily and scalably work with the thousands of devices that will soon be in each of our lives. Enter the conversational interface revolution, combining bots we can literally talk with, gesture to, and even direct with our thoughts, with embedded artificial intelligence, wh...
Adobe is changing the world though digital experiences. Adobe helps customers develop and deliver high-impact experiences that differentiate brands, build loyalty, and drive revenue across every screen, including smartphones, computers, tablets and TVs. Adobe content solutions are used daily by millions of companies worldwide-from publishers and broadcasters, to enterprises, marketing agencies and household-name brands. Building on its established design leadership, Adobe enables customers not o...
What are the new priorities for the connected business? First: businesses need to think differently about the types of connections they will need to make – these span well beyond the traditional app to app into more modern forms of integration including SaaS integrations, mobile integrations, APIs, device integration and Big Data integration. It’s important these are unified together vs. doing them all piecemeal. Second, these types of connections need to be simple to design, adapt and configure...
What happens when the different parts of a vehicle become smarter than the vehicle itself? As we move toward the era of smart everything, hundreds of entities in a vehicle that communicate with each other, the vehicle and external systems create a need for identity orchestration so that all entities work as a conglomerate. Much like an orchestra without a conductor, without the ability to secure, control, and connect the link between a vehicle’s head unit, devices, and systems and to manage the ...
The Jevons Paradox suggests that when technological advances increase efficiency of a resource, it results in an overall increase in consumption. Writing on the increased use of coal as a result of technological improvements, 19th-century economist William Stanley Jevons found that these improvements led to the development of new ways to utilize coal. In his session at 19th Cloud Expo, Mark Thiele, Chief Strategy Officer for Apcera, will compare the Jevons Paradox to modern-day enterprise IT, e...
Major trends and emerging technologies – from virtual reality and IoT, to Big Data and algorithms – are helping organizations innovate in the digital era. However, to create real business value, IT must think beyond the ‘what’ of digital transformation to the ‘how’ to harness emerging trends, innovation and disruption. Architecture is the key that underpins and ties all these efforts together. In the digital age, it’s important to invest in architecture, extend the enterprise footprint to the cl...
SYS-CON Events announced today that Commvault, a global leader in enterprise data protection and information management, has been named “Bronze Sponsor” of SYS-CON's 19th International Cloud Expo, which will take place on November 1–3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. Commvault is a leading provider of data protection and information management solutions, helping companies worldwide activate their data to drive more value and business insight and to transform moder...
SYS-CON Events has announced today that Roger Strukhoff has been named conference chair of Cloud Expo and @ThingsExpo 2016 Silicon Valley. The 19th Cloud Expo and 6th @ThingsExpo will take place on November 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA. "The Internet of Things brings trillions of dollars of opportunity to developers and enterprise IT, no matter how you measure it," stated Roger Strukhoff. "More importantly, it leverages the power of devices and the Interne...
What does it look like when you have access to cloud infrastructure and platform under the same roof? Let’s talk about the different layers of Technology as a Service: who cares, what runs where, and how does it all fit together. In his session at 18th Cloud Expo, Phil Jackson, Lead Technology Evangelist at SoftLayer, an IBM company, spoke about the picture being painted by IBM Cloud and how the tools being crafted can help fill the gaps in your IT infrastructure.
Digital innovation is the next big wave of business transformation based on digital technologies of which IoT and Big Data are key components, For example: Business boundary innovation is a challenge to excavate third-party business value using IoT and BigData, like Nest Business structure innovation may propose re-building business structure from scratch, as Uber does in the taxicab industry The social model innovation is also a big challenge to the new social architecture with the design fr...
Data is an unusual currency; it is not restricted by the same transactional limitations as money or people. In fact, the more that you leverage your data across multiple business use cases, the more valuable it becomes to the organization. And the same can be said about the organization’s analytics. In his session at 19th Cloud Expo, Bill Schmarzo, CTO for the Big Data Practice at EMC, will introduce a methodology for capturing, enriching and sharing data (and analytics) across the organizati...
DevOps at Cloud Expo, taking place Nov 1-3, 2016, at the Santa Clara Convention Center in Santa Clara, CA, is co-located with 19th Cloud Expo and will feature technical sessions from a rock star conference faculty and the leading industry players in the world. The widespread success of cloud computing is driving the DevOps revolution in enterprise IT. Now as never before, development teams must communicate and collaborate in a dynamic, 24/7/365 environment. There is no time to wait for long dev...
IoT offers a value of almost $4 trillion to the manufacturing industry through platforms that can improve margins, optimize operations & drive high performance work teams. By using IoT technologies as a foundation, manufacturing customers are integrating worker safety with manufacturing systems, driving deep collaboration and utilizing analytics to exponentially increased per-unit margins. However, as Benoit Lheureux, the VP for Research at Gartner points out, “IoT project implementers often ...