function taxonomy_overview_terms

Form builder for the taxonomy terms overview.

Display a tree of all the terms in a vocabulary, with options to edit each one. The form is made drag and drop by the theme function.

Parameters

Drupal\taxonomy\Plugin\Core\Entity\Vocabulary $vocabulary: The taxonomy vocabulary entity to list terms for.

See also

taxonomy_overview_terms_submit()

theme_taxonomy_overview_terms()

Related topics

File

drupal/core/modules/taxonomy/taxonomy.admin.inc, line 141

Administrative page callbacks for the taxonomy module.

Code

function taxonomy_overview_terms($form, &$form_state, Vocabulary $vocabulary) {
  global $pager_page_array, $pager_total, $pager_total_items;

  // Check for confirmation forms.
  if (isset($form_state['confirm_reset_alphabetical'])) {
    return taxonomy_vocabulary_confirm_reset_alphabetical($form, $form_state, $vocabulary->vid);
  }
  $form_state['taxonomy']['vocabulary'] = $vocabulary;
  $form['#tree'] = TRUE;
  $form['#parent_fields'] = FALSE;
  $page = isset($_GET['page']) ? $_GET['page'] : 0;
  $page_increment = variable_get('taxonomy_terms_per_page_admin', 100);

  // Number of terms per page.
  $page_entries = 0;

  // Elements shown on this page.
  $before_entries = 0;

  // Elements at the root level before this page.
  $after_entries = 0;

  // Elements at the root level after this page.
  $root_entries = 0;

  // Elements at the root level on this page.
  // Terms from previous and next pages are shown if the term tree would have
  // been cut in the middle. Keep track of how many extra terms we show on each
  // page of terms.
  $back_step = NULL;
  $forward_step = 0;

  // An array of the terms to be displayed on this page.
  $current_page = array();
  $delta = 0;
  $term_deltas = array();
  $tree = taxonomy_get_tree($vocabulary->vid, 0, NULL, TRUE);
  $term = current($tree);
  do {

    // In case this tree is completely empty.
    if (empty($term)) {
      break;
    }
    $delta++;

    // Count entries before the current page.
    if ($page && $page * $page_increment > $before_entries && !isset($back_step)) {
      $before_entries++;
      continue;
    }
    elseif ($page_entries > $page_increment && isset($complete_tree)) {
      $after_entries++;
      continue;
    }

    // Do not let a term start the page that is not at the root.
    if (isset($term->depth) && $term->depth > 0 && !isset($back_step)) {
      $back_step = 0;
      while ($pterm = prev($tree)) {
        $before_entries--;
        $back_step++;
        if ($pterm->depth == 0) {
          prev($tree);
          continue 2;

          // Jump back to the start of the root level parent.
        }
      }
    }
    $back_step = isset($back_step) ? $back_step : 0;

    // Continue rendering the tree until we reach the a new root item.
    if ($page_entries >= $page_increment + $back_step + 1 && $term->depth == 0 && $root_entries > 1) {
      $complete_tree = TRUE;

      // This new item at the root level is the first item on the next page.
      $after_entries++;
      continue;
    }
    if ($page_entries >= $page_increment + $back_step) {
      $forward_step++;
    }

    // Finally, if we've gotten down this far, we're rendering a term on this page.
    $page_entries++;
    $term_deltas[$term->tid] = isset($term_deltas[$term->tid]) ? $term_deltas[$term->tid] + 1 : 0;
    $key = 'tid:' . $term->tid . ':' . $term_deltas[$term->tid];

    // Keep track of the first term displayed on this page.
    if ($page_entries == 1) {
      $form['#first_tid'] = $term->tid;
    }

    // Keep a variable to make sure at least 2 root elements are displayed.
    if ($term->parents[0] == 0) {
      $root_entries++;
    }
    $current_page[$key] = $term;
  } while ($term = next($tree));

  // Because we didn't use a pager query, set the necessary pager variables.
  $total_entries = $before_entries + $page_entries + $after_entries;
  $pager_total_items[0] = $total_entries;
  $pager_page_array[0] = $page;
  $pager_total[0] = ceil($total_entries / $page_increment);

  // If this form was already submitted once, it's probably hit a validation
  // error. Ensure the form is rebuilt in the same order as the user submitted.
  if (!empty($form_state['input'])) {
    $order = array_flip(array_keys($form_state['input']));

    // Get the $_POST order.
    $current_page = array_merge($order, $current_page);

    // Update our form with the new order.
    foreach ($current_page as $key => $term) {

      // Verify this is a term for the current page and set at the current depth.
      if (is_array($form_state['input'][$key]) && is_numeric($form_state['input'][$key]['tid'])) {
        $current_page[$key]->depth = $form_state['input'][$key]['depth'];
      }
      else {
        unset($current_page[$key]);
      }
    }
  }
  $destination = drupal_get_destination();

  // Build the actual form.
  foreach ($current_page as $key => $term) {

    // Save the term for the current page so we don't have to load it a second time.
    $form[$key]['#term'] = (array) $term;
    if (isset($term->parents)) {
      $form[$key]['#term']['parent'] = $term->parent = $term->parents[0];
      unset($form[$key]['#term']['parents'], $term->parents);
    }
    $form[$key]['view'] = array(
      '#type' => 'link',
      '#title' => $term
        ->label(),
      '#href' => "taxonomy/term/{$term->tid}",
    );
    if ($vocabulary->hierarchy != TAXONOMY_HIERARCHY_MULTIPLE && count($tree) > 1) {
      $form['#parent_fields'] = TRUE;
      $form[$key]['tid'] = array(
        '#type' => 'hidden',
        '#value' => $term->tid,
      );
      $form[$key]['parent'] = array(
        '#type' => 'hidden',
        // Yes, default_value on a hidden. It needs to be changeable by the javascript.
        '#default_value' => $term->parent,
      );
      $form[$key]['depth'] = array(
        '#type' => 'hidden',
        // Same as above, the depth is modified by javascript, so it's a default_value.
        '#default_value' => $term->depth,
      );
      $form[$key]['weight'] = array(
        '#type' => 'weight',
        '#delta' => $delta,
        '#title_display' => 'invisible',
        '#title' => t('Weight for added term'),
        '#default_value' => $term->weight,
      );
    }
    $operations = array(
      'edit' => array(
        'title' => t('edit'),
        'href' => 'taxonomy/term/' . $term->tid . '/edit',
        'query' => $destination,
      ),
      'delete' => array(
        'title' => t('delete'),
        'href' => 'taxonomy/term/' . $term->tid . '/delete',
        'query' => $destination,
      ),
    );
    if (module_invoke('translation_entity', 'translate_access', $term)) {
      $operations['translate'] = array(
        'title' => t('translate'),
        'href' => 'taxonomy/term/' . $term->tid . '/translations',
        'query' => $destination,
      );
    }
    $form[$key]['operations'] = array(
      '#type' => 'operations',
      '#links' => $operations,
    );
  }
  $form['#total_entries'] = $total_entries;
  $form['#page_increment'] = $page_increment;
  $form['#page_entries'] = $page_entries;
  $form['#back_step'] = $back_step;
  $form['#forward_step'] = $forward_step;
  $form['#empty_text'] = t('No terms available. <a href="@link">Add term</a>.', array(
    '@link' => url('admin/structure/taxonomy/' . $vocabulary->machine_name . '/add'),
  ));
  if ($vocabulary->hierarchy != TAXONOMY_HIERARCHY_MULTIPLE && count($tree) > 1) {
    $form['actions'] = array(
      '#type' => 'actions',
      '#tree' => FALSE,
    );
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => t('Save'),
    );
    $form['actions']['reset_alphabetical'] = array(
      '#type' => 'submit',
      '#value' => t('Reset to alphabetical'),
    );
    $form_state['redirect'] = array(
      current_path(),
      isset($_GET['page']) ? array(
        'query' => array(
          'page' => $_GET['page'],
        ),
      ) : array(),
    );
  }
  return $form;
}