eck.bundle.inc in Entity Construction Kit (ECK) 7

All of the menu, pages, and forms related to bundle administration.

File

eck.bundle.inc

<?php

/**
 * @file
 * All of the menu, pages, and forms related to bundle administration.
 */

/**
 * This function creates the menu items relevant to bundle administration
 *
 * @param $entity_type
 *  (Object) as returned by eck__entity_type__load()
 *
 * This function called is triggered from hook_menu()
 * @see eck_menu()
 */
function eck__bundle__menu($entity_type) {

  // Create the menus relavant to types.
  $menu = array();

  // DELETE ENTITY TYPE
  $menu["admin/structure/eck/{$entity_type->name}/delete"] = array(
    'title' => "Delete a(n) '{$entity_type->label}'",
    'description' => "Delete the '{$entity_type->label}' Entity Type",
    'page callback' => "drupal_get_form",
    //"eck__entity_type__delete",
    'page arguments' => array(
      "eck__entity_type__delete_form",
      $entity_type,
    ),
    'access arguments' => array(
      "delete {$entity_type->name} entity type",
    ),
    'file' => 'eck.entity_type.inc',
  );
  $menu["admin/structure/eck/{$entity_type->name}/list"] = array(
    'title' => 'List',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );

  // $entity_type_object = eck__entity_type_load($entity_type);
  $menu["admin/structure/eck/{$entity_type->name}/edit"] = array(
    'title' => "Edit {$entity_type->label}",
    'description' => "Edit the '{$entity_type->label}' entity type",
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      "eck__entity_type__form",
      $entity_type->name,
    ),
    'access arguments' => array(
      "edit {$entity_type->name} entity type",
    ),
    'file' => 'eck.entity_type.inc',
    'type' => MENU_LOCAL_TASK,
  );

  // OVERVIEW Entity types.
  $menu["admin/structure/eck/{$entity_type->name}"] = array(
    'title' => "{$entity_type->label} Bundles",
    'description' => "View all the bundles for '{$entity_type->label}'",
    'page callback' => "eck__bundle__overview",
    'page arguments' => array(
      $entity_type,
    ),
    'access arguments' => array(
      "administer {$entity_type->name} bundles",
    ),
    'weight' => 0,
    'file' => 'eck.bundle.inc',
  );
  $menu["admin/structure/eck/{$entity_type->name}/add"] = array(
    'title' => "Add a(n) '{$entity_type->label}' Bundle ",
    'description' => "Add a(n) new '{$entity_type->label} Bundle'",
    'page callback' => "drupal_get_form",
    'page arguments' => array(
      'eck__bundle__add',
      $entity_type,
    ),
    'access arguments' => array(
      "add {$entity_type->name} bundles",
    ),
    'type' => MENU_LOCAL_ACTION,
    'weight' => 1,
    'file' => 'eck.bundle.inc',
  );
  module_load_include('inc', 'eck', 'eck.entity');
  foreach (eck__bundle__load($entity_type->name) as $bundle) {
    $menu = array_merge($menu, eck__entity__menu($entity_type, $bundle));
  }
  return $menu;
}

/**
 * Get all the bundles for a given entity_type.
 * @param $entity_type_name
 *   (String) the name of an entity type
 */
function eck__bundle__load($entity_type_name = NULL) {
  $query = db_select('eck_bundle', 't')
    ->fields('t');
  if ($entity_type_name) {
    $query
      ->condition('entity_type', $entity_type_name);
  }
  $data = $query
    ->execute();
  $bundles = array();
  foreach ($data as $bundle) {
    $bundles[] = $bundle;
  }
  return $bundles;
}

/**
 * Page call back for the bundle overview table (to see and manipulate all created label of
 * a given type)
 *
 * @param entity_type
 *  (String) entity type
 */
