OverviewTerms.php 16.8 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\taxonomy\Form\OverviewTerms
 */

namespace Drupal\taxonomy\Form;

10
use Drupal\Core\Entity\EntityManagerInterface;
11 12
use Drupal\Core\Form\FormBase;
use Drupal\Core\Extension\ModuleHandlerInterface;
13
use Drupal\Core\Form\FormStateInterface;
14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
use Drupal\taxonomy\VocabularyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/*
 * Provides terms overview form for a taxonomy vocabulary.
 */
class OverviewTerms extends FormBase {

  /**
   * The module handler service.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

29 30 31 32 33 34 35
  /**
   * The term storage controller.
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $storageController;

36 37 38 39 40
  /**
   * Constructs an OverviewTerms object.
   *
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler service.
41 42
   * @param \Drupal\Core\Entity\EntityManagerInterface $entity_manager
   *   The entity manager service.
43
   */
44
  public function __construct(ModuleHandlerInterface $module_handler, EntityManagerInterface $entity_manager) {
45
    $this->moduleHandler = $module_handler;
46
    $this->storageController = $entity_manager->getStorage('taxonomy_term');
47 48 49 50 51 52 53
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static(
54 55
      $container->get('module_handler'),
      $container->get('entity.manager')
56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73
    );
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'taxonomy_overview_terms';
  }

  /**
   * Form constructor.
   *
   * 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.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
74 75
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
76 77 78 79 80 81
   * @param \Drupal\taxonomy\VocabularyInterface $taxonomy_vocabulary
   *   The vocabulary to display the overview form for.
   *
   * @return array
   *   The form structure.
   */
82
  public function buildForm(array $form, FormStateInterface $form_state, VocabularyInterface $taxonomy_vocabulary = NULL) {
83 84 85
    // @todo Remove global variables when http://drupal.org/node/2044435 is in.
    global $pager_page_array, $pager_total, $pager_total_items;

86
    $form_state->set(['taxonomy', 'vocabulary'], $taxonomy_vocabulary);
87 88 89 90
    $parent_fields = FALSE;

    $page = $this->getRequest()->query->get('page') ?: 0;
    // Number of terms per page.
91
    $page_increment = $this->config('taxonomy.settings')->get('terms_per_page_admin');
92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111
    // Elements shown on this page.
    $page_entries = 0;
    // Elements at the root level before this page.
    $before_entries = 0;
    // Elements at the root level after this page.
    $after_entries = 0;
    // Elements at the root level on this page.
    $root_entries = 0;

    // 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();
112
    $tree = $this->storageController->loadTree($taxonomy_vocabulary->id(), 0, NULL, TRUE);
113
    $tree_index = 0;
114 115
    do {
      // In case this tree is completely empty.
116
      if (empty($tree[$tree_index])) {
117 118 119 120 121 122 123 124 125 126 127 128 129 130 131
        break;
      }
      $delta++;
      // Count entries before the current page.
      if ($page && ($page * $page_increment) > $before_entries && !isset($back_step)) {
        $before_entries++;
        continue;
      }
      // Count entries after the current page.
      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.
132
      $term = $tree[$tree_index];
133 134
      if (isset($term->depth) && ($term->depth > 0) && !isset($back_step)) {
        $back_step = 0;
135
        while ($pterm = $tree[--$tree_index]) {
136 137 138
          $before_entries--;
          $back_step++;
          if ($pterm->depth == 0) {
139
            $tree_index--;
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172
            // Jump back to the start of the root level parent.
            continue 2;
          }
        }
      }
      $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->id()] = isset($term_deltas[$term->id()]) ? $term_deltas[$term->id()] + 1 : 0;
      $key = 'tid:' . $term->id() . ':' . $term_deltas[$term->id()];

      // Keep track of the first term displayed on this page.
      if ($page_entries == 1) {
        $form['#first_tid'] = $term->id();
      }
      // Keep a variable to make sure at least 2 root elements are displayed.
      if ($term->parents[0] == 0) {
        $root_entries++;
      }
      $current_page[$key] = $term;
173
    } while (isset($tree[++$tree_index]));
174 175 176 177 178 179 180 181 182 183

