You are here

Home » API reference » Webform CiviCRM Integration 7.2

webform_civicrm.module in Webform CiviCRM Integration 7.2

Same filename and directory in other branches
  1. 8.5 webform_civicrm.module
  2. 6.2 webform_civicrm.module
  3. 6 webform_civicrm.module
  4. 7.5 webform_civicrm.module
  5. 7 webform_civicrm.module
  6. 7.3 webform_civicrm.module
  7. 7.4 webform_civicrm.module

Webform CiviCRM Integration Module: Links webform submissions to contacts in a CiviCRM database. @author Coleman Watts

File

webform_civicrm.module
View source 
<?php

/**
 * @file
 * Webform CiviCRM Integration Module:
 * Links webform submissions to contacts in a CiviCRM database.
 * @author Coleman Watts
 */

/**
 * Implements hook_menu().
 */
function webform_civicrm_menu() {
  $items = array();
  $items['node/%webform_menu/civicrm'] = array(
    'title' => 'CiviCRM',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'webform_civicrm_configure_form',
      1,
    ),
    'access callback' => 'webform_civicrm_form_access',
    'access arguments' => array(
      1,
    ),
    'file' => 'webform_civicrm_admin.inc',
    'weight' => 3,
    'type' => MENU_LOCAL_TASK,
  );
  $items['webform-civicrm/js/%'] = array(
    'page callback' => 'webform_civicrm_js_options',
    'file' => 'webform_civicrm_utils.inc',
    'access callback' => TRUE,
    'page arguments' => array(
      2,
    ),
    'type' => MENU_CALLBACK,
  );
  return $items;
}

/**
 * Menu callback to pass the right number of params for this version of Drupal
 */
function webform_civicrm_configure_form($form, &$form_state, $node) {
  return webform_civicrm_configure_form_builder($form, $form_state, $node);
}

/**
 * Access callback to determine if user can see the CiviCRM tab of a webform.
 */
function webform_civicrm_form_access($node) {
  return node_access('update', $node) && user_access('access CiviCRM');
}

/**
 * Implements hook_form_alter().
 */
function webform_civicrm_form_alter(&$form, &$form_state, $form_id) {

  // Alter back-end webform component edit forms
  if ($form_id == 'webform_component_edit_form' && substr($form['form_key']['#default_value'], 0, 7) == 'civicrm') {
    module_load_include('inc', 'webform_civicrm', 'webform_civicrm_admin');
    _webform_civicrm_webform_component_form_alter($form, $form_state);
  }
  elseif (strpos($form_id, 'webform_client_form_') !== FALSE && !empty($form['#node']->webform_civicrm)) {
    module_load_include('inc', 'webform_civicrm', 'webform_civicrm_forms');
    _webform_civicrm_webform_frontend_form_alter($form, $form_state);
  }
}

/**
 * Implements hook_node_load().
 */
function webform_civicrm_node_load($nodes, $types) {
  $db = db_query('SELECT * FROM {webform_civicrm_forms} WHERE nid IN(:nids)', array(
    ':nids' => array_keys($nodes),
  ));
  foreach ($db as $settings) {
    $node =& $nodes[$settings->nid];
    $settings->data = unserialize($settings->data);
    $node->webform_civicrm = (array) $settings;
  }
}

/**
 * Implements hook_node_insert().
 */
function webform_civicrm_node_insert($node) {

  // For compatibility with node_clone module
  if (arg(2) == 'clone') {
    $db = db_query('SELECT * FROM {webform_civicrm_forms} WHERE nid = :nid', array(
      ':nid' => arg(1),
    ));
    foreach ($db as $settings) {
      $settings->nid = $node->nid;
      $settings->data = unserialize($settings->data);
      drupal_write_record('webform_civicrm_forms', $settings);
      return;
    }
  }
}

/**
 * Implements hook_node_delete().
 */
function webform_civicrm_node_delete($node) {
  if (!empty($node->webform)) {
    db_delete('webform_civicrm_forms')
      ->condition('nid', $node->nid)
      ->execute();

    // Submissions have already been deleted from webform_submissions table, so we'll do the opposite of a join to find them
    db_delete('webform_civicrm_submissions')
      ->where('sid NOT IN (SELECT sid FROM {webform_submissions})')
      ->execute();
  }
}

/**
 * Implements hook_theme().
 */
