Class Drupal\taxonomy\Entity\Vocabulary - Source Code

    
        
namespace Drupal\taxonomy\Entity;

use Drupal\Core\Entity\Attribute\ConfigEntityType;
use Drupal\Core\StringTranslation\TranslatableMarkup;
use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\taxonomy\Entity\Routing\VocabularyRouteProvider;
use Drupal\taxonomy\Form\OverviewTerms;
use Drupal\taxonomy\Form\VocabularyDeleteForm;
use Drupal\taxonomy\Form\VocabularyResetForm;
use Drupal\taxonomy\VocabularyAccessControlHandler;
use Drupal\taxonomy\VocabularyForm;
use Drupal\taxonomy\VocabularyInterface;
use Drupal\taxonomy\VocabularyListBuilder;
use Drupal\taxonomy\VocabularyStorage;
use Drupal\user\Entity\EntityPermissionsRouteProvider;

/**
 * Defines the taxonomy vocabulary entity.
 */
#[ConfigEntityType(
  id: 'taxonomy_vocabulary',
  label: new TranslatableMarkup('Taxonomy vocabulary'),
  label_collection: new TranslatableMarkup('Taxonomy'),
  label_singular: new TranslatableMarkup('vocabulary'),
  label_plural: new TranslatableMarkup('vocabularies'),
  config_prefix: 'vocabulary',
  entity_keys: [
    'id' => 'vid',
    'label' => 'name',
    'weight' => 'weight',
  ],
  handlers: [
    'storage' => VocabularyStorage::class,
    'list_builder' => VocabularyListBuilder::class,
    'access' => VocabularyAccessControlHandler::class,
    'form' => [
      'default' => VocabularyForm::class,
      'reset' => VocabularyResetForm::class,
      'delete' => VocabularyDeleteForm::class,
      'overview' => OverviewTerms::class,
    ],
    'route_provider' => [
      'html' => VocabularyRouteProvider::class,
      'permissions' => EntityPermissionsRouteProvider::class,
    ],
  ],
  links: [
    'add-form' => '/admin/structure/taxonomy/add',
    'delete-form' => '/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/delete',
    'reset-form' => '/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/reset',
    'overview-form' => '/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/overview',
    'edit-form' => '/admin/structure/taxonomy/manage/{taxonomy_vocabulary}',
    'entity-permissions-form' => '/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/overview/permissions',
    'collection' => '/admin/structure/taxonomy',
  ],
  admin_permission: 'administer taxonomy',
  collection_permission: 'access taxonomy overview',
  bundle_of: 'taxonomy_term',
  label_count: [
    'singular' => '@count vocabulary',
    'plural' => '@count vocabularies',
  ],
  config_export: [
    'name',
    'vid',
    'description',
    'weight',
    'new_revision',
  ],
)]
class Vocabulary extends ConfigEntityBundleBase implements VocabularyInterface {

  /**
   * The taxonomy vocabulary ID.
   *
   * @var string
   */
  protected $vid;

  /**
   * Name of the vocabulary.
   *
   * @var string
   */
  protected $name;

  /**
   * Description of the vocabulary.
   *
   * @var string|null
   */
  protected $description = NULL;

  /**
   * The weight of this vocabulary in relation to other vocabularies.
   *
   * @var int
   */
  protected $weight = 0;

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->vid;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description ?? '';
  }

  /**
   * The default revision setting for a vocabulary.
   *
   * @var bool
   */
  protected $new_revision = FALSE;

  /**
   * {@inheritdoc}
   */
  public static function preDelete(EntityStorageInterface $storage, array $entities) {
    parent::preDelete($storage, $entities);

    // Only load terms without a parent, child terms will get deleted too.
    $term_storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
    $terms = $term_storage->loadMultiple($storage->getToplevelTids(array_keys($entities)));
    $term_storage->delete($terms);
  }

  /**
   * {@inheritdoc}
   */
  public static function postDelete(EntityStorageInterface $storage, array $entities) {
    parent::postDelete($storage, $entities);

    // Reset caches.
    $storage->resetCache(array_keys($entities));

    if (reset($entities)->isSyncing()) {
      return;
    }

    $vocabularies = [];
    foreach ($entities as $vocabulary) {
      $vocabularies[$vocabulary->id()] = $vocabulary->id();
    }
    // Load all Taxonomy module fields and delete those which use only this
    // vocabulary.
    $field_storages = \Drupal::entityTypeManager()->getStorage('field_storage_config')->loadByProperties(['module' => 'taxonomy']);
    foreach ($field_storages as $field_storage) {
      $modified_storage = FALSE;
      // Term reference fields may reference terms from more than one
      // vocabulary.
      foreach ($field_storage->getSetting('allowed_values') as $key => $allowed_value) {
        if (isset($vocabularies[$allowed_value['vocabulary']])) {
          $allowed_values = $field_storage->getSetting('allowed_values');
          unset($allowed_values[$key]);
          $field_storage->setSetting('allowed_values', $allowed_values);
          $modified_storage = TRUE;
        }
      }
      if ($modified_storage) {
        $allowed_values = $field_storage->getSetting('allowed_values');
        if (empty($allowed_values)) {
          $field_storage->delete();
        }
        else {
          // Update the field definition with the new allowed values.
          $field_storage->save();
        }
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function setNewRevision($new_revision) {
    $this->new_revision = $new_revision;
  }

  /**
   * {@inheritdoc}
   */
  public function shouldCreateNewRevision() {
    return $this->new_revision;
  }

}