VocabularyListBuilder.php 5.5 KB
Newer Older
1 2 3 4
<?php

namespace Drupal\taxonomy;

5
use Drupal\Core\Config\Entity\DraggableListBuilder;
6
use Drupal\Core\Entity\EntityInterface;
7 8
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Entity\EntityTypeManagerInterface;
9
use Drupal\Core\Form\FormStateInterface;
10 11
use Drupal\Core\Render\RendererInterface;
use Drupal\Core\Session\AccountInterface;
12
use Drupal\Core\Url;
13
use Symfony\Component\DependencyInjection\ContainerInterface;
14 15

/**
16 17 18
 * Defines a class to build a listing of taxonomy vocabulary entities.
 *
 * @see \Drupal\taxonomy\Entity\Vocabulary
19
 */
20
class VocabularyListBuilder extends DraggableListBuilder {
21 22 23 24 25

  /**
   * {@inheritdoc}
   */
  protected $entitiesKey = 'vocabularies';
26

27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79
  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The entity manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * Constructs a new VocabularyListBuilder object.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   */
  public function __construct(EntityTypeInterface $entity_type, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer = NULL) {
    parent::__construct($entity_type, $entity_type_manager->getStorage($entity_type->id()));

    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static(
      $entity_type,
      $container->get('current_user'),
      $container->get('entity_type.manager'),
      $container->get('renderer')
    );
  }

80 81 82
  /**
   * {@inheritdoc}
   */
83
  public function getFormId() {
84 85 86 87 88 89
    return 'taxonomy_overview_vocabularies';
  }

  /**
   * {@inheritdoc}
   */
90 91
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
92

93
    if (isset($operations['edit'])) {
94
      $operations['edit']['title'] = t('Edit vocabulary');
95
    }
96

97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113
    if ($entity->access('access taxonomy overview')) {
      $operations['list'] = [
        'title' => t('List terms'),
        'weight' => 0,
        'url' => $entity->toUrl('overview-form'),
      ];
    }

    $taxonomy_term_access_control_handler = $this->entityTypeManager->getAccessControlHandler('taxonomy_term');
    if ($taxonomy_term_access_control_handler->createAccess($entity->id())) {
      $operations['add'] = [
        'title' => t('Add terms'),
        'weight' => 10,
        'url' => Url::fromRoute('entity.taxonomy_term.add_form', ['taxonomy_vocabulary' => $entity->id()]),
      ];
    }

114 115 116 117 118 119 120 121 122
    unset($operations['delete']);

    return $operations;
  }

  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
123
    $header['label'] = t('Vocabulary name');
124
    $header['description'] = t('Description');
125

126
    if ($this->currentUser->hasPermission('administer vocabularies') && !empty($this->weightKey)) {
127 128 129
      $header['weight'] = t('Weight');
    }

130
    return $header + parent::buildHeader();
131 132 133 134 135 136
  }

  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
137
    $row['label'] = $entity->label();
138
    $row['description']['data'] = ['#markup' => $entity->getDescription()];
139
    return $row + parent::buildRow($entity);
140 141 142 143 144 145 146
  }

  /**
   * {@inheritdoc}
   */
  public function render() {
    $entities = $this->load();
147 148 149 150
    // If there are not multiple vocabularies, disable dragging by unsetting the
    // weight key.
    if (count($entities) <= 1) {
      unset($this->weightKey);
151
    }
152
    $build = parent::render();
153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171

    // If the weight key was unset then the table is in the 'table' key,
    // otherwise in vocabularies. The empty message is only needed if the table
    // is possibly empty, so there is no need to support the vocabularies key
    // here.
    if (isset($build['table'])) {
      $access_control_handler = $this->entityTypeManager->getAccessControlHandler('taxonomy_vocabulary');
      $create_access = $access_control_handler->createAccess(NULL, NULL, [], TRUE);
      $this->renderer->addCacheableDependency($build['table'], $create_access);
      if ($create_access->isAllowed()) {
        $build['table']['#empty'] = t('No vocabularies available. <a href=":link">Add vocabulary</a>.', [
          ':link' => Url::fromRoute('entity.taxonomy_vocabulary.add_form')->toString()
        ]);
      }
      else {
        $build['table']['#empty'] = t('No vocabularies available.');
      }
    }

172 173 174 175 176 177
    return $build;
  }

  /**
   * {@inheritdoc}
   */
178
  public function buildForm(array $form, FormStateInterface $form_state) {
179
    $form = parent::buildForm($form, $form_state);
180
    $form['vocabularies']['#attributes'] = ['id' => 'taxonomy'];
181
    $form['actions']['submit']['#value'] = t('Save');
182 183 184 185 186 187 188

    return $form;
  }

  /**
   * {@inheritdoc}
   */
189
  public function submitForm(array &$form, FormStateInterface $form_state) {
190
    parent::submitForm($form, $form_state);
191 192 193 194 195

    drupal_set_message(t('The configuration options have been saved.'));
  }

}