    // 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.
184 185
    $user_input = $form_state->getUserInput();
    if (!empty($user_input)) {
186
      // Get the POST order.
187
      $order = array_flip(array_keys($user_input['terms']));
188 189 190 191 192
      // Update our form with the new order.
      $current_page = array_merge($order, $current_page);
      foreach ($current_page as $key => $term) {
        // Verify this is a term for the current page and set at the current
        // depth.
193 194
        if (is_array($user_input['terms'][$key]) && is_numeric($user_input['terms'][$key]['term']['tid'])) {
          $current_page[$key]->depth = $user_input['terms'][$key]['term']['depth'];
195 196 197 198 199 200 201
        }
        else {
          unset($current_page[$key]);
        }
      }
    }

202
    $errors = $form_state->getErrors();
203
    $destination = $this->getDestinationArray();
204 205 206 207 208
    $row_position = 0;
    // Build the actual form.
    $form['terms'] = array(
      '#type' => 'table',
      '#header' => array($this->t('Name'), $this->t('Weight'), $this->t('Operations')),
209
      '#empty' => $this->t('No terms available. <a href="@link">Add term</a>.', array('@link' => $this->url('entity.taxonomy_term.add_form', array('taxonomy_vocabulary' => $taxonomy_vocabulary->id())))),
210 211 212 213 214
      '#attributes' => array(
        'id' => 'taxonomy',
      ),
    );
    foreach ($current_page as $key => $term) {
215
      /** @var $term \Drupal\Core\Entity\EntityInterface */
216 217 218 219 220 221 222 223 224 225 226
      $form['terms'][$key]['#term'] = $term;
      $indentation = array();
      if (isset($term->depth) && $term->depth > 0) {
        $indentation = array(
          '#theme' => 'indentation',
          '#size' => $term->depth,
        );
      }
      $form['terms'][$key]['term'] = array(
        '#prefix' => !empty($indentation) ? drupal_render($indentation) : '',
        '#type' => 'link',
227
        '#title' => $term->getName(),
228 229
        '#url' => $term->urlInfo(),
      );
230
      if ($taxonomy_vocabulary->getHierarchy() != TAXONOMY_HIERARCHY_MULTIPLE && count($tree) > 1) {
231 232 233 234 235 236 237 238 239 240 241 242
        $parent_fields = TRUE;
        $form['terms'][$key]['term']['tid'] = array(
          '#type' => 'hidden',
          '#value' => $term->id(),
          '#attributes' => array(
            'class' => array('term-id'),
          ),
        );
        $form['terms'][$key]['term']['parent'] = array(
          '#type' => 'hidden',
          // Yes, default_value on a hidden. It needs to be changeable by the
          // javascript.
243
          '#default_value' => $term->parents[0],
244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261
          '#attributes' => array(
            'class' => array('term-parent'),
          ),
        );
        $form['terms'][$key]['term']['depth'] = array(
          '#type' => 'hidden',
          // Same as above, the depth is modified by javascript, so it's a
          // default_value.
          '#default_value' => $term->depth,
          '#attributes' => array(
            'class' => array('term-depth'),
          ),
        );
      }
      $form['terms'][$key]['weight'] = array(
        '#type' => 'weight',
        '#delta' => $delta,
        '#title' => $this->t('Weight for added term'),
262
        '#title_display' => 'invisible',
263
        '#default_value' => $term->getWeight(),
264 265 266 267 268 269
        '#attributes' => array(
          'class' => array('term-weight'),
        ),
      );
      $operations = array(
        'edit' => array(
270
          'title' => $this->t('Edit'),
271
          'query' => $destination,
272 273
          'url' => $term->urlInfo('edit-form'),
        ),
274
        'delete' => array(
275
          'title' => $this->t('Delete'),
276
          'query' => $destination,
277 278
          'url' => $term->urlInfo('delete-form'),
        ),
279
      );
280
      if ($this->moduleHandler->moduleExists('content_translation') && content_translation_translate_access($term)->isAllowed()) {
281
        $operations['translate'] = array(
282
          'title' => $this->t('Translate'),
283
          'query' => $destination,
284 285
          'url' => $term->urlInfo('drupal:content-translation-overview'),
        );
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321
      }
      $form['terms'][$key]['operations'] = array(
        '#type' => 'operations',
        '#links' => $operations,
      );

      $form['terms'][$key]['#attributes']['class'] = array();
      if ($parent_fields) {
        $form['terms'][$key]['#attributes']['class'][] = 'draggable';
      }

      // Add classes that mark which terms belong to previous and next pages.
      if ($row_position < $back_step || $row_position >= $page_entries - $forward_step) {
        $form['terms'][$key]['#attributes']['class'][] = 'taxonomy-term-preview';
      }

      if ($row_position !== 0 && $row_position !== count($tree) - 1) {
        if ($row_position == $back_step - 1 || $row_position == $page_entries - $forward_step - 1) {
          $form['terms'][$key]['#attributes']['class'][] = 'taxonomy-term-divider-top';
        }
        elseif ($row_position == $back_step || $row_position == $page_entries - $forward_step) {
          $form['terms'][$key]['#attributes']['class'][] = 'taxonomy-term-divider-bottom';
        }
      }

      // Add an error class if this row contains a form error.
      foreach ($errors as $error_key => $error) {
        if (strpos($error_key, $key) === 0) {
          $form['terms'][$key]['#attributes']['class'][] = 'error';
        }
      }
      $row_position++;
    }

