wiki.coldbox.orgIntroduction | 7.x | ColdBox HMVC Documentation

ColdBox HMVC Documentation 7.x 4.x 5.x 6.x 7.x Docs CacheBox LogBox WireBox Source Bug Reports FORGEBOX Github Modules Starter Templates Support Become a Patron Community Professional Training CFCasts Instructor-Led Courses Master Class Ask or Search Ctrl + K Introduction Contributing Guide Release History What’s New With 7.3.0 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 Introduction ColdBox is a conventions-based HMVC web development framework for ColdFusion (CFML). ColdBox HMVC Platform- v7.x ColdBox Hierarchical MVC is the de-facto enterprise-level HMVC framework for ColdFusion (CFML) developers. It’s professionally backed, conventions-based, modular, highly extensible, and productive. Getting started with ColdBox is quick and painless. ColdBox takes the pain out of development by giving you a standardized methodology for modern ColdFusion (CFML) development with features such as: Conventions instead of configuration Modern routing engine RESTFul API ready A hierarchical approach to MVC using ColdBox Modules Event-driven programming Async and Parallel programming constructs Integration & Unit Testing Included dependency injection Caching engine and API Logging engine An extensive ecosystem Much More It provides a set of reusable code and tools that can be used to increase your development productivity, as well as a development standard for working in team environments. License The ColdBox Platform is open source and licensed under the Apache 2 License. Copyright by Ortus Solutions, Corp ColdBox, CacheBox, WireBox, and LogBox are registered trademarks of Ortus Solutions, Corp. Discussion & Help The Ortus Community is how to get help for our entire platform and modules: https://community.ortussolutions.com . You can also join our Slack Box Team at: https://boxteam.ortussolutions.com Reporting a Bug We all make mistakes from time to time :) So why not let us know about it and help us out? We also love ? pull requests, so please star us and fork us at: https://github.com/coldbox/coldbox-platform Jira Issue Tracking https://ortussolutions.atlassian.net/browse/COLDBOX https://ortussolutions.atlassian.net/browse/WIREBOX https://ortussolutions.atlassian.net/browse/LOGBOX https://ortussolutions.atlassian.net/browse/CACHEBOX Professional Open Source ColdBox is a professional open source software backed by Ortus Solutions, Corp offering services like: Custom Development Professional Support & Mentoring Training Server Tuning Security Hardening Code Reviews Much More Resources Official Site: https://www.coldbox.org CFCasts Video Training: http://www.cfcasts.com Facebook: https://www.facebook.com/coldboxplatform Source Code: https://github.com/coldbox/coldbox-platform Bug Tracker: https://ortussolutions.atlassian.net/browse/COLDBOX Slack: https://boxteam.ortussolutions.com Twitter: @coldbox @ortussolutions Vimeo Channel: https://vimeo.com/channels/coldbox HONOR GOES TO GOD ABOVE ALL Because of His grace, this project exists. If you don’t like this, don’t read it, it’s not for you. "Therefore being justified by faith , we have peace with God through our Lord Jesus Christ: By whom also we have access by faith into this grace wherein we stand, and rejoice in hope of the glory of God." Romans 5:5 Last updated 19 hours ago On this page ColdBox HMVC Platform- v7.x License Discussion & Help Reporting a Bug Jira Issue Tracking Professional Open Source Resources HONOR GOES TO GOD ABOVE...