CBDW2014 - Building ContentBox Modules
1 like476 views
ContentBox is a modular CMS developed by Luis Majano, designed for scalability and secure deployment using ColdBox technology. It features a collection of modules for various functionalities including admin tools, e-commerce, and custom application support. The platform emphasizes event-driven programming, offering a flexible architecture that allows for the activation and extension of modules.
CBDW2014 - Building ContentBox Modules
- 1. ContentBox Modular CMS Time to release your content from it’s box!
- 2. Who am I? Luis Majano - Computer Engineer Born in El Salvador ------------------> President of Ortus Solutions Manager of the IECFUG (www.iecfug.com) Creator of ColdBox, MockBox, LogBox, CacheBox, WireBox, ContentBox, or anything Box! Documentation Weirdo! @lmajano, @ortussolutions
- 3. Agenda ContentBox Overview + Technology ContentBox Modularity Deployment + Scalability Features Build Stuff
- 4. ContentBox Modular CMS Modular CMS Powered by ColdBox OO Content Model Powered by ORM Built to scale, cluster and deploy securely Public release August 2012 Professional Open Source www.gocontentbox.org
- 5. Why Modules?
- 6. ContentBox Modularity ANY ColdBox MVC Application ContentBox Admin ContentBox UI ContentBox Core Forum eCommerce Custom App Custom Security Views Model Events ColdBox Modules Security
- 7. Modular Architecture ContentBox Admin ContentBox UI ContentBox Core Forum eCommer ce Custom Module Flex/Air Remote RESTful QA Module Google Analytics
- 9. Traditional Deployment Monolithic APP, ADMIN, TOOLS, API DMZ Database
- 10. Modular Segregated Deployment ContentBox UI DMZ Database ContentBox Admin ContentBox Core ContentBox Core Reportin Security SAP REST
- 11. ContentBox Modules Extended ColdBox Modules Managed by ContentBox Admin Activated/Deactivated Installed/Uninstalled Extend ContentBox or ColdBox Application ContentBox is a collection of modules wiki.coldbox.org/wiki/Modules.cfm
- 13. Features ContentBox menu contributions Custom events ContentBox admin events Application events Custom Views More services/models URL Mappings Widgets Environment detection ForgeBox Connected Coming: Themes + ColdBox 4 Support
- 14. Interceptors Majority of extensions are via Interceptors! ! Event Driven Programming
- 15. IDE + Tools ContentBox Utilities
- 16. Anatomy of a Module ModuleConfig.cfc handlers layouts models modules Module Name (unique on disk) box.json views widgets
- 17. box.json
- 18. ModuleConfig.cfc Simple CFC Bootstraps your module Must exist in the root of your module folder Has public properties configure() for configuration 4 callback methods: onLoad(), onUnload(), onActivate(), onDeactivate() Tier-detection enabled It’s an interceptor too!
- 19. ModuleConfig.cfc
- 21. CBHelper One stop shop for anything ContentBox API Docs Module Methods buildModuleLink( module, linkTo, queryString, ssl ) setNextModuleEvent( module, event, queryString .... )
- 22. Extend: Widgets Based on ColdBox plugins Simple interface: renderit() Self-documenting Use in editors, layouts and as ColdBox Plugins any function renderIt(required slug, defaultValue){ var entry = entryService.findWhere({slug=arguments.slug}); if( !isNull(entry) ){ return entry.getContent(); } // default value if( structKeyExists(arguments, "defaultValue") ){ return arguments.defaultValue; } throw(message="The content slug '#arguments.slug#' does not exist",type="CustomHTMLWidget.InvalidEntrySlug"); }
- 23. Extend: Editors Page, Blog and Custom HTML Editors accept widgets via {{{ }}} notations //Executes the renderit() by convention {{{WidgetName arg1=value arg2=value}}} // Execute ANY method {{{WidgetName.method arg1=value arg2=value}}} UI Way
- 24. Extend: Events Based on ColdBox interceptors Event driven programming Over 100 different events function cbadmin_postAuthorSave(event,interceptData){ var author = arguments.interceptData.author; var currentAuthor = securityService.getAuthorSession(); // get mail payload var bodyTokens = { authorName = author.getName(), authorRole = author.getRole().getRole(), authorEmail = author.getEmail(), authorURL = CBHelper.linkAdmin("authors.editor.authorID.#author.getAuthorID()#"), currentAuthor = currentAuthor.getName(), currentAuthorEmail = currentAuthor.getEmail() }; var mail = mailservice.newMail(to=settings.cb_site_email, from=settings.cb_site_outgoingEmail, subject="#settings.cb_site_name# - Author Created - #bodyTokens.authorName#", bodyTokens=bodyTokens); // generate content for email from template mail.setBody( renderer.renderView(view="email_templates/author_new",module="contentbox") ); // send it out mailService.send( mail ); } Extend the admin/layouts interface Use as filters Produce output
- 26. Admin Events
- 27. Admin Events
- 28. Admin Events
- 29. UI Module Events
- 30. Security Events
- 32. Code Time!
- 33. Thanks! Q & A