    if ($parent_fields) {
      $form['terms']['#tabledrag'][] = array(
322 323 324 325 326 327
        'action' => 'match',
        'relationship' => 'parent',
        'group' => 'term-parent',
        'subgroup' => 'term-parent',
        'source' => 'term-id',
        'hidden' => FALSE,
328 329
      );
      $form['terms']['#tabledrag'][] = array(
330 331 332 333
        'action' => 'depth',
        'relationship' => 'group',
        'group' => 'term-depth',
        'hidden' => FALSE,
334
      );
335
      $form['terms']['#attached']['library'][] = 'taxonomy/drupal.taxonomy';
336 337 338 339
      $form['terms']['#attached']['drupalSettings']['taxonomy'] = [
        'backStep' => $back_step,
        'forwardStep' => $forward_step,
      ];
340
    }
341 342 343 344 345
    $form['terms']['#tabledrag'][] = array(
      'action' => 'order',
      'relationship' => 'sibling',
      'group' => 'term-weight',
    );
346

347
    if ($taxonomy_vocabulary->getHierarchy() != TAXONOMY_HIERARCHY_MULTIPLE && count($tree) > 1) {
348 349 350 351 352 353 354 355
      $form['actions'] = array('#type' => 'actions', '#tree' => FALSE);
      $form['actions']['submit'] = array(
        '#type' => 'submit',
        '#value' => $this->t('Save'),
        '#button_type' => 'primary',
      );
      $form['actions']['reset_alphabetical'] = array(
        '#type' => 'submit',
356
        '#submit' => array('::submitReset'),
357 358 359 360
        '#value' => $this->t('Reset to alphabetical'),
      );
    }

361
    $form['pager_pager'] = ['#type' => 'pager'];
362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379
    return $form;
  }

  /**
   * Form submission handler.
   *
   * Rather than using a textfield or weight field, this form depends entirely
   * upon the order of form elements on the page to determine new weights.
   *
   * Because there might be hundreds or thousands of taxonomy terms that need to
   * be ordered, terms are weighted from 0 to the number of terms in the
   * vocabulary, rather than the standard -10 to 10 scale. Numbers are sorted
   * lowest to highest, but are not necessarily sequential. Numbers may be
   * skipped when a term has children so that reordering is minimal when a child
   * is added or removed from a term.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
380 381
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
382
   */
