ColdBox HMVC Documentation
DocsSourceSupportTraining
7.x
7.x
  • Introduction
    • Contributing Guide
    • Release History
      • What's New With 7.4.0
      • What's New With 7.3.x
      • What's New With 7.2.0
      • What's New With 7.1.0
      • What's New With 7.0.0
        • Release Notes
    • Upgrading to ColdBox 7
    • What is ColdBox
    • What is MVC
    • About This Book
      • Author
  • For Newbies
    • 60 Minute Quick Start
      • Installing ColdBox
      • My First ColdBox Application
      • My First Handler & View
      • Linking Events Together
      • Working with Events
      • Adding A Layout
      • Adding A Model
      • RESTFul Data
      • Next Steps
    • Getting Started Guide
  • Getting Started
    • Installation
    • Application Templates
    • Conventions
    • Configuration
      • ColdBox.cfc
        • Configuration Directives
          • CacheBox
          • ColdBox
          • Conventions
          • Environments
          • Flash
          • InterceptorSettings
          • Interceptors
          • Layouts
          • LayoutSettings
          • LogBox
          • Modules
          • ModuleSettings
          • Settings
          • WireBox
        • System Settings (Java Properties and Environment Variables)
      • Using Settings
      • Bootstrapper - Application.cfc
  • The Basics
    • Request Context
    • Routing
      • Requirements
        • Rewrite Rules
      • Application Router
      • Routing DSL
        • Routing By Convention
        • Pattern Placeholders
        • Routing Methods
        • Resourceful Routes
        • Named Routes
        • Routing Groups
        • Routing Namespaces
      • Building Routable Links
      • RESTFul Extension Detection
      • HTTP Method Spoofing
      • HTML Base Tag
      • Pathinfo Providers
    • Event Handlers
      • How are events called?
      • Getting & Setting Values
      • Setting Views
      • Relocating
      • Rendering Data
      • Sending Files
      • Interception Methods
        • Pre Advices
        • Post Advices
        • Around Advices
      • Model Integration
        • Model Data Binding
      • HTTP Method Security
      • Implicit Methods
      • Executing Events
      • Executing Routes
      • Viewlets - Reusable Events
      • Event Caching
      • Validation
    • Layouts & Views
      • Views
        • Rendering Views
        • Rendering External Views
        • Rendering With Local Variables
        • Rendering Collections
        • View Caching
        • View Helpers
        • View Events
      • Layouts
        • Basic Layouts
        • Default Layout
        • Nested Layouts
        • Overriding Layouts
        • Layouts From A Module
        • Layout Helpers
        • Layout Events
      • Implicit Layout-View Declarations
      • Helpers UDF's
      • ColdBox Elixir
    • Models
      • Domain Modeling
        • Service Layer
        • Data Layers
        • Book
      • Conventions Location
      • WireBox Binder
      • Super Type Usage Methods
      • Injection DSL
        • ColdBox Namespace
        • CacheBox Namespace
        • EntityService Namespace
        • Executor Namespace
        • Java Namespace
        • LogBox Namespace
        • Models Namespace
        • Provider Namespace
        • WireBox Namespace
      • Object Scopes
      • Coding: Solo Style
        • Datasource
        • Contact.cfc
        • ContactDAO.cfc
        • ContactService.cfc
        • Contacts Handler
      • Coding: ActiveEntity Style
        • ORM
        • Contact.cfc
        • Contacts Handler
        • Views
      • Coding: Virtual Service Layer
        • ORM
        • Contacts.cfc
        • Contacts Handler
        • Views
      • Coding: ORM Scaffolding
        • ORM
        • Contacts.cfc
        • Scaffold
    • Interceptors
      • How do they work?
        • Conventions
      • Interceptor Declaration
      • Interceptor Registration
      • Dynamic Registration
      • Core Interception Points
        • Application Life Cycle Events
        • Object Creating Events
        • Layout-View Events
        • Module Events
        • CacheBox Events
      • Restricting Execution
      • Interceptor Output Buffer
      • Custom Events
        • Configuration Registration
        • Programmatic Registration
        • Listening
        • Announcing Interceptions
      • Unregistering Interceptors
      • Reporting Methods
      • Interceptor Asynchronicity
        • Async Announcements
        • Async Listeners With Join
        • Async Listeners No Join
        • Asynchronous Annotations
  • HMVC
    • Modules
      • Core Modules
      • Locations
      • Parent Configuration
      • Module Layout
        • Changing The Module Layout
      • Module Service
        • Module Lifecycle
        • Module Registration
        • Module Activation
        • Module Unloading
        • Common Methods
        • Loading New Modules
        • Loading A-la-carte Modules
        • Module Events
      • ModuleConfig
        • Public Module Properties
        • The Decorated Variables
        • The configure() Method
        • Module Settings
        • Environment Control
        • Interceptor Events
      • Module Event Executions
      • URL Routing
        • Default Route Execution
        • Module Routes Files
      • Module Async Scheduling
      • Request Context Module Methods
      • Layout and View Renderings
        • Layout/View Discovery
        • Overriding Views
        • Overriding Layouts
        • Default Module Layout
        • Explicit Module Renderings
      • Models
      • Module CF Mappings
      • Module Dependencies
      • Module Helpers
      • Module Bundles
      • Module Inception
  • Testing
    • Testing Quick Start
    • Testing ColdBox Applications
      • Test Harness
      • ColdBox Testing Classes
      • Testing Methods
      • Integration Testing
        • Test Annotations
        • Life-Cycle Events
        • Request Setup()
        • The execute() Method
        • HTTP Testing Methods
        • Testing Without Virtual Application
      • Interceptor Testing
      • Model Object Testing
      • Tips & Tricks
  • Digging Deeper
    • Async Programming
      • Async Pipelines & Futures
      • Parallel Computations
      • Executors
      • Scheduled Tasks
    • ColdBox Proxy
      • Getting Started
      • The Base Proxy Object
      • The Event Handlers
        • Distinguishing Request Types
        • RenderData()
      • Proxy Events
      • Standard Return Types
      • Caveats & Gotchas
    • Controller Decorator
    • ColdBox Scheduled Tasks
    • Flash RAM
      • Flash Storage
      • Using Flash RAM
      • Creating Your Own Flash Scope
    • HTML Helper
    • REST Handler
    • Request Context Decorator
    • Recipes
      • Building REST APIs
      • ColdBox Exception Handling
      • Debugging ColdBox Apps
      • Clearing the View Cache
      • Basic HTTP Authentication Interceptor
  • Architecture Concepts
    • How ColdBox Works