function eck__bundle__overview($entity_type) {
  module_load_include('inc', 'eck', 'eck.entity');
  $header = array(
    t('Type'),
    array(
      'data' => t('Operations'),
      'colspan' => '1',
    ),
  );
  $rows = array();
  foreach (eck__bundle__load($entity_type->name) as $bundle) {
    $bundle_label = $bundle->label;
    $admin_info = get_bundle_admin_info($entity_type->name, $bundle->name);
    $uri = $admin_info['path'];
    $rows[] = array(
      l($bundle_label, url($uri, array(
        'absolute' => TRUE,
      ))),
      l("delete", $uri . "/delete"),
    );
  }
  $build['bundle_table'] = array(
    '#theme' => 'table',
    '#header' => $header,
    '#rows' => $rows,
  );
  $build['sample_code'] = array(
    '#theme' => 'form_element',
    '#title' => t('Optional entity class'),
    '#description' => t('You may add this custom class the entity. To create a new instance of this class programmatically call: %code', array(
      '%code' => "entity_create('{$entity_type->name}', array());",
    )),
    '#children' => "<pre>" . check_plain("class " . eck_get_class_name($entity_type->name, 'EntityType') . " extends Entity{\n\n}") . "</pre>",
  );
  return $build;
}

/**
 * ADD Entity types.
 *
 * @param $form
 *  Form array provided by the Form API
 * @param $form_state
 *  array provided by the Form API
 * @param entity_type
 *  (String) entity type
 */
function eck__bundle__add($form, &$form_state, $entity_type) {
  $form['entity_type_name'] = array(
    '#type' => 'value',
    '#value' => $entity_type->name,
  );
  $form['bundle_label'] = array(
    '#type' => 'textfield',
    '#title' => "Type",
    '#description' => "A Human readable name for the bundle",
  );
  $form['bundle_name'] = array(
    '#type' => 'machine_name',
    '#required' => FALSE,
    '#machine_name' => array(
      'exists' => '_eck_fake_exists',
      'source' => array(
        'bundle_label',
      ),
    ),
  );
  $form['#validate'][] = 'eck__bundle__add_validate';
  $form['submit'] = array(
    '#type' => 'submit',
    '#weight' => 10000,
    '#value' => t('Save'),
  );
  return $form;
}

/**
 * Validation for bundle creation (Make sure this bundle don't exist for thie entity type)
 *
 * @param $form
 *  Form array provided by the Form API
 * @param $form_state
 *  array provided by the Form API
 */
function eck__bundle__add_validate($form, &$form_state) {
  $entity_type_name = $form_state['values']['entity_type_name'];

  // The type does not have to be unique in the table, but it should be unique
  // to its entity so we will check that here.
  foreach (eck__bundle__load($entity_type_name) as $bundle) {
    if ($bundle->name == $form_state['values']['bundle_name']) {
      form_set_error('bundle', t("bundle '{$bundle->name} already exists for this entity"));
    }
  }
}

/**
 * Submit function for add form
 *
 * @param $form
 *  Form array provided by the Form API
 * @param $form_state
 *  array provided by the Form API
 */
function eck__bundle__add_submit($form, &$form_state) {
  $entity_type_name = $form_state['values']['entity_type_name'];
  $bundle_name = $form_state['values']['bundle_name'];
  $bundle_label = $form_state['values']['bundle_label'];
  db_insert('eck_bundle')
    ->fields(array(
    'entity_type' => $entity_type_name,
    'name' => $bundle_name,
    'label' => $bundle_label,
  ))
    ->execute();
  drupal_set_message(t('the %bundle for entity type %entity_type has been saved', array(
    '%bundle' => $bundle_name,
    '%entity_type' => $entity_type_name,
  )));
  drupal_get_schema(NULL, TRUE);
  entity_info_cache_clear();
  menu_rebuild();
  drupal_goto("admin/structure/eck/{$entity_type_name}/{$bundle_name}");
}

/**
 * Delete the bundle of a given entity type
 * @param $entity_type
 *  (String) The entity type of the bundle that will be deleted
 * @param  $bundle
 *  (String) The bundle to be deleted
 */
