You are here

function hs_content_taxonomy_config_form in Hierarchical Select 5.3

Same name and namespace in other branches
  1. 6.3 modules/hs_content_taxonomy.admin.inc \hs_content_taxonomy_config_form()

Form definition; configuration form for Hierarchical Select as the widget for a content_taxonomy field.

Parameters

$content_type_name: Name of a content type. Provides necessary context.

$field_name: Name of a field. Provides necessary context.

1 string reference to 'hs_content_taxonomy_config_form'
hs_content_taxonomy_menu in modules/hs_content_taxonomy.module
Implementation of hook_menu().

File

modules/hs_content_taxonomy.module, line 93
Implementation of the Hierarchical Select API for the Content Taxonomy module.

Code

function hs_content_taxonomy_config_form($content_type_name, $field_name) {
  require_once drupal_get_path('module', 'hierarchical_select') . '/includes/common.inc';
  drupal_add_css(drupal_get_path('module', 'hs_content_taxonomy') . '/hs_content_taxonomy.css');
  $content_type = content_types($content_type_name);
  $field = $content_type['fields'][$field_name];

  // Extract the necessary context from the $field array.
  $vid = $field['vid'];
  $tid = $field['tid'];
  $depth = empty($field['depth']) ? 0 : $field['depth'];

  // Add the Hierarchical Select config form.
  $module = 'hs_content_taxonomy';
  $params = array(
    'vid' => $vid,
    'tid' => $tid,
    'depth' => $depth,
  );
  $config_id = "content-taxonomy-{$field_name}";
  $vocabulary = taxonomy_get_vocabulary($vid);
  $defaults = array(
    // Enable the save_lineage setting by default if the multiple parents
    // vocabulary option is enabled.
    'save_lineage' => (int) ($vocabulary->hierarchy == 2),
    'editability' => array(
      'max_levels' => min($depth, _hs_taxonomy_hierarchical_select_get_depth($vid)),
    ),
  );

  // If this config is being created (not edited), then enable the dropbox if
  // this is a "multiple values" field. This allows for an intuitive
  // transition to a Hierarchical Select widget.
  if (variable_get('hs_config_' . $config_id, FALSE) === FALSE) {
    $defaults['dropbox']['status'] = $field['multiple'];
  }
  $strings = array(
    'hierarchy' => t('vocabulary'),
    'hierarchies' => t('vocabularies'),
    'item' => t('term'),
    'items' => t('terms'),
    'item_type' => t('term type'),
    'entity' => t('node'),
    'entities' => t('nodes'),
  );
  $max_hierarchy_depth = min($depth == 0 ? 9 : $depth, _hs_taxonomy_hierarchical_select_get_depth($vid));
  $preview_is_required = $field['required'];
  $form['hierarchical_select_config'] = hierarchical_select_common_config_form($module, $params, $config_id, $defaults, $strings, $max_hierarchy_depth, $preview_is_required);
  $form['link'] = array(
    '#value' => l('Back to the field configuration', 'admin/content/types/' . $content_type['url_str'] . '/fields/' . $field_name),
    '#prefix' => '<div class="cck-hierarchical-select-back-link">',
    '#suffix' => '</div>',
    '#weight' => -5,
  );
  $form['save'] = array(
    '#type' => 'submit',
    '#value' => t('Save'),
  );

  // Add the the submit handler for the Hierarchical Select config form.
  $parents = array(
    'hierarchical_select_config',
  );
  $form['#submit']['hierarchical_select_common_config_form_submit'] = array(
    $parents,
  );
  $form['#submit']['hs_content_taxonomy_common_config_form_submit'] = array(
    $content_type_name,
    $field_name,
  );
  return $form;
}