class Vocabulary

Same name in this branch
  1. 10 core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  2. 10 core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary
Same name in other branches
  1. 9 core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary
  2. 9 core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  3. 9 core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary
  4. 8.9.x core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary
  5. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  6. 8.9.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary
  7. 11.x core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary
  8. 11.x core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
  9. 11.x core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary

Defines the taxonomy vocabulary entity.

Plugin annotation


@ConfigEntityType(
  id = "taxonomy_vocabulary",
  label = @Translation("Taxonomy vocabulary"),
  label_singular = @Translation("vocabulary"),
  label_plural = @Translation("vocabularies"),
  label_collection = @Translation("Taxonomy"),
  label_count = @PluralTranslation(
    singular = "@count vocabulary",
    plural = "@count vocabularies"
  ),
  handlers = {
    "storage" = "Drupal\taxonomy\VocabularyStorage",
    "list_builder" = "Drupal\taxonomy\VocabularyListBuilder",
    "access" = "Drupal\taxonomy\VocabularyAccessControlHandler",
    "form" = {
      "default" = "Drupal\taxonomy\VocabularyForm",
      "reset" = "Drupal\taxonomy\Form\VocabularyResetForm",
      "delete" = "Drupal\taxonomy\Form\VocabularyDeleteForm",
      "overview" = "Drupal\taxonomy\Form\OverviewTerms"
    },
    "route_provider" = {
      "html" = "Drupal\taxonomy\Entity\Routing\VocabularyRouteProvider",
      "permissions" = "Drupal\user\Entity\EntityPermissionsRouteProvider",
    }
  },
  admin_permission = "administer taxonomy",
  collection_permission = "access taxonomy overview",
  config_prefix = "vocabulary",
  bundle_of = "taxonomy_term",
  entity_keys = {
    "id" = "vid",
    "label" = "name",
    "weight" = "weight"
  },
  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",
  },
  config_export = {
    "name",
    "vid",
    "description",
    "weight",
    "new_revision",
  }
)

Hierarchy

Expanded class hierarchy of Vocabulary

68 files declare their use of Vocabulary
ArgumentSummaryTest.php in core/modules/views/tests/src/Kernel/Handler/ArgumentSummaryTest.php
ArgumentValidatorTermNameTest.php in core/modules/taxonomy/tests/src/Kernel/Views/ArgumentValidatorTermNameTest.php
CommentTokenReplaceTest.php in core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php
ConfigTranslationListUiTest.php in core/modules/config_translation/tests/src/Functional/ConfigTranslationListUiTest.php
ContentEntityTest.php in core/modules/migrate_drupal/tests/src/Kernel/Plugin/migrate/source/ContentEntityTest.php

... See full list

42 string references to 'Vocabulary'
DependencyTest::testUninstallDependents in core/modules/forum/tests/src/Functional/Module/DependencyTest.php
Tests attempting to uninstall a module that has installed dependents.
drupal6.php in core/modules/book/tests/fixtures/drupal6.php
A database agnostic dump for testing purposes.
drupal6.php in core/modules/forum/tests/fixtures/drupal6.php
A database agnostic dump for testing purposes.
drupal6.php in core/modules/statistics/tests/fixtures/drupal6.php
A database agnostic dump for testing purposes.
drupal6.php in core/modules/migrate_drupal/tests/fixtures/drupal6.php
A database agnostic dump for testing purposes.

... See full list

File

core/modules/taxonomy/src/Entity/Vocabulary.php, line 64

Namespace

Drupal\taxonomy\Entity
View source
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;
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the
config system already invalidates them.
Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system
already invalidates it.
Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 2
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 3
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityBase::postSave 2
ConfigEntityBundleBase::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create 2
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 5
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 6
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Is entity being created updated or deleted through synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function
Vocabulary::$description protected property Description of the vocabulary.
Vocabulary::$name protected property Name of the vocabulary.
Vocabulary::$new_revision protected property The default revision setting for a vocabulary.
Vocabulary::$vid protected property The taxonomy vocabulary ID.
Vocabulary::$weight protected property The weight of this vocabulary in relation to other vocabularies.
Vocabulary::getDescription public function Returns the vocabulary description. Overrides VocabularyInterface::getDescription
Vocabulary::id public function Gets the identifier. Overrides EntityBase::id
Vocabulary::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides ConfigEntityBundleBase::postDelete
Vocabulary::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides ConfigEntityBase::preDelete
Vocabulary::setNewRevision public function Sets whether a new revision should be created by default. Overrides VocabularyInterface::setNewRevision
Vocabulary::shouldCreateNewRevision public function Gets whether a new revision should be created by default. Overrides RevisionableEntityBundleInterface::shouldCreateNewRevision
VocabularyInterface::HIERARCHY_DISABLED constant Denotes that no term in the vocabulary has a parent.
VocabularyInterface::HIERARCHY_MULTIPLE constant Denotes that one or more terms in the vocabulary have multiple parents.
VocabularyInterface::HIERARCHY_SINGLE constant Denotes that one or more terms in the vocabulary has a single parent.

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