PostNuke Help

Previous
Notes for Module Developers

Home
up


Module Developer's Checklist

The following checklist presents a number of items that need to be checked throughout the process of designing, building, and releasing a module.

Initial  
· Decide on module type
· Choose name for module
· Register name for module
· Obtain and read MDG documentation
· Obtain and read API documentation
Module Design  
· Separate User and Administration Functions
· Separate GUI and API Functions
· Design data tables
· Note which utility modules are of use
· Note which standard module functions apply
· Create module security schema
Module Build  
· Copy template module directory
· Create database tables
· Create database initialisation routines
· Test database initialisation routines
· Write administration functions
· Test administration functions
· Test administration functions
· Write user functions
· Test user functions
· Write blocks
· Test blocks
· Document module API
· Package module
Module Checks  
· No global variables used
· No PostNuke reserved variable names used
· No echo() or print() statements used
· All operations protected by pnSecAuthAction()
· All forms results protected by pnSecConfirmAuthKey()
· All form variables obtained by pnVarCleanFromInput()
· All output parsed through pnVarPrepForDisplay() or pnVarPrepHTMLDisplay()
· All suitable output censored by pnVarCensor()
· All variables in SQL queries protected by pnVarPrepForStore()
· All variables in filesystem access protected by pnVarPrepForOS()
· Calls to pnModCallHooks() in all appropriate locations

Previous
Notes for Module Developers

Home
up