coder_review.module

Version 1.25 (checked in on 2009/09/26 at 23:00:50 by sun)

Developer Module that assists with code review and version upgrade that supports a plug-in extensible hook system so contributed modules can define additional review standards.

Built-in support for:

• Drupal Coding Standards - http://drupal.org/node/318
• Handle text in a secure fashion - http://drupal.org/node/28984
• Converting 4.6.x modules to 4.7.x - http://drupal.org/node/22218
• Converting 4.7.x modules to 5.x - http://drupal.org/node/64279
• Converting 5.x modules to 6.x - http://drupal.org/node/114774
• Comment Standards - http://drupal.org/node/1354
• SQL coding conventions - http://drupal.org/node/2497

Credit also to dries:

• http://cvs.drupal.org/viewcvs/drupal/drupal/scripts/code-style.pl

Constants

Name	Description
SEVERITY_CRITICAL
SEVERITY_MINOR
SEVERITY_NORMAL

Functions

Name	Description
coder_review_admin_settings	Implements settings page.
coder_review_form_alter	Implements hook_form_alter().
coder_review_help	Implements hook_help().
coder_review_menu	Implements hook_menu().
coder_review_menu_alter	Implements hook_menu_alter().
coder_review_page	Implements code review page.
coder_review_page_form	Implements hook_form().
coder_review_page_form_submit	Implements hook_submit().
coder_review_permission	Implements hook_permission().
coder_review_reviews	Implements hook_reviews().
coder_review_settings_form_submit	Callback function for settings page.
coder_review_simpletest	Implements hook_simpletest().
coder_review_theme	Implements hook_theme().
do_coder_review	Perform code review for a review array.
do_coder_reviews	Perform batch coder reviews for multiple files.
do_coder_review_callback	Allow for an arbitrary callback function to perform a review.
do_coder_review_grep	Search for a string.
do_coder_review_grep_invert	Search for potentially missing string.
do_coder_review_regex	Implements do_coder_review_* for regex match.
theme_coder_review	Format coder_review form and results.
theme_coder_review_table_cols	Implement theme_cols to theme the radiobuttons and checkboxes form elements in a table column.
theme_coder_review_warning	Format a coder_review warning to be included in results.
theme_coder_review_warning_msg	Format a coder_review warning to be included in results, creating the text.
theme_drupalapi	Format link to Drupal API.
theme_phpapi	Format link to PHP documentation.
_coder_review_default_reviews	Helper functions for settings form.
_coder_review_error	Builds an error message based on the rule that failed and other information.
_coder_review_get_default_settings	Returns a active settings array for coder_review.
_coder_review_get_reviews_extensions	Return the extensions used by the reviews, that aren't part of the default extensions.
_coder_review_is_drupal_core	Return true if $module is in Drupal core.
_coder_review_modified	Return last modification timestamp of coder_review and all of its dependencies.
_coder_review_page_form_includes	Add results to form array for display on form page.
_coder_review_read_and_parse_file	Parse and read a file into a format easy to validate.
_coder_review_reviews	Get all of the code review modules, including contributions.
_coder_review_search_string	Search for a string.
_coder_review_settings_array	Generate settings array for either modules or themes.
_coder_review_settings_form	Build settings form API array for coder_review.
_coder_review_severity	Return the integer severity magic number for a string severity.
_coder_review_severity_name	Return string severity for a given error.
_coder_review_warning	Return the formatted warning message from the $rule.