function webform_civicrm_theme() {
  $theme = array(
    // Override webform-results-submissions.tpl.php
    'webform_results_submissions' => array(
      'render element' => 'element',
      'template' => 'webform-results-submissions',
    ),
    'webform_civicrm_options' => array(
      'render element' => 'element',
    ),
  );
  return $theme;
}

/**
 * Implements hook_webform_submission_presave().
 * Initial submission processing - saves contacts.
 */
function webform_civicrm_webform_submission_presave($node, &$submission) {
  if (!empty($node->webform_civicrm)) {
    module_load_include('inc', 'webform_civicrm', 'webform_civicrm_forms');
    webform_civicrm_process_submission($node, $submission, 'presave');
  }
}

/**
 * Implements hook_webform_submission_insert().
 * Final submission processing - saves activity and writes webform_civicrm record.
 */
function webform_civicrm_webform_submission_insert($node, $submission) {
  if (!empty($node->webform_civicrm)) {
    webform_civicrm_process_submission($node, $submission, 'insert');
  }
}

/**
 * Implements hook_webform_submission_update().
 * Final submission processing - saves activity and updates webform_civicrm record.
 */
function webform_civicrm_webform_submission_update($node, $submission) {
  if (!empty($node->webform_civicrm)) {
    webform_civicrm_process_submission($node, $submission, 'update');
  }
}

/**
 * Implements hook_webform_submission_delete().
 */
function webform_civicrm_webform_submission_delete($node, $submission) {
  db_delete('webform_civicrm_submissions')
    ->condition('sid', $submission->sid)
    ->execute();
}

/**
 * Implements hook_webform_submission_load().
 * Add CiviCRM contact info to submission objects.
 */
function webform_civicrm_webform_submission_load(&$submissions) {
  if (empty($submissions)) {
    return;
  }
  $db = db_query('SELECT * FROM {webform_civicrm_submissions} WHERE sid IN (' . implode(',', array_keys($submissions)) . ')');
  $contacts = array();
  foreach ($db as $row) {
    $sid = $row->sid;
    unset($row->sid);
    if ($cid = $row->contact_id) {
      $cid = explode('-', rtrim($cid, '-'));
      unset($cid[0]);
      $row->contact_id = $cid;
      $contacts[$cid[1]] = '';
    }
    $submissions[$sid]->civicrm = (array) $row;
  }
  if ($contacts) {

    // Retrieve contact names and add to submission objects
    civicrm_initialize();
    $sql = 'SELECT id, display_name FROM civicrm_contact WHERE id IN (' . implode(',', array_keys($contacts)) . ')';
    $dao =& CRM_Core_DAO::executeQuery($sql);
    while ($dao
      ->fetch()) {
      $contacts[$dao->id] = $dao->display_name;
    }
    foreach ($submissions as &$s) {
      if (isset($s->civicrm['contact_id'])) {
        $s->civicrm['display_name'] = $contacts[$s->civicrm['contact_id'][1]];
      }
    }
  }
}

/**
 * Implements hook_webform_submission_render_alter().
 * Add display name to title while viewing a submission.
 */
function webform_civicrm_webform_submission_render_alter(&$sub) {
  if (!empty($sub['#submission']->civicrm['display_name']) && empty($sub['#email']) && $sub['#format'] == 'html') {
    drupal_set_title(t('Submission #!num by @name', array(
      '!num' => $sub['#submission']->sid,
      '@name' => $sub['#submission']->civicrm['display_name'],
    )));
  }
}

/**
 * Implements hook_webform_submission_actions().
 * Add links to view contact & activity.
 */
function webform_civicrm_webform_submission_actions($node, $submission) {
  $actions = array();
  if (!empty($node->webform_civicrm) && !empty($submission->civicrm) && webform_results_access($node) && user_access('access CiviCRM')) {
    $data = $submission->civicrm;
    if (!empty($data['display_name'])) {
      $actions['civicrm_action contact_view'] = array(
        'title' => t('View @name', array(
          '@name' => $data['display_name'],
        )),
        'href' => 'civicrm/contact/view',
        'query' => array(
          'reset' => 1,
          'cid' => $data['contact_id'][1],
        ),
      );
    }
    if (!empty($data['activity_id'])) {
      $actions['civicrm_action activity_view'] = array(
        'title' => t('View Activity'),
        'href' => 'civicrm/activity',
        'query' => array(
          'action' => 'view',
          'reset' => 1,
          'cid' => $data['contact_id'][1],
          'id' => $data['activity_id'],
        ),
      );
    }
  }
  return $actions;
}