Powered by GitBook
On this page
  • ColdFusion 2016 Support Dropped
  • HTML Helper addAsset() Changes
  • Integration Testing Defaults
  • Hierarchical Injectors
  • Testing Injector Creations
  • Custom Wirebox DSLs
  • Removals
  • AnnounceInterception
  • routes.cfm
  • setUniqueURLs()
  • jsonQueryFormat Removed
  • Deprecations
  • renderView(), renderLayout(), renderExternalView()
  • Utility Environment Methods
  • BeanPopulator Deprecated

Was this helpful?

Edit on GitHub
Export as PDF
  1. Introduction

Upgrading to ColdBox 7

The official ColdBox 7 upgrade guide

Last updated 1 year ago

Was this helpful?

The major compatibility issues will be covered, as well as how to upgrade to this release from previous ColdBox versions smoothly. You can also check out the guide to give you a full overview of the changes.

ColdFusion 2016 Support Dropped

ColdFusion 2016 support has been dropped. Adobe doesn't support them anymore, so neither do we.

HTML Helper addAsset() Changes

The addAsset() now leverages the following settings for determining the convention locations for JavaScript and CSS assets:

Setting
Default Value

htmlhelper_js_path

/includes/js

htmlhelper_css_path

/includes/css

So if you want to change the location of your JavaScript and CSS, you can create these settings in your ColdBox.cfc

settings = {
    htmlhelper_js_path : "/assets/js",
    htmlhelper_css_path : "assets/css"
}

Integration Testing Defaults

In ColdBox 7, the this.unloadColdBox setting is false by default. In ColdBox 6 this was true by default. So make sure you update this setting if you want ColdBox to be unloaded on each Test Bundle iteration.

Hierarchical Injectors

All modules have their own injector now if you use the this.moduleInjector = true setting. Meaning the concept of a global injector no longer exists. Therefore, there are some edge cases where certain types of code will not work in ColdBox 7.

Testing Injector Creations

If you are creating your own WireBox injector in your tests and using integration testing, you will have Injector collisions.

myInjector = new coldbox.system.ioc.Injector()

This actually affects EVERY version of ColdBox because the default behavior of instantiating an Injector like the code above is to put the Injector in application scope: application.wirebox. This means that the REAL injector in an integration test lives in application.wirebox will be overridden. To avoid this collision, disable scope registration:

myInjector = new coldbox.system.ioc.Injector( {
    scopeRegistration : { enabled : false }
} )

Custom Wirebox DSLs

For those of you with custom wirebox DSLs, you'll need to update your DSL to match the new process() method signature:


/**
 * Process an incoming DSL definition and produce an object with it
 *
 * @definition   The injection dsl definition structure to process. Keys: name, dsl
 * @targetObject The target object we are building the DSL dependency for. If empty, means we are just requesting building
 * @targetID     The target ID we are building this dependency for
 *
 * @return coldbox.system.ioc.dsl.IDSLBuilder
 */
function process( required definition, targetObject, targetID );

Removals

AnnounceInterception

routes.cfm

setUniqueURLs()

This setting was in charge of converting NON-SES Urls into SES URLs. However, it was extremely error-prone and sometimes produced invalid URLs. This is now completely removed and if the user wants to do this feature, they can use CommandBox or Nginx, or Apache rewrites.

jsonQueryFormat Removed

The jsonQueryFormat argument for rendering data is now removed. We default to an array of structs format for queries as it is the only format that makes sense.

Deprecations

There is a performance penalty to use any deprecated methods now, since they emit warnings to the logs.

renderView(), renderLayout(), renderExternalView()

These methods have been deprecated since version 6. Please use the shorthand versions

  • view()

  • layout()

  • externalView()

Utility Environment Methods

The core utility methods on env and Java variables have been deprecated from the utility object and moved to the Env delegate. Here are the methods deprecated:

  • getSystemSetting()

  • getSystemProperty()

  • getEnv()

So if you had code like this:

// Deprecated
new coldbox.system.core.util.Util().getSystemSetting()

That will work, but it is deprecated now. You will have to move it to the delegate:

new coldbox.system.core.delegates.Env().getSystemSetting()

If you were using them in your integration or unit tests, then you can use our shorthand methods:

getEnv().getSystemSetting()
getEnv().getSystemProperty()
getEnv().getEnv()

BeanPopulator Deprecated

The object BeanPopulator has been deprecated in favor of ObjectPopulator.

The announceInterception() method . You will need to refactor any uses of announceInterception() to use announce() instead.

The routes.cfm approach is now removed in ColdBox 7. You will need to migrate to the Router.cfc in your application and/or modules.

What's New
has been deprecated since ColdBox 6.0.0
approach