uuid_bean.features.inc in UUID Features Integration 7

Features UUID integration for BEAN instances.

File

includes/uuid_bean.features.inc

<?php

/**
 * @file
 * Features UUID integration for BEAN instances.
 */

/**
 * Implements hook_features_export_options().
 */
function uuid_bean_features_export_options() {
  $options = array();

  // Check what bean types are enabled for uuid features export.
  $types = array();
  $entity_info = entity_get_info('bean');
  foreach ($entity_info['bundles'] as $key => $value) {
    if (variable_get("uuid_features_entity_bean_{$key}", FALSE)) {
      $types[$key] = $key;
    }
  }
  if (module_exists("bean_uuid") && !empty($types)) {
    $query = db_select('bean', 'n');
    $query
      ->fields('n', array(
      'bid',
      'delta',
      'type',
      'uuid',
    ))
      ->condition('type', $types)
      ->orderBy('type')
      ->orderBy('delta', 'ASC')
      ->addTag('uuid_bean_features_export_options');
    $beans = $query
      ->execute()
      ->fetchAll();
    foreach ($beans as $bean) {
      $options[$bean->uuid] = t('@type: @delta', array(
        '@type' => $bean->type,
        '@delta' => $bean->delta,
      ));
    }
  }
  drupal_alter('uuid_bean_features_export_options', $options);
  return $options;
}

/**
 * Implements hook_features_export().
 */
function uuid_bean_features_export($data, &$export, $module_name = '') {
  $pipe = array();
  $export['dependencies']['bean'] = 'bean';
  $export['dependencies']['bean_uuid'] = 'bean_uuid';
  $export['dependencies']['uuid_features'] = 'uuid_features';
  $bids = entity_get_id_by_uuid('bean', $data);
  foreach ($bids as $uuid => $bid) {

    // Load the bean matching the $bid.
    $query = new EntityFieldQuery();
    $beans = $query
      ->entityCondition('entity_type', 'bean')
      ->propertyCondition('bid', $bid)
      ->range(0, 1)
      ->execute();
    $export['features']['uuid_bean'][$uuid] = $uuid;
    $bean = $beans['bean'][$bid];
    $pipe['bean'][$bean->type] = $bean->type;

    // Check for additional bean plugin module dependencies.
    foreach (module_implements('bean_types') as $module) {
      $result = call_user_func_array($module . '_bean_types', array());
      if (isset($result) && is_array($result)) {
        foreach ($result as $type => $values) {
          if ($type == $bean->type) {
            $export['dependencies'][$module] = $module;
          }
        }
      }
    }

    // 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_uuid_bean_features_export_alter(&$export, &$pipe, $bean).
    $data =& $export;
    $data['__drupal_alter_by_ref']['pipe'] =& $pipe;
    $entity_type = 'bean';
    drupal_alter('uuid_entity_features_export', $entity_type, $data, $bean, $module);
    drupal_alter('uuid_bean_features_export', $data, $bean, $module);
    unset($data['__drupal_alter_by_ref']);
  }
  return $pipe;
}

/**
 * Implements hook_features_export_render().
 */
function uuid_bean_features_export_render($module, $data) {
  $translatables = $code = array();
  $code[] = '  $beans = array();';
  $code[] = '';
  foreach ($data as $uuid) {
    $beans = entity_uuid_load('bean', array(
      $uuid,
    ), array(), TRUE);
    if (!count($beans)) {
      continue;
    }
    $first_bean = reset($beans);

    // Clone entity to avoid changes by reference.
    $export = clone $first_bean;

    // Unset some things that dont need to be exported.
    unset($export->bid);
    unset($export->rdf_mapping);
    unset($export->changed);
    unset($export->vid);

    // Enable file field exports.
    uuid_features_file_field_export($export, 'bean');
    $entity_type = 'bean';
    drupal_alter('uuid_entity_features_export_render', $entity_type, $export, $first_bean, $module);
    drupal_alter('uuid_bean_features_export_render', $export, $first_bean, $module);
    $json = json_encode($export);
    $export_array = json_decode($json, TRUE);
    $code[] = '  $beans[] = ' . features_var_export($export_array, '  ') . ';';
  }
  if (!empty($translatables)) {
    $code[] = features_translatables_export($translatables, '  ');
  }
  $code[] = '  return $beans;';
  $code = implode("\n", $code);
  return array(
    'uuid_features_default_beans' => $code,
  );
}

/**
 * Implements hook_features_revert().
 */
function uuid_bean_features_revert($module) {
  uuid_bean_features_rebuild($module);
}

/**
 * Implements hook_features_rebuild().
 *
 * Rebuilds beans based on UUID from code defaults.
 */
function uuid_bean_features_rebuild($module) {
  $beans = features_get_default('uuid_bean', $module);
  if (!empty($beans)) {

    // Get info about current beans types available in system.
    $entity_info = bean_entity_info();
    $entity_type = 'bean';

    // Loop through the export.
    foreach ($beans as $data) {

      // Double-check that bean can be created/reverted.
      if (!isset($entity_info['bean']['bundles'][$data['type']])) {
        drupal_set_message('Bundle not found for bean of type ' . $data['type'] . '. Bean was not created/reverted.', 'warning');
      }
      else {

        // If this is an update, there will be a by-UUID matching bean.
        // Also update if there's a bean with same delta.
        $uuid_exists = entity_get_id_by_uuid('bean', array(
          $data['uuid'],
        ));
        $delta_exists = FALSE;
        if (!empty($uuid_exists)) {
          $bean = entity_load_single('bean', $uuid_exists[$data['uuid']]);
          foreach ($data as $key => $value) {
            $bean->{$key} = $value;
          }
        }
        elseif ($bean = bean_load_delta($data['delta'])) {
          $delta_exists = TRUE;
          foreach ($data as $key => $value) {
            $bean->{$key} = $value;
          }
        }
        else {

          // Create a new bean.
          $bean = entity_create('bean', $data);
        }
        drupal_alter('uuid_entity_features_rebuild', $entity_type, $bean, $data, $module);

        // Import file fields.
        uuid_features_file_field_import($bean, 'bean');
        if (!empty($delta_exists)) {

          // Overwrite old UUID. This is ugly and drops the very idea of UUID.
          // But the idea of having UUID *and* delta as unique keys is flawed
          // from the very beginning.
          $success = entity_save('bean', $bean);
        }
        else {
          $success = entity_uuid_save('bean', $bean);
        }

        // Old entity_uuid_save() returned NULL, now result of entity_save().
        // This should work with both.
        if ($success === FALSE) {
          drupal_set_message(t('Failed to create %type bean %label', array(
            '%type' => $data['type'],
            '%label' => $data['label'],
          )), 'error');
        }
      }
    }
    module_invoke_all('uuid_entity_features_rebuild_complete', $entity_type, $beans, $module);
  }
}

Functions

Name	Description
uuid_bean_features_export	Implements hook_features_export().
uuid_bean_features_export_options	Implements hook_features_export_options().
uuid_bean_features_export_render	Implements hook_features_export_render().
uuid_bean_features_rebuild	Implements hook_features_rebuild().
uuid_bean_features_revert	Implements hook_features_revert().