webform_features.features.inc in Webform Features 7.3

Same filename and directory in other branches
7.4 webform_features.features.inc
Webform Features features integration.
File

webform_features.features.inc
View source
<?php

/**
 * @file
 * Webform Features features integration.
 */

/**
 * Implements hook_features_export_options().
 */
function webform_features_export_options() {
  $options = array();
  $types = node_type_get_names();
  $query = db_select('node', 'n')
    ->fields('n', array(
    'nid',
    'title',
    'type',
  ))
    ->condition('type', webform_variable_get('webform_node_types'), 'IN')
    ->orderBy('type', 'ASC')
    ->orderBy('title', 'ASC');
  $query
    ->join('webform', 'w', 'n.nid = w.nid');
  $query
    ->fields('w', array(
    'machine_name',
  ))
    ->isNotNull('machine_name')
    ->condition('machine_name', '', '!=');
  $results = $query
    ->execute()
    ->fetchAll();
  foreach ($results as $result) {
    $options[$result->machine_name] = t('@type: @title', array(
      '@type' => $types[$result->type],
      '@title' => $result->title,
    ));
  }
  return $options;
}

/**
 * Implements hook_features_export().
 */
function webform_features_export($data, &$export, $module) {
  $pipe = array();
  $export['dependencies']['webform'] = 'webform';
  $export['dependencies']['webform_features'] = 'webform_features';
  foreach ($data as $machine_name) {
    $node = webform_features_machine_name_load($machine_name);
    if (empty($node)) {
      continue;
    }
    $pipe['node'][$node->type] = $node->type;
    $export['features']['webform'][$machine_name] = $machine_name;

    // drupal_alter() normally supports just one byref parameter. Using
    // the __drupal_alter_by_ref key, we can store any additional parameters
    // that need to be altered, and they'll be split out into additional params
    // for the hook_*_alter() implementations.  The hook_alter signature is
    // hook_webform_features_export_alter(&$export, &$pipe, $node)
    $data =& $export;
    $data['__drupal_alter_by_ref'] = array(
      &$pipe,
    );
    drupal_alter('webform_features_export', $data, $node);
  }
  return $pipe;
}

/**
 * Implements hook_features_export_render().
 */
function webform_features_export_render($module, $data, $export = NULL) {
  $code = array();
  $code[] = '$webforms = array();';
  foreach ($data as $machine_name) {
    $node = webform_features_machine_name_load($machine_name, TRUE);
    if (empty($node)) {
      continue;
    }
    $export = clone $node;

    // Use date instead of created, in the same format used by node_object_prepare.
    $export->date = format_date($export->created, 'custom', 'Y-m-d H:i:s O');

    // Don't cause conflicts with nid/vid/revision_timestamp/changed fields.
    unset($export->nid);
    unset($export->vid);
    unset($export->changed);
    unset($export->created);
    unset($export->date);
    unset($export->revision_timestamp);
    unset($export->last_comment_timestamp);
    unset($export->webform['nid']);

    // Replace author by its username.
    $author = user_load($export->uid);
    $export->webform_features_author = $author->name;
    $author = user_load($export->revision_uid);
    $export->webform_features_revision_author = $author->name;
    unset($export->uid, $export->revision_uid);

    // Manage components.
    $components_machine_names = array();
    foreach ($export->webform['components'] as $key => $component) {
      $components_machine_names[$component['cid']] = $component['machine_name'];
    }
    $components_array = array();
    foreach ($export->webform['components'] as $key => $component) {
      if (!empty($component['pid'])) {
        $component['parent_machine_name'] = $components_machine_names[$component['pid']];
      }
      unset($component['nid']);
      unset($component['cid']);
      unset($component['pid']);
      $components_array[$component['machine_name']] = $component;
    }
    $export->webform['components'] = $components_array;

    // Manage emails.
    $emails_array = array();
    foreach ($export->webform['emails'] as $key => $email) {

      // Remove IDs.
      unset($email['nid']);
      unset($email['eid']);

      // Handle parameters linked to a component.
      $email['components_machine_names'] = array();
      foreach (array(
        'email',
        'subject',
        'from_name',
        'from_address',
      ) as $field_name) {
        $email['components_machine_names'][$field_name] = FALSE;
        if (is_numeric($email[$field_name])) {
          $email[$field_name] = $components_machine_names[$email[$field_name]];
          $email['components_machine_names'][$field_name] = TRUE;
        }
      }
      $emails_array[] = $email;
    }
    $export->webform['emails'] = $emails_array;

    // Clean file fields to avoid exporting issues
    // Copied from UUID Features uuid_features_file_field_export().
    $fields = field_info_instances('node', $export->type);
    foreach ($fields as $field_instance) {
      $field =& $export->{$field_instance['field_name']};
      $info = field_info_field($field_instance['field_name']);
      if (in_array($info['type'], array(
        'file',
        'image',
      ))) {
        $field = array();
      }
    }

    // The hook_alter signature is:
    // hook_webform_features_export_render_alter(&$export, $node, $module);
    drupal_alter('webform_features_export_render', $export, $node, $module);
    $code[] = "  \$webforms['{$machine_name}'] = " . features_var_export($export) . ";";
  }
  $code[] = "return \$webforms;";
  $code = implode("\n", $code);
  return array(
    'webform_defaults' => $code,
  );
}

