coldbox.orgColdbox Platform

DOCS TRAINING FORGEBOX NEWS SUPPORT Change ColdBox theme COLDBOX: A conventions-based modern HMVC framework for ColdFusion (CFML) Quick Start Learn COMPANIES THAT TRUST COLDBOX COMPANIES THAT TRUST COLDBOX UNLOCK THE POWER OF COLDBOX Leverage CommandBox CLI for Rapid Appplication Development Leverage our modern CLI and package manager for ColdFusion: CommandBox , to quickly create and run ColdBox applications. CommandBox allows you to scaffold not only an HTML web app, but also a VueJs, Angular, React, REST ColdBox apps and much more. If you have CommandBox CLI installed, getting started with ColdBox is as easy as coldbox create app ! // Install ColdBox CLI install coldbox-cli // Create an API coldbox create app skeleton=rest // Startup a server server start Start Now! COLDBOX FEATURES Enhance Your Development Experience features Select Feature Features HMVC Modular Architecture Powerful Routing API First Interceptors Scheduled Tasks Job Queues Modularity Security Testing ColdBox CLI Container Ready Documentation ORMs Database Migrations Validation Features HMVC Modular Architecture Powerful Routing API First Interceptors Scheduled Tasks Job Queues Modularity Security Testing ColdBox CLI Container Ready Documentation ORMs Database Migrations Validation ColdBox offers more than just outstanding core features. Its ecosystem is brimming with many functionalities already developed, empowering you to focus on your business requirements. Whether it’s authentication, authorizations, database migrations, ORM, validation, messaging, jobs, events, file storage, scheduled tasks, or countless other possibilities, ColdBox has got you covered. The modular core framework and various modules seamlessly integrate these features, ensuring a transformative development experience. Made & Supported by: HMVC MODULAR ARCHITECTURE ColdBox is a standout among modern frameworks, as it offers a unique and powerful hierarchical model view controller architecture by conventions. Unlike many other frameworks that follow a traditional linear approach to handling requests, ColdBox allows developers to organize their code into a hierarchical structure, enabling efficient separation of concerns and promoting code reusability. Zoom Image By dividing complex applications into smaller, manageable units, ColdBox enables developers to create more modular and scalable codebases, leading to enhanced maintainability and faster development cycles. This HMVC architecture offered by ColdBox empowers developers to build robust and flexible applications that can adapt and evolve with ease. Read more about ColdBox modules and HMVC in our documentation. POWERFUL ROUTING ColdBox offers powerful routing capabilities that allow developers to customize URLs and map them to specific actions, views, responses or handlers. With ColdBox , you can create expressive, readable, and SEO-friendly URLs using placeholders, redirects, responses, views, and more. // Routing with placeholders route( "/blog/:year-numeric{4}/:month-numeric?/:day-numeric?" ) .to( "blog.list" ) // Redirects route( "/old/:book" ) .toRedirect( "/mybook" ) // Responses route( "/api/heartbeat" ).toResponse( (event,rc,prc) = { return "ok!" } ); // Show a view route( "/contact-us" ) .toView( "main/contact" ) // Expressive Named Routes route( "/wiki/:page" ) .as( "page" ) .to( "wiki.show") ColdBox routing is highly customizable and flexible, allowing developers to create complex routing rules that match their specific needs. For more information about ColdBox routing, check out the routing documentation . API FIRST ColdBox has truly exceptional native REST capabilities which have been integrated with the RestHandler , a customizable Response object and a powerful URL Router into the core. This RestHandler will provide you with utilities and approaches to make all of your RESTFul services: Uniformity for responses Use a consistent and extensible response object Provide consistent error handling Provide Invalid route handling Much more component extends="coldbox.system.RestHandler"{ function hello( event, rc, prc ){ event .getResponse() .setData( "Hello from restful Land" ) } function invalidData( event, rc, prc ){ event .getResponse() .setErrorMessage( errorMessage : "invalid id sent", statusCode : 401 ) } function showData( event, rc, prc ){ prc.data = service.getUsers() return prc.data } function myData( event, rc, prc ){ prc.mydata = myservice.getData() return renderView( "main/myData" ) } } Read more about the native REST capabilities in our documentation. INTERCEPTORS ColdBox Interceptors are a powerful feature in the ColdBox HMVC framework that allows you to intercept and modify the behavior of a request throughout its lifecycle. Interceptors act as event-driven components that can be executed before, after, or during a request, giving you fine-grained control over the application flow. With ColdBox Interceptors , you can perform various tasks such as authentication, authorization, logging, caching, performance monitoring, and more. They provide a clean separation of concerns and help keep your code modular and reusable. Easily Announce Events #announce( ’onSidebar’ )# // Announce inside a function if( userCreated ){ announce( ’onUserCreate’, { user = prc.oUser } ) } Easily Listen To Any Event component extends="coldbox.system.Interceptor"{ function onError( event, interceptData = {} ){ // Listen to onError events } function onUserCreate( event, interceptData = {} ){ // Listen to onUserCreate events } } ColdBox Interceptors are easy to configure and integrate into your application. You can define them in your ColdBox configuration file or use annotations within your handler methods. This flexibility allows you to apply interceptors globally, to specific handlers, or even to individual actions within a handler. In summary, ColdBox Interceptors empower you to intercept and modify the behavior of requests, enabling you to add functionality, enforce security, and enhance the performance of your ColdBox applications. They are a valuable tool for building flexible and maintainable applications in the ColdFusion ecosystem. You can find much more information about interceptors in the documentation . SCHEDULED TASKS The ColdBox Scheduled Tasks offers a fresh, programmatic, human approach to scheduling tasks on your server and multi-server application. It allows you to define your tasks in a portable Scheduler we lovingly call the Scheduler.cfc which not only can be used to define your tasks but also monitor all of their life cycles and metrics of tasks. Since ColdBox is also hierarchical, it allows every single ColdBox Module to define a Scheduler and register their tasks. This is a revolutionary approach to scheduling tasks in an HMVC application. /** ** Register Scheduled Tasks ** You register tasks with the task() method and get back a ColdBoxScheduledTask object * that you can use to register your tasks configurations. */ task( "Clear Unregistered Users" ) .call( () = getInstance( "UserService" ).clearRecentUsers() ) .everyDayAt( "09:00" ) task( "Hearbeat" ) .call( () = runEvent( "main.heartbeat" ) ) .every( 5, "minutes" ) .onFailure( ( task, exception ) = { getInstance( "System" ).sendBadHeartbeat( exception ) } ) /** ** Task Closure/Lambda/Object ** You register the callable event via the call() method on the task object. * You can register a closure/lambda or a invokable CFC. */ // Object with run() method task( "my-task" ) .call( wirebox.getInstance( "MyObject" ) ) .everyDay() // Object with a custom method task( "my-task" ) .call( wirebox.getInstance( "MyObject" ), "reapCache" ) .everydayAt( "13:00" ) JOB QUEUES ColdBox can work with job queues via its cbq module: install cbq . Queues allow you to push work to the background, schedule work to be done later, or even process work on many different machines. It runs on a provider-based system allowing a unified API to talk with many different queue backends. install cbq Create a Worker...