function do_coder_reviews in Coder 6.2

Same name and namespace in other branches

1. 5.2 coder.module \do_coder_reviews()
2. 5 coder.module \do_coder_reviews()
3. 6 coder.module \do_coder_reviews()
4. 7.2 coder_review/coder_review.common.inc \do_coder_reviews()
5. 7 coder_review/coder_review.module \do_coder_reviews()

Perform batch coder reviews for multiple files.

Parameters

$coder_args: Array of coder arguments, valid arguments are:

• '#reviews' => array list of reviews to perform, see _coder_reviews();
• '#severity' => integer magic number, see constants SEVERITY_*;
• '#filename' => string filename to check,
• '#patch' => string patch lines to check,

Return value

Array of results, in form:

• '#stats' => Array with error counts for all severities, in form 'minor' => integer count, 'normal' => integer count; 'critical' => integer count;
• integer ID => HTML error for display.

2 calls to do_coder_reviews()

coder_page_form in ./coder.module

Implementation of hook_form().

_coder_page_form_includes in ./coder.module

Add results to form array for display on form page.

File

./coder.module, line 1000

Code

function do_coder_reviews($coder_args) {
  if (empty($coder_args['#patch']) && empty($coder_args['#test']) && $coder_args['#cache']) {

    // Load the cached results if they exist.
    $cache_key = 'coder:' . md5(implode(':', array_keys($coder_args['#reviews']))) . $coder_args['#severity'] . ':' . $coder_args['#filename'];
    if (function_exists('_coder_drush_is_option') && _coder_drush_is_option('drush')) {
      if (_coder_drush_is_option('checkstyle')) {
        $cache_key .= ':drushcheckstyle';
      }
      elseif (_coder_drush_is_option('xml')) {
        $cache_key .= ':drushxml';
      }
    }
    if (file_exists($filepath = realpath($coder_args['#filename']))) {
      $cache_mtime = filemtime($filepath);
      if ($cache_results = cache_get($cache_key, 'cache_coder')) {
        if ($cache_results->data['mtime'] == $cache_mtime && _coder_modified() < $cache_results->created) {
          return $cache_results->data['results'];
        }
      }
    }
  }
  $results = array(
    '#stats' => array(
      'minor' => 0,
      'normal' => 0,
      'critical' => 0,
      'ignored' => 0,
    ),
  );

  // Skip php include files when the user requested severity is above minor.
  if (isset($coder_args['#php_minor']) && drupal_substr($coder_args['#filename'], -4) == '.php') {
    if ($coder_args['#severity'] > 1) {
      return $results;
    }
  }

  // Read the file.
  if (_coder_read_and_parse_file($coder_args)) {

    // Do all of the code reviews.
    $errors = array();
    foreach ($coder_args['#reviews'] as $review_name => $review) {
      $review['#review_name'] = $review_name;
      if ($result = do_coder_review($coder_args, $review)) {

        // ignored isn't a severity level, but is a stat we need to track.
        foreach (array(
          'critical',
          'normal',
          'minor',
          'ignored',
        ) as $severity_level) {
          if (isset($result['#stats'][$severity_level])) {
            $results['#stats'][$severity_level] += $result['#stats'][$severity_level];
          }
        }
        $errors += $result;
      }
    }

    // Theme the error messages.
    foreach ($errors as $key => $error) {
      if (is_numeric($key)) {
        $results[$key] = theme('coder_warning_msg', $error);
      }
    }

    // Sort the results.
    ksort($results, SORT_NUMERIC);
  }
  else {
    $results[] = theme('coder_warning', t('Could not read the file'), 'critical');
  }

  // Save the results in the cache.
  if (empty($coder_args['#patch']) && empty($coder_args['#test']) && $coder_args['#cache'] && isset($cache_mtime)) {
    $cache_results = array(
      'mtime' => $cache_mtime,
      'results' => $results,
    );
    cache_set($cache_key, $cache_results, 'cache_coder');
  }
  return $results;
}