/**
 * Implements hook_civicrm_merge().
 * Update submission data to reflect new cids when contacts are merged.
 */
function webform_civicrm_civicrm_merge($type, $data, $new_id = NULL, $old_id = NULL, $tables = NULL) {
  if (!empty($new_id) && !empty($old_id) && $type == 'sqls') {
    db_update('webform_civicrm_submissions')
      ->expression('contact_id', 'REPLACE(contact_id, :old, :new)', array(
      ':old' => '-' . $old_id . '-',
      ':new' => '-' . $new_id . '-',
    ))
      ->condition('contact_id', '%-' . $old_id . '-%', 'LIKE')
      ->execute();
  }
}

/**
 * Implements hook_civicrm_post().
 * Update submission data when civicrm data is deleted.
 */
function webform_civicrm_civicrm_post($op, $type, $id, $obj) {
  if ($type === 'Activity' && $op === 'delete') {
    db_update('webform_civicrm_submissions')
      ->fields(array(
      'activity_id' => 0,
    ))
      ->condition('activity_id', $id)
      ->execute();
  }
}

/**
 * FAPI AJAX callback for the configure form.
 */
function webform_civicrm_configure_form_ajax($form, $form_state) {
  return webform_civicrm_aval($form, $form_state['triggering_element']['#ajax']['pathstr']);
}

/**
 * Implements hook_admin_paths().
 */
function webform_civicrm_admin_paths() {
  return array(
    'node/*/civicrm' => TRUE,
  );
}

/**
 * Implements hook_help().
 */
function webform_civicrm_help($section) {
  switch ($section) {
    case 'admin/help#webform_civicrm':

      // Return a line-break version of the module README.txt
      return nl2br(file_get_contents(drupal_get_path('module', 'webform_civicrm') . '/README.txt'));
      break;
  }
}

/**
 * Implements hook_webform_component_presave().
 * Alter form keys when cloning a contact.
 */
function webform_civicrm_webform_component_presave(&$component) {
  if ($c = webform_civicrm_contact_clone_storage()) {
    $component['form_key'] = str_replace($c['old'], $c['new'], $component['form_key']);
  }
}

/**
 * Return a value from nested arrays or objects.
 * @param $haystack: the array to search
 * @param $keys: pass a single key, or multiple keys separated by : to get a nested value
 * @param $default: value to return if given array key does not exist
 * @param $strict: should we use empty or isset to determine if array key exists?
 * @return: found value or default
 */
function webform_civicrm_aval($haystack, $keys, $default = NULL, $strict = FALSE) {
  foreach (explode(':', $keys) as $key) {
    if (is_object($haystack)) {
      $haystack = (array) $haystack;
    }
    if (!is_array($haystack) || !isset($haystack[$key]) || empty($haystack[$key]) && $default !== NULL && !$strict) {
      return $default;
    }
    $haystack = $haystack[$key];
  }

  // $haystack has been reduced down to the item we want
  return $haystack;
}

/**
 * Store info while a clone operation is running.
 */
function webform_civicrm_contact_clone_storage($storage = NULL) {
  static $ret = NULL;
  if ($storage) {
    $ret = $storage;
  }
  return $ret;
}

/**
 * Clone a contact via webform.
 * This submit handler is called when cloning a contact's fieldset
 */
function webform_civicrm_contact_clone($form, $form_state) {
  module_load_include('inc', 'webform_civicrm', 'webform_civicrm_utils');
  $fid = $form['form_key']['#default_value'];
  list($lobo, $old, $ent, $n, $table, $key) = webform_civicrm_explode_key($fid);
  $node = node_load($form['nid']['#value']);
  $settings = $node->webform_civicrm;
  $new = count($settings['data']['contact']) + 1;

  // Clone contact
  $settings['data']['contact'][$new] = $settings['data']['contact'][$old];
  $storage = array(
    'old' => array(
      "civicrm_{$old}_contact_",
    ),
    'new' => array(
      "civicrm_{$new}_contact_",
    ),
  );

  // Clone particpant if registering separately
  if (webform_civicrm_aval($settings['data'], 'participant_reg_type') == 'separate') {
    $settings['data']['participant'][$new] = $settings['data']['participant'][$old];
    $storage['old'][] = "civicrm_{$old}_participant_";
    $storage['new'][] = "civicrm_{$new}_participant_";
  }
  drupal_write_record('webform_civicrm_forms', $settings, 'nid');

  // Store data to rewrite form keys
  webform_civicrm_contact_clone_storage($storage);
}