function eck__bundle__delete($entity_type, $bundle) {

  //first delete all of the entities of this bundle
  $query = new EntityFieldQuery();
  $query
    ->entityCondition('entity_type', $entity_type->name, '=')
    ->entityCondition('bundle', $bundle->name, '=');
  $results = $query
    ->execute();
  if (!empty($results)) {
    $ids = array_keys($results[$entity_type->name]);
    entity_delete($entity_type->name, $ids);
  }

  //then we delete the bundle (field_instances)
  field_attach_delete_bundle($entity_type->name, $bundle->name);

  //and finally we delete the bundle from the eck_type table
  db_delete('eck_bundle')
    ->condition('entity_type', $entity_type->name)
    ->condition('name', $bundle->name)
    ->execute();
  menu_rebuild();
  drupal_flush_all_caches();
  drupal_set_message("The bundle '{$bundle->name}' from the entity type '{$entity_type->name}' has been deleted");

  //return "<h1>Deletion Completed</h1>

  //<h3>The bundle '{$bundle}' from the entity type '$entity_type' has been deleted<h3>";
}
function eck__bundle__delete_form($form, &$form_state, $entity_type, $bundle) {
  $form['entity_type'] = array(
    '#type' => 'value',
    '#value' => $entity_type,
  );
  $form['bundle'] = array(
    '#type' => 'value',
    '#value' => $bundle,
  );
  $form['submit_redirect'] = array(
    '#type' => 'value',
    '#value' => "admin/structure/eck/{$entity_type->name}",
  );
  $message = t("Are you sure that you want to delete the bundle '{$bundle->name}'");
  $caption = t("All of the data (entities) associated with this bundle\n  will be deleted. This action cannot be undone.");
  return confirm_form($form, $message, "admin/structure/eck/{$entity_type->name}", $caption, t('Delete'));
}

/**
 * Sumbmit function for the delete functionality
 *
 * @param $form
 *  Form array provided by the Form API
 * @param $form_state
 *  array provided by the Form API
 */
function eck__bundle__delete_form_submit($form, &$form_state) {
  $entity_type = $form_state['values']['entity_type'];
  $bundle = $form_state['values']['bundle'];
  $submit_redirect = $form_state['values']['submit_redirect'];
  eck__bundle__delete($entity_type, $bundle);

  // Ok, lets delete the entity
  $form_state['redirect'] = $submit_redirect;
}
function eck__bundle__field_autocomplete($entity_type, $bundle, $string = "") {
  $field_label = get_bundle_field_label_info($entity_type, $bundle);
  $matches = array();
  if ($field_label) {
    $field = $field_label['field'];
    $language = $field_label['language'];
    $delta = $field_label['delta'];
    $column = $field_label['column'];
    $query = new EntityFieldQuery();
    $query
      ->entityCondition('entity_type', $entity_type->name, '=')
      ->entityCondition('bundle', $bundle->name, '=')
      ->fieldCondition($field, $column, $string, 'CONTAINS');
    $results = $query
      ->execute();
    $entities = entity_load($entity_type->name, array_keys($results[$entity_type->name]));
    foreach ($entities as $id => $entity) {
      $matches[$id] = $entity->{$field}[$language][$delta][$column];
    }
  }
  drupal_json_output($matches);
}
function get_bundle_field_label_info($entity_type, $bundle) {
  $info = entity_get_info();
  if (array_key_exists('field label', $info[$entity_type->name]['bundles'][$bundle->name])) {
    return $info[$entity_type->name]['bundles'][$bundle->name]['field label'];
  }
  else {
    return NULL;
  }
}

Functions

Name	Description
eck__bundle__add	ADD Entity types.
eck__bundle__add_submit	Submit function for add form
eck__bundle__add_validate	Validation for bundle creation (Make sure this bundle don't exist for thie entity type)
eck__bundle__delete	Delete the bundle of a given entity type
eck__bundle__delete_form
eck__bundle__delete_form_submit	Sumbmit function for the delete functionality
eck__bundle__field_autocomplete
eck__bundle__load	Get all the bundles for a given entity_type.
eck__bundle__menu	This function creates the menu items relevant to bundle administration
eck__bundle__overview	Page call back for the bundle overview table (to see and manipulate all created label of a given type)
get_bundle_field_label_info