Dashboard

Welcome To The ColdBox Wiki

The ColdFusion Enterprise Conventions Based Object Oriented Framework

Pre-OpenCFSummit Trainings

General Platform Information

• Credits : A thank you to the team and collaborators
• Site Usage : Checkout some of the companies, websites and applications that run ColdBox
• Books : Check out the ColdBox Books Library
• ColdBox Case Studies : Our collection of Company Case Studies using the ColdBox Platform
• Assembla Space
• Github Source
• Professional Services

What's New ?

A collection of all the what's new documents for each ColdBox Release.

• What's New with 3.5.0
• What's New with 3.1.0
• What's New with 3.0.0

Compatibility Guides

These guides are to help developers migrate to new versions of the framework.

• Upgrading to ColdBox 3.5.0
• Upgrading to ColdBox 3.0.0 (2.X.X - 2.6.3)

Installing & Getting Ready For Development

This section contains the necessary information to install, upgrade, maintain and get ready to start developing in ColdBox.

• Installing ColdBox
• Refactoring ColdBox for Custom Installations
• Installing IDE Syntax Dictionaries
• Adobe CF Builder Extension : ColdBox Platform Utilities
• Cool CheatSheet

The Basics

This section gives you an introductory or getting started feel to ColdBox Development!

• ColdBox Overview
• My First ColdBox Application
• Application Directory Structure & Conventions
• ColdBox MVC & Remote Request Life Cycles

Configuration

This section gives you the insight needed to use configuration settings and logging in your ColdBox Applications.

• The ColdBox Configuration CFC
• Interacting With Settings
• Application.cfc Bootstrapper
• ColdBox URL Actions
• Fun Logging with LogBox

Models

This section delves into the model layer of MVC, ORM integration, dependency injection and much more.

• Model Integration
• Dependency Injection and AOP via WireBox
• Aspect Oriented Programming via WireBox
• Built-in ORM Services
  • CF ORM Virtual Entity Service Layers
  • CF ORM Event Handling
  • ColdBox Hibernate Criteria Builder
• Transfer ORM Support
• Reactor ORM Support

Views

Discover ColdBox layout and view rendering

• Layouts and Rendering in ColdBox

Controllers

Learn how to build and leverage ColdBox events.

• Event Handlers
• URL Mapping & Rewriting

Request Context

Discover the main class for transporting and dealing with requests.

• The Request Context
• Extending The Request Context

Extending ColdBox

Learn how to extend ColdBox

• ColdBox Modules & Architecture
• ColdBox Plugins
• ColdBox Interceptors

Down The Rabbit Hole

Deeper we go down the rabbit hole with cool advanced topics.

• The Flash RAM Object & Webflows

• ColdBox-Ajax Integration
• ColdBox Proxy: Powering Flex/AIR/Remote Applications
• CacheBox: The ColdBox Enterprise Caching Engine
• ColdBox Recipes
• Internationalization Guide (i18n)
• Security Interceptor: Securing your applications
• Autowiring Objects
• Aspect Oriented Programming via WireBox

Testing ColdBox Applications

Unit Testing, Integration Testing, and so much more.

• ColdBox Unit Testing & Integration Testing
• Mocking and Stubbing in ColdBox Applications

Theory

This documentation section touches on the theory of MVC, ColdBox application architecture, and an introductory overview to the ColdBox Platform.

• Model-View-Controller Demystified
• ColdFusion Development Best Practices
• ColdFusion SQL Injection Protection Best Practices
• Database Naming Conventions

Standalone Frameworks & Libraries

The ColdBox Platform is composed of several standalone internal frameworks and libraries that can be used on standalone applications as well as within ColdBox applications. Below are the documents for each standalone library or framework.

• MockBox: The ColdBox Mocking/Stubbing Framework
• CacheBox: The ColdBox Enterprise Caching Engine
• LogBox: The ColdFusion Enterprise Logging Library
• WireBox: ColdBox DI/AOP Engine
• WireBox AOP

Core Plugins

Visit our Core Plugins Page Browser

• AntiSamy - Built in XSS cleanup tool
• Application Storage - Interface to the Application scope, the OO way
• BeanFactory - Our interface to WireBox
• Client Storage - Interface to the Client scope, the OO way
• Cluster Storage - Interface to the Cluster scope, the OO way
• Cookie Storage - Interface to the Cookie scope, the OO way
• Date Utility - Help you with funky dates
• Feed Reader Plugin - Read any feed
• Feed Generator Plugin - Generate any feed
• Feed Generator Elements
• File Utility - Cool file utility methods
• HTMLHelper - Get fancy with HTML
• IOC Plugin - Interface to Inversion of Control frameworks
  • ColdBox-ColdSpring Integration Guide
  • ColdBox-LightWire Integration Guide
• Internationalization Guide (i18n)
  • i18n Plugin
  • Resource Bundle Plugin
• JavaLoader - Get funky and interact with java the easy way
• JVMUtils - Talk to our favorite friend
• Logger Plugin - Interfacing with LogBox
• Mail Service - Sending mails with token replacements
• MessageBox - Cool little messages for your apps
• Query Helper - Do some query magic with this plugin
• Session Storage - Interface to the Session scope, the OO way
• Timer - Need to time/profile your code to the ColdBox Debugger?
• Validator - Validate ANYTHING!
• Webservices - Interact with your set webservices
• XML Converter - Convert anything to XML
• Zip - Zip Anything

Core Interceptors

Visit our Core Interceptors Page Browser

• Autowire Interceptor
• Security Interceptor: Securing your applications

Standalone Projects

The ColdBox standalone projects are a suite of projects, plugins, interceptors, modules, etc that are not part of the core platform but are available as separate downloads from ForgeBox. You can find these and tons of other projects at ForgeBox, our community repository. We are trying to document all official released entries.

• The Groovy Loader Project
• The Lookup Manager Project
• JSMin Compressor for ColdBox Applications
• SASS Implementation in ColdBox
• ColdBox Relax: RESTful Tools For Lazy Experts
• CFCViewer - Love Documentation? Then use this plugin to document ANYTHING!
• String Buffer - Need lots of string concatenations the fast way?
• Cluster/Tier Deployment Interceptor
• ColdBox SideBar

ColdBox Recipes

A collection of useful recipes, you can also check out our Recipes Viewer

1. Using Helper UDF's and CFC's
2. My First Event Handler
3. My First Custom Exception Handler
4. My First Custom Plugin
5. My First Interceptor
6. My First Context Decorator
7. How to time your code
8. Object factory custom plugin
9. Loading a custom ColdBox configuration file
10. Tracing messages to the debug panel
11. Creating a messagebox css
12. Creating a Custom exception template
13. Caching objects
14. Autowiring using the ColdBox cache
15. Persisting values using the ColdBox Flash Ram
16. Creating a 404 template via onInvalidEvent
17. Is there an easy, programmatic way to remove a specific element from the view cache
18. Building a simple Basic HTTP Authentication Interceptor

ForgeBox REST API Documentation

ForgeBox is an online repository of anything ColdBox or CodexWiki. Below is the documentation for its RESTful API.

• API Documentation

Other Resources

• Community Articles & Tutorials : A collection of community articles and tutorials
• Media & Presentations : A collection of ColdBox media and presentations
• User Group Presentations : A collection of ColdBox user group presentations