class VocabularyListBuilder

Same name and namespace in other branches
  1. 9 core/modules/taxonomy/src/VocabularyListBuilder.php \Drupal\taxonomy\VocabularyListBuilder
  2. 8.9.x core/modules/taxonomy/src/VocabularyListBuilder.php \Drupal\taxonomy\VocabularyListBuilder
  3. 11.x core/modules/taxonomy/src/VocabularyListBuilder.php \Drupal\taxonomy\VocabularyListBuilder

Defines a class to build a listing of taxonomy vocabulary entities.

Hierarchy

Expanded class hierarchy of VocabularyListBuilder

See also

\Drupal\taxonomy\Entity\Vocabulary

File

core/modules/taxonomy/src/VocabularyListBuilder.php, line 21

Namespace

Drupal\taxonomy
View source
class VocabularyListBuilder extends DraggableListBuilder {
  
  /**
   * {@inheritdoc}
   */
  protected $entitiesKey = 'vocabularies';
  
  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;
  
  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;
  
  /**
   * The renderer service.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;
  
  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;
  
  /**
   * 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 type manager service.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger.
   */
  public function __construct(EntityTypeInterface $entity_type, AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, RendererInterface $renderer, MessengerInterface $messenger) {
    parent::__construct($entity_type, $entity_type_manager->getStorage($entity_type->id()));
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
    $this->renderer = $renderer;
    $this->messenger = $messenger;
  }
  
  /**
   * {@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'), $container->get('messenger'));
  }
  
  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'taxonomy_overview_vocabularies';
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDefaultOperations(EntityInterface $entity) {
    $operations = parent::getDefaultOperations($entity);
    if (isset($operations['edit'])) {
      $operations['edit']['title'] = t('Edit vocabulary');
    }
    if (isset($operations['delete'])) {
      $operations['delete']['title'] = $this->t('Delete vocabulary');
    }
    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(),
        ]),
      ];
    }
    return $operations;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildHeader() {
    $header['label'] = t('Vocabulary name');
    $header['description'] = t('Description');
    if ($this->currentUser
      ->hasPermission('administer vocabularies') && !empty($this->weightKey)) {
      $header['weight'] = t('Weight');
    }
    return $header + parent::buildHeader();
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildRow(EntityInterface $entity) {
    $row['label'] = $entity->label();
    $row['description']['data'] = [
      '#markup' => $entity->getDescription(),
    ];
    return $row + parent::buildRow($entity);
  }
  
  /**
   * {@inheritdoc}
   */
  public function render() {
    $entities = $this->load();
    // If there are not multiple vocabularies, disable dragging by unsetting the
    // weight key.
    if (count($entities) <= 1) {
      unset($this->weightKey);
    }
    $build = parent::render();
    // 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.');
      }
    }
    return $build;
  }
  
  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['vocabularies']['#attributes'] = [
      'id' => 'taxonomy',
    ];
    $form['actions']['submit']['#value'] = t('Save');
    return $form;
  }
  
  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this->messenger
      ->addStatus($this->t('The configuration options have been saved.'));
  }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
ConfigEntityListBuilder::$storage protected property The config entity storage class. Overrides EntityListBuilder::$storage
ConfigEntityListBuilder::getStorage public function Gets the config entity storage. Overrides EntityListBuilder::getStorage
ConfigEntityListBuilder::load public function Loads entities of this type from storage for listing. Overrides EntityListBuilder::load 7
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DraggableListBuilder::getWeight protected function Gets the weight of the given entity. Overrides DraggableListBuilderTrait::getWeight
DraggableListBuilder::setWeight protected function Sets the weight of an entity. Overrides DraggableListBuilderTrait::setWeight
DraggableListBuilderTrait::$entities protected property The entities being listed. 1
DraggableListBuilderTrait::$formBuilder protected property The form builder.
DraggableListBuilderTrait::$weightKey protected property Name of the entity&#039;s weight field or FALSE if no field is provided.
DraggableListBuilderTrait::validateForm public function Form validation handler. 2
EntityHandlerBase::$moduleHandler protected property The module handler to invoke hooks on. 5
EntityHandlerBase::moduleHandler protected function Gets the module handler. 5
EntityHandlerBase::setModuleHandler public function Sets the module handler for this handler.
EntityListBuilder::$entityType protected property Information about the entity type.
EntityListBuilder::$entityTypeId protected property The entity type ID.
EntityListBuilder::$limit protected property The number of entities to list per page, or FALSE to list all entities.
EntityListBuilder::buildOperations public function Builds a renderable list of operation links for the entity. 2
EntityListBuilder::ensureDestination protected function Ensures that a destination is present on the given URL. 1
EntityListBuilder::getEntityIds protected function Loads entity IDs using a pager sorted by the entity id. 5
EntityListBuilder::getEntityListQuery protected function Returns a query object for loading entity IDs from the storage.
EntityListBuilder::getOperations public function Provides an array of information to build a list of operation links. Overrides EntityListBuilderInterface::getOperations 3
EntityListBuilder::getTitle protected function Gets the title of the page. 1
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 2
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
VocabularyListBuilder::$currentUser protected property The current user.
VocabularyListBuilder::$entitiesKey protected property The key to use for the form element containing the entities. Overrides DraggableListBuilderTrait::$entitiesKey
VocabularyListBuilder::$entityTypeManager protected property The entity type manager.
VocabularyListBuilder::$messenger protected property The messenger. Overrides MessengerTrait::$messenger
VocabularyListBuilder::$renderer protected property The renderer service.
VocabularyListBuilder::buildForm public function Form constructor. Overrides DraggableListBuilderTrait::buildForm
VocabularyListBuilder::buildHeader public function Builds the header row for the entity listing. Overrides DraggableListBuilderTrait::buildHeader
VocabularyListBuilder::buildRow public function Builds a row for an entity in the entity listing. Overrides DraggableListBuilderTrait::buildRow
VocabularyListBuilder::createInstance public static function Instantiates a new instance of this entity handler. Overrides EntityListBuilder::createInstance
VocabularyListBuilder::getDefaultOperations public function Gets this list&#039;s default operations. Overrides ConfigEntityListBuilder::getDefaultOperations
VocabularyListBuilder::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
VocabularyListBuilder::render public function Builds a listing of entities for the given entity type. Overrides DraggableListBuilderTrait::render
VocabularyListBuilder::submitForm public function Form submission handler. Overrides DraggableListBuilderTrait::submitForm
VocabularyListBuilder::__construct public function Constructs a new VocabularyListBuilder object. Overrides DraggableListBuilder::__construct

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.