OverviewTerms.php 16.8 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\taxonomy\Form;

5
use Drupal\Core\Entity\EntityManagerInterface;
6 7
use Drupal\Core\Form\FormBase;
use Drupal\Core\Extension\ModuleHandlerInterface;
8
use Drupal\Core\Form\FormStateInterface;
9 10 11
use Drupal\taxonomy\VocabularyInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

12
/**
13 14 15 16 17 18 19 20 21 22 23
 * Provides terms overview form for a taxonomy vocabulary.
 */
class OverviewTerms extends FormBase {

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

24 25 26 27 28 29 30
  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityManagerInterface
   */
  protected $entityManager;

31
  /**
32
   * The term storage handler.
33 34 35 36 37
   *
   * @var \Drupal\taxonomy\TermStorageInterface
   */
  protected $storageController;

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

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

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

90
    $form_state->set(['taxonomy', 'vocabulary'], $taxonomy_vocabulary);
91 92 93 94
    $parent_fields = FALSE;

    $page = $this->getRequest()->query->get('page') ?: 0;
    // Number of terms per page.
95
    $page_increment = $this->config('taxonomy.settings')->get('terms_per_page_admin');
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.
112
    $current_page = [];
113 114

    $delta = 0;
115
    $term_deltas = [];
116
    $tree = $this->storageController->loadTree($taxonomy_vocabulary->id(), 0, NULL, TRUE);
117
    $tree_index = 0;
118 119
    do {
      // In case this tree is completely empty.
120
      if (empty($tree[$tree_index])) {
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
        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.
136
      $term = $tree[$tree_index];
137 138
      if (isset($term->depth) && ($term->depth > 0) && !isset($back_step)) {
        $back_step = 0;
139
        while ($pterm = $tree[--$tree_index]) {
140 141 142
          $before_entries--;
          $back_step++;
          if ($pterm->depth == 0) {
143
            $tree_index--;
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 173 174 175 176
            // 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;
177
    } while (isset($tree[++$tree_index]));
178 179 180 181 182 183 184 185 186 187

    // 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.
188 189
    $user_input = $form_state->getUserInput();
    if (!empty($user_input)) {
190
      // Get the POST order.
191
      $order = array_flip(array_keys($user_input['terms']));
192 193 194 195 196
      // 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.
197 198
        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'];
199 200 201 202 203 204 205
        }
        else {
          unset($current_page[$key]);
        }
      }
    }

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

297
      $form['terms'][$key]['#attributes']['class'] = [];
298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325
      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) {
326
      $form['terms']['#tabledrag'][] = [
327 328 329 330 331 332
        'action' => 'match',
        'relationship' => 'parent',
        'group' => 'term-parent',
        'subgroup' => 'term-parent',
        'source' => 'term-id',
        'hidden' => FALSE,
333 334
      ];
      $form['terms']['#tabledrag'][] = [
335 336 337 338
        'action' => 'depth',
        'relationship' => 'group',
        'group' => 'term-depth',
        'hidden' => FALSE,
339
      ];
340
      $form['terms']['#attached']['library'][] = 'taxonomy/drupal.taxonomy';
341 342 343 344
      $form['terms']['#attached']['drupalSettings']['taxonomy'] = [
        'backStep' => $back_step,
        'forwardStep' => $forward_step,
      ];
345
    }
346
    $form['terms']['#tabledrag'][] = [
347 348 349
      'action' => 'order',
      'relationship' => 'sibling',
      'group' => 'term-weight',
350
    ];
351

352
    if ($taxonomy_vocabulary->getHierarchy() != VocabularyInterface::HIERARCHY_MULTIPLE && count($tree) > 1) {
353 354
      $form['actions'] = ['#type' => 'actions', '#tree' => FALSE];
      $form['actions']['submit'] = [
355 356 357
        '#type' => 'submit',
        '#value' => $this->t('Save'),
        '#button_type' => 'primary',
358 359
      ];
      $form['actions']['reset_alphabetical'] = [
360
        '#type' => 'submit',
361
        '#submit' => ['::submitReset'],
362
        '#value' => $this->t('Reset to alphabetical'),
363
      ];
364 365
    }

366
    $form['pager_pager'] = ['#type' => 'pager'];
367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384
    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.
385 386
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
387
   */
388
  public function submitForm(array &$form, FormStateInterface $form_state) {
389
    // Sort term order based on weight.
390
    uasort($form_state->getValue('terms'), ['Drupal\Component\Utility\SortArray', 'sortByWeightElement']);
391

392
    $vocabulary = $form_state->get(['taxonomy', 'vocabulary']);
393
    // Update the current hierarchy type as we go.
394
    $hierarchy = VocabularyInterface::HIERARCHY_DISABLED;
395

396
    $changed_terms = [];
397
    $tree = $this->storageController->loadTree($vocabulary->id(), 0, NULL, TRUE);
398 399 400 401 402 403 404 405 406

    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']) {
407 408
      if ($term->parents[0] == 0 && $term->getWeight() != $weight) {
        $term->setWeight($weight);
409 410 411
        $changed_terms[$term->id()] = $term;
      }
      $weight++;
412
      $hierarchy = $term->parents[0] != 0 ? VocabularyInterface::HIERARCHY_SINGLE : $hierarchy;
413 414 415 416
      $term = $tree[$weight];
    }

    // Renumber the current page weights and assign any new parents.
417
    $level_weights = [];
418
    foreach ($form_state->getValue('terms') as $tid => $values) {
419 420 421
      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.
422 423
        if ($values['term']['parent'] == 0 && $term->getWeight() != $weight) {
          $term->setWeight($weight);
424 425 426 427
          $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) {
428
          $level_weights[$values['term']['parent']] = isset($level_weights[$values['term']['parent']]) ? $level_weights[$values['term']['parent']] + 1 : 0;
429 430
          if ($level_weights[$values['term']['parent']] != $term->getWeight()) {
            $term->setWeight($level_weights[$values['term']['parent']]);
431 432 433 434
            $changed_terms[$term->id()] = $term;
          }
        }
        // Update any changed parents.
435
        if ($values['term']['parent'] != $term->parents[0]) {
436
          $term->parent->target_id = $values['term']['parent'];
437 438
          $changed_terms[$term->id()] = $term;
        }
439
        $hierarchy = $term->parents[0] != 0 ? VocabularyInterface::HIERARCHY_SINGLE : $hierarchy;
440 441 442 443 444 445 446
        $weight++;
      }
    }

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

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

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

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

}