383
  public function submitForm(array &$form, FormStateInterface $form_state) {
384
    // Sort term order based on weight.
385
    uasort($form_state->getValue('terms'), array('Drupal\Component\Utility\SortArray', 'sortByWeightElement'));
386

387
    $vocabulary = $form_state->get(['taxonomy', 'vocabulary']);
388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403
    // Update the current hierarchy type as we go.
    $hierarchy = TAXONOMY_HIERARCHY_DISABLED;

    $changed_terms = array();
    // @todo taxonomy_get_tree needs to be converted to a service and injected.
    //   Will be fixed in http://drupal.org/node/1976298.
    $tree = taxonomy_get_tree($vocabulary->id(), 0, NULL, TRUE);

    if (empty($tree)) {
      return;
    }

    // Build a list of all terms that need to be updated on previous pages.
    $weight = 0;
    $term = $tree[0];
    while ($term->id() != $form['#first_tid']) {
404 405
      if ($term->parents[0] == 0 && $term->getWeight() != $weight) {
        $term->setWeight($weight);
406 407 408
        $changed_terms[$term->id()] = $term;
      }
      $weight++;
409
      $hierarchy = $term->parents[0] != 0 ? TAXONOMY_HIERARCHY_SINGLE : $hierarchy;
410 411 412 413 414
      $term = $tree[$weight];
    }

    // Renumber the current page weights and assign any new parents.
    $level_weights = array();
415
    foreach ($form_state->getValue('terms') as $tid => $values) {
416 417 418
      if (isset($form['terms'][$tid]['#term'])) {
        $term = $form['terms'][$tid]['#term'];
        // Give terms at the root level a weight in sequence with terms on previous pages.
419 420
        if ($values['term']['parent'] == 0 && $term->getWeight() != $weight) {
          $term->setWeight($weight);
421 422 423 424
          $changed_terms[$term->id()] = $term;
        }
        // Terms not at the root level can safely start from 0 because they're all on this page.
        elseif ($values['term']['parent'] > 0) {
425
          $level_weights[$values['term']['parent']] = isset($level_weights[$values['term']['parent']]) ? $level_weights[$values['term']['parent']] + 1 : 0;
426 427
          if ($level_weights[$values['term']['parent']] != $term->getWeight()) {
            $term->setWeight($level_weights[$values['term']['parent']]);
428 429 430 431
            $changed_terms[$term->id()] = $term;
          }
        }
        // Update any changed parents.
432
        if ($values['term']['parent'] != $term->parents[0]) {
433
          $term->parent->target_id = $values['term']['parent'];
434 435
          $changed_terms[$term->id()] = $term;
        }
436
        $hierarchy = $term->parents[0] != 0 ? TAXONOMY_HIERARCHY_SINGLE : $hierarchy;
437 438 439 440 441 442 443
        $weight++;
      }
    }

    // Build a list of all terms that need to be updated on following pages.
    for ($weight; $weight < count($tree); $weight++) {
      $term = $tree[$weight];
444
      if ($term->parents[0] == 0 && $term->getWeight() != $weight) {
445
        $term->parent->target_id = $term->parents[0];
446
        $term->setWeight($weight);
447 448
        $changed_terms[$term->id()] = $term;
      }
449
      $hierarchy = $term->parents[0] != 0 ? TAXONOMY_HIERARCHY_SINGLE : $hierarchy;
450 451 452 453 454 455 456 457
    }

    // Save all updated terms.
    foreach ($changed_terms as $term) {
      $term->save();
    }

    // Update the vocabulary hierarchy to flat or single hierarchy.
458 459
    if ($vocabulary->getHierarchy() != $hierarchy) {
      $vocabulary->setHierarchy($hierarchy);
460 461 462 463 464 465 466 467
      $vocabulary->save();
    }
    drupal_set_message($this->t('The configuration options have been saved.'));
  }

  /**
   * Redirects to confirmation form for the reset action.
   */
468
  public function submitReset(array &$form, FormStateInterface $form_state) {
469
    /** @var $vocabulary \Drupal\taxonomy\VocabularyInterface */
470
    $vocabulary = $form_state->get(['taxonomy', 'vocabulary']);
471
    $form_state->setRedirectUrl($vocabulary->urlInfo('reset-form'));
472 473 474
  }

}