Reason Developer Zone

Any code developed for Reason should be thoroughly documented with appropriate comments that can be used by PHP Documentor. Auto-generated documentation is built nightly and available online. The following describes the package / subpackage structure that should be used within the reason_package.

Key:

• package_name
• • subpackage_name

Package / Subpackage Structure

• carl_util
• • basic
  • cache
  • charts
  • db
  • dev
  • error_handler
  • go
  • ldap
  • pdf
  • tidy
• disco
• • boxes
  • plasmature
• loki
• reason
• • admin
  • classes
  • admin_classes
  • asset_classes
  • admin_modules
  • content_deleters
  • content_listers
  • content_managers
  • content_post_deleters
  • content_previewers
  • content_sorters
  • display_name_handlers
  • errors
  • feeds
  • finish_actions
  • function_libraries
  • minisite
  • minisite_templates
  • minisite_modules
  • minisite_nav_classes
  • popups
  • popup_templates
  • scripts
  • ssh
• thor
• tyr

Anything that is placed in the lib/local folder should use package reason_local instead of reason, but with the same subpackage structure.

To apply a package and subpackage to a file, use the following comment at the top of the file:

/**
 * @package package_name
 * @subpackage subpackage_name
 */