/**
 * Validation callback for webform submissions.
 */
function webform_civicrm_form_validate($form, &$form_state) {
  module_load_include('inc', 'webform_civicrm', 'webform_civicrm_forms');
  civicrm_initialize();
  require_once 'CRM/Utils/Type.php';
  $node = $form['#node'];
  $values = _webform_client_form_submit_flatten($node, webform_civicrm_aval($form_state, 'values:submitted'));
  $submitted = webform_civicrm_enabled_fields($node, $values);
  _webform_civicrm_form_validate($form['submitted'], $form_state, $submitted);
  if (!empty($node->webform_civicrm['data']['reg_options']['validate']) && !empty($node->webform_civicrm['data']['participant']) && !empty($node->webform_civicrm['data']['participant_reg_type'])) {

    // We need data from all pages to validate events
    if (!empty($form_state['storage']['submitted']) && webform_civicrm_aval($form_state, 'storage:page_num', 1) > 1) {
      $values += $form_state['storage']['submitted'];
      $submitted = webform_civicrm_enabled_fields($node, $values);
    }
    _webform_civicrm_participant_validate($form, $form_state, $submitted);
  }
}

/**
 * Webform submission hooks don't have access to $form_state
 * So this extra submission handler stores it.
 */
function webform_civicrm_storage($form, $form_state = NULL) {
  static $storage = array();

  // During form submission, store data for later
  if (is_array($form) && !empty($form['#node']->nid) && !empty($form_state['storage']['civicrm'])) {
    $storage[$form['#node']->nid] = $form_state['storage']['civicrm'];
  }
  elseif (is_numeric($form)) {
    return webform_civicrm_aval($storage, $form, array());
  }
}

Functions

Namesort descending Description
webform_civicrm_admin_paths Implements hook_admin_paths().
webform_civicrm_aval Return a value from nested arrays or objects.
webform_civicrm_civicrm_merge Implements hook_civicrm_merge(). Update submission data to reflect new cids when contacts are merged.
webform_civicrm_civicrm_post Implements hook_civicrm_post(). Update submission data when civicrm data is deleted.
webform_civicrm_configure_form Menu callback to pass the right number of params for this version of Drupal
webform_civicrm_configure_form_ajax FAPI AJAX callback for the configure form.
webform_civicrm_contact_clone Clone a contact via webform. This submit handler is called when cloning a contact's fieldset
webform_civicrm_contact_clone_storage Store info while a clone operation is running.
webform_civicrm_form_access Access callback to determine if user can see the CiviCRM tab of a webform.
webform_civicrm_form_alter Implements hook_form_alter().
webform_civicrm_form_validate Validation callback for webform submissions.
webform_civicrm_help Implements hook_help().
webform_civicrm_menu Implements hook_menu().
webform_civicrm_node_delete Implements hook_node_delete().
webform_civicrm_node_insert Implements hook_node_insert().
webform_civicrm_node_load Implements hook_node_load().
webform_civicrm_storage Webform submission hooks don't have access to $form_state So this extra submission handler stores it.
webform_civicrm_theme Implements hook_theme().
webform_civicrm_webform_component_presave Implements hook_webform_component_presave(). Alter form keys when cloning a contact.
webform_civicrm_webform_submission_actions Implements hook_webform_submission_actions(). Add links to view contact & activity.
webform_civicrm_webform_submission_delete Implements hook_webform_submission_delete().
webform_civicrm_webform_submission_insert Implements hook_webform_submission_insert(). Final submission processing - saves activity and writes webform_civicrm record.
webform_civicrm_webform_submission_load Implements hook_webform_submission_load(). Add CiviCRM contact info to submission objects.
webform_civicrm_webform_submission_presave Implements hook_webform_submission_presave(). Initial submission processing - saves contacts.
webform_civicrm_webform_submission_render_alter Implements hook_webform_submission_render_alter(). Add display name to title while viewing a submission.
webform_civicrm_webform_submission_update Implements hook_webform_submission_update(). Final submission processing - saves activity and updates webform_civicrm record.