casetracker_console.module

<?php
// $Id$

/**
 * @file
 *  Casetracker Console module provides overview of Case Tracker Projects.
 */

include_once('casetracker_console.features.inc');

/**
 * Preprocessor for theme('views_view_table').
 */
function casetracker_console_preprocess_views_view_table(&$vars) {
  $view = $vars['view'];
  if ($view->name != 'casetracker_console') {
    return;
  }
  drupal_add_css(drupal_get_path('module', 'casetracker_console') . '/casetracker_console.css');
  foreach ($vars['rows'] as $key => $row) {
    foreach ($row as $field => $value) {
      if ($field != 'title') {
        $vars['rows'][$key][$field] = _casetracker_console_listing_link($field, $value,  $view->result[$key]->nid, $view);
      }
    }
  }
}

/**
 * Helper function to convert pure counts into a link to the main case listing.
 *
 * If I could find a way to approach this without a hard-coded dependency on
 * how the casetracker_cases view has configured it's path and exposed filters,
 * this would make a cool Views handler, or extension to the casetracker_count
 * handler in CT core.
 *
 * @param $field
 *  The Views key for the field/column.
 * @param $value
 *  The value of the field.
 * @param $pid
 *  The project node id.
 * @param $view
 *  The views object.
 *
 * @return
 *  Converting the value into a link to the casetracker case.
 */
function _casetracker_console_listing_link($field, $value, $pid, $view) {
  static $inactive_states;

  $status = $view->display['default']->display_options['fields'][$field]['type'];
  $status = substr($status, -1);

  $query = array('pid' => $pid);
  if ($field != 'case_count_5') {
    $query['case_status_id'] = $status;
  }
  if (module_exists('atrium_casetracker')) {
    if (empty($inactive_states)) {
      $inactive_states = atrium_casetracker_get_inactive_states();
    }
    if (in_array($status, $inactive_states)) {
      $query['case_status_closed'] = 1;
    }
  }
  return l($value, 'casetracker/filter', array(
    'query' => $query,
    'html' => TRUE,
  ));
}

/**
 * Implementation of hook_context_default_contexts_alter().
 */
function casetracker_console_context_default_contexts_alter(&$contexts) {
  if (module_exists('atrium_casetracker')) {
    $contexts['casetracker_listing']->conditions['views']['values'][] = 'casetracker_console';
  }
}

/**
 * Implementation of hook_views_default_views_alter().
 */
function casetracker_console_views_default_views_alter(&$views) {
  if (module_exists('atrium_casetracker')) {
    _casetracker_console_spaces_filter($views['casetracker_console']);
    _casetracker_console_spaces_access($views['casetracker_console']);
  }
  $total = array_pop($views['casetracker_console']->display['default']->display_options['fields']);
  $statuses = casetracker_realm_load('status');
  $increment = 0;
  foreach ($statuses as $status => $label) {
    _casetracker_console_add_column($status, $label, ++$increment, $views['casetracker_console']);
  }
  $total_id = 'case_count_' . ++$increment;
  $total['id'] = $total_id;
  $views['casetracker_console']->display['default']->display_options['fields'][$total_id] = $total;
}

/**
 * Integrate a View with 'Spaces: Content in current space' filter.
 *
 * @param
 *  View object.
 */
function _casetracker_console_spaces_filter($view) {
  $view->display['default']->display_options['filters']['current'] = array(
    'operator' => 'all',
    'value' => '',
    'group' => '0',
    'exposed' => FALSE,
    'expose' => array(
      'operator' => FALSE,
      'label' => '',
    ),
    'id' => 'current',
    'table' => 'spaces',
    'field' => 'current',
    'relationship' => 'none',
  );
}

/**
 * Integrate a View with the Spaces feature access handler.
 *
 * @param $view
 *  View object.
 */
function _casetracker_console_spaces_access($view) {
  $view->display['default']->display_options['access'] = array(
    'type' => 'spaces_feature',
    'spaces_feature' => 'atrium_casetracker',
    'perm' => 'access content',
  );
}

/**
 * Insert a case status column into the View.
 *
 * @param $state
 *  Case Tracker State ID.
 * @param $label
 *  Human-readable label/name of the CT State.
 * @param $increment
 *  The column counter, used to mark field indeces.
 * @param $view
 *  The View object.
 */
function _casetracker_console_add_column($state, $label, $increment, $view) { 
  $id = 'case_count_' . $increment;
  $view->display['default']->display_options['fields'][$id] = array(
    'label' => $label,
    'alter' => array(
      'alter_text' => 0,
      'text' => '',
      'make_link' => 0,
      'path' => '',
      'link_class' => '',
      'alt' => '',
      'prefix' => '',
      'suffix' => '',
      'target' => '',
      'help' => '',
      'trim' => 0,
      'max_length' => '',
      'word_boundary' => 1,
      'ellipsis' => 1,
      'html' => 0,
      'strip_tags' => 0,
    ),
    'empty' => '',
    'hide_empty' => 0,
    'empty_zero' => 0,
    'type' => 'status-' . $state,
    'exclude' => 0,
    'id' => $id,
    'table' => 'casetracker_case',
    'field' => 'case_count',
    'relationship' => 'none',
  );
}