/**
 * Implements hook_features_revert().
 */
function webform_features_revert($module) {
  webform_features_rebuild($module);
}

/**
 * Implements hook_features_rebuild().
 */
function webform_features_rebuild($module) {
  $nodes = module_invoke($module, 'webform_defaults');
  if (!empty($nodes)) {
    module_load_include('inc', 'node', 'node.pages');
    module_load_include('inc', 'webform', 'includes/webform.components');
    module_load_include('inc', 'webform', 'includes/webform.emails');
    foreach ($nodes as $data) {
      if (empty($data['webform']) || empty($data['webform']['machine_name'])) {
        continue;
      }
      $webform_machine_name = $data['webform']['machine_name'];
      $node = (object) $data;
      $node->webform['emails'] = array();
      $node->webform['components'] = array();
      node_object_prepare($node);

      // Get the author back if possible.
      $node->uid = 0;
      if (!empty($node->webform_features_author) && ($author = user_load_by_name($node->webform_features_author))) {
        $node->uid = $author->uid;
      }
      $node->revision_uid = 0;
      if (!empty($node->webform_features_revision_author) && ($author = user_load_by_name($node->webform_features_revision_author))) {
        $node->revision_uid = $author->uid;
      }

      // Find the matching machine name, with a fresh cache.
      $existing = webform_features_machine_name_load($webform_machine_name);
      if (empty($existing)) {
        $node = node_submit($node);
        node_save($node);
        $existing = $node;
      }

      // Reinject base properties.
      $node->nid = $existing->nid;
      $node->vid = $existing->vid;
      $node->webform['nid'] = $existing->nid;

      // Manage components.
      $existing_components_machine_names = array();
      foreach ($existing->webform['components'] as $component) {
        $existing_components_machine_names[$component['machine_name']] = $component['cid'];
      }
      _webform_features_rebuild_components($node, $data['webform']['components'], $existing_components_machine_names);

      // Manage emails.
      db_delete('webform_emails')
        ->condition('nid', $node->nid)
        ->execute();
      if (!empty($data['webform']['emails'])) {
        foreach ($data['webform']['emails'] as $email) {
          $email['nid'] = $node->nid;
          foreach (array_filter($email['components_machine_names']) as $field_name => $active) {
            $email[$field_name] = $existing_components_machine_names[$email[$field_name]];
          }
          unset($email['components_machine_names']);
          $email['eid'] = webform_email_insert($email);
          $node->webform['emails'][$email['eid']] = $email;
        }
      }

      // The hook_alter signature is:
      // hook_webform_features_rebuild_alter(&node, $module);
      drupal_alter('webform_features_rebuild', $node, $module);

      // Final save.
      node_save($node);
    }
  }
}

/**
 * Recursively build components.
 */
function _webform_features_rebuild_components($node, $components, $existing_components_machine_names) {
  if (!empty($components)) {

    // First pass, manage parents and new components.
    foreach ($components as $component) {
      $component['cid'] = _webform_features_rebuild_component($node, $components, $existing_components_machine_names, $component);
    }

    // Second pass, attach components to the webform.
    foreach ($components as $component) {
      $node->webform['components'][$component['cid']] = $component;
    }
  }
}

/**
 * Build a component starting by its parent.
 */
function _webform_features_rebuild_component($node, &$components, &$existing_components_machine_names, &$component) {
  $component['pid'] = 0;
  if (!empty($component['parent_machine_name'])) {
    $component['pid'] = _webform_features_rebuild_component($node, $components, $existing_components_machine_names, $components[$component['parent_machine_name']]);
  }
  $component['nid'] = $node->nid;
  if (empty($existing_components_machine_names[$component['machine_name']])) {
    webform_component_insert($component);
    $existing_components_machine_names[$component['machine_name']] = $component['cid'];
  }
  else {
    $component['cid'] = $existing_components_machine_names[$component['machine_name']];
  }
  $components[$component['machine_name']] = $component;
  return $component['cid'];
}
Functions

Name	Description
webform_features_export	Implements hook_features_export().
webform_features_export_options	Implements hook_features_export_options().
webform_features_export_render	Implements hook_features_export_render().
webform_features_rebuild	Implements hook_features_rebuild().
webform_features_revert	Implements hook_features_revert().
_webform_features_rebuild_component	Build a component starting by its parent.
_webform_features_rebuild_components	Recursively build components.
You are here

webform_features.features.inc in Webform Features 7.3

File

Functions

API Navigation
