class Vocabulary in Zircon Profile 8

Same name in this branch

8 core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary
8 core/modules/taxonomy/src/Plugin/migrate/source/d6/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d6\Vocabulary
8 core/modules/taxonomy/src/Plugin/migrate/source/d7/Vocabulary.php \Drupal\taxonomy\Plugin\migrate\source\d7\Vocabulary

Same name and namespace in other branches

8.0 core/modules/taxonomy/src/Entity/Vocabulary.php \Drupal\taxonomy\Entity\Vocabulary

Defines the taxonomy vocabulary entity.

Plugin annotation


@ConfigEntityType(
  id = "taxonomy_vocabulary",
  label = @Translation("Taxonomy vocabulary"),
  handlers = {
    "storage" = "Drupal\taxonomy\VocabularyStorage",
    "list_builder" = "Drupal\taxonomy\VocabularyListBuilder",
    "form" = {
      "default" = "Drupal\taxonomy\VocabularyForm",
      "reset" = "Drupal\taxonomy\Form\VocabularyResetForm",
      "delete" = "Drupal\taxonomy\Form\VocabularyDeleteForm"
    }
  },
  admin_permission = "administer taxonomy",
  config_prefix = "vocabulary",
  bundle_of = "taxonomy_term",
  entity_keys = {
    "id" = "vid",
    "label" = "name",
    "weight" = "weight"
  },
  links = {
    "add-form" = "/admin/structure/taxonomy/manage/{taxonomy_vocabulary}/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}",
    "collection" = "/admin/structure/taxonomy",
  },
  config_export = {
    "name",
    "vid",
    "description",
    "hierarchy",
    "weight",
  }
)

Hierarchy

class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses PluginDependencyTrait
  - class \Drupal\Core\Config\Entity\ConfigEntityBundleBase
    class \Drupal\taxonomy\Entity\Vocabulary implements VocabularyInterface

Expanded class hierarchy of Vocabulary

24 files declare their use of Vocabulary

EntityCrudHookTest.php in core/modules/system/src/Tests/Entity/EntityCrudHookTest.php: Contains \Drupal\system\Tests\Entity\EntityCrudHookTest.
EntityQueryTest.php in core/modules/system/src/Tests/Entity/EntityQueryTest.php: Contains \Drupal\system\Tests\Entity\EntityQueryTest.
EntityReferenceAdminTest.php in core/modules/field/src/Tests/EntityReference/EntityReferenceAdminTest.php: Contains \Drupal\field\Tests\EntityReference\EntityReferenceAdminTest.
EntityReferenceItemTest.php in core/modules/field/src/Tests/EntityReference/EntityReferenceItemTest.php: Contains \Drupal\field\Tests\EntityReference\EntityReferenceItemTest.
EntityReferenceSettingsTest.php in core/modules/field/src/Tests/EntityReference/EntityReferenceSettingsTest.php: Contains \Drupal\field\Tests\EntityReference\EntityReferenceSettingsTest.

... See full list

6 string references to 'Vocabulary'

taxonomy.schema.yml in core/modules/taxonomy/config/schema/taxonomy.schema.yml: core/modules/taxonomy/config/schema/taxonomy.schema.yml
taxonomy.views.schema.yml in core/modules/taxonomy/config/schema/taxonomy.views.schema.yml: core/modules/taxonomy/config/schema/taxonomy.views.schema.yml
TaxonomyIndexTid::buildExtraOptionsForm in core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTid.php: Provide a form for setting options.
TaxonomyMenuForm::form in modules/taxonomy_menu/src/Form/TaxonomyMenuForm.php: Gets the actual form array to be built.
taxonomy_menu.schema.yml in modules/taxonomy_menu/config/schema/taxonomy_menu.schema.yml: modules/taxonomy_menu/config/schema/taxonomy_menu.schema.yml

... See full list

File

core/modules/taxonomy/src/Entity/Vocabulary.php, line 54: Contains \Drupal\taxonomy\Entity\Vocabulary.

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
   */
  protected $description;

  /**
   * The type of hierarchy allowed within the vocabulary.
   *
   * Possible values:
   * - TAXONOMY_HIERARCHY_DISABLED: No parents.
   * - TAXONOMY_HIERARCHY_SINGLE: Single parent.
   * - TAXONOMY_HIERARCHY_MULTIPLE: Multiple parents.
   *
   * @var integer
   */
  protected $hierarchy = TAXONOMY_HIERARCHY_DISABLED;

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

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

  /**
   * {@inheritdoc}
   */
  public function setHierarchy($hierarchy) {
    $this->hierarchy = $hierarchy;
    return $this;
  }

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

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

  /**
   * {@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.
    entity_delete_multiple('taxonomy_term', $storage
      ->getToplevelTids(array_keys($entities)));
  }

  /**
   * {@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 = array();
    foreach ($entities as $vocabulary) {
      $vocabularies[$vocabulary
        ->id()] = $vocabulary
        ->id();
    }

    // Load all Taxonomy module fields and delete those which use only this
    // vocabulary.
    $field_storages = entity_load_multiple_by_properties('field_storage_config', array(
      '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();
        }
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityBase::$isSyncing	private	property	Whether the config is being created, updated or deleted through the import process.
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::$pluginConfigKey	protected	property	The name of the property that is used to store plugin configuration.
ConfigEntityBase::$status	protected	property	The enabled/disabled status of the configuration entity.	2
ConfigEntityBase::$third_party_settings	protected	property	Third party entity settings.
ConfigEntityBase::$trustedData	protected	property	Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid	protected	property	The UUID for this entity.
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	12
ConfigEntityBase::createDuplicate	public	function	Creates a duplicate of the entity. Overrides Entity::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 Entity::getCacheTagsToInvalidate	1
ConfigEntityBase::getConfigDependencyName	public	function	Gets the configuration dependency name. Overrides Entity::getConfigDependencyName
ConfigEntityBase::getConfigManager	protected static	function	Gets the configuration manager.
ConfigEntityBase::getConfigTarget	public	function	Gets the configuration target identifier for the entity. Overrides Entity::getConfigTarget
ConfigEntityBase::getDependencies	public	function	Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId	public	function	Gets the original ID. Overrides Entity::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 Entity::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave	protected	function	Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides Entity::invalidateTagsOnSave
ConfigEntityBase::isInstallable	public	function	Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable	2
ConfigEntityBase::isNew	public	function	Overrides Entity::isNew(). Overrides Entity::isNew
ConfigEntityBase::isSyncing	public	function	Returns whether this entity is being changed as part of an import process. Overrides ConfigEntityInterface::isSyncing
ConfigEntityBase::isUninstalling	public	function	Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link	public	function	Deprecated way of generating a link to the entity. See toLink(). Overrides Entity::link
ConfigEntityBase::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval	4
ConfigEntityBase::save	public	function	Saves an entity permanently. Overrides Entity::save	1
ConfigEntityBase::set	public	function	Sets the value of a property. Overrides ConfigEntityInterface::set	1
ConfigEntityBase::setOriginalId	public	function	Sets the original ID. Overrides Entity::setOriginalId
ConfigEntityBase::setStatus	public	function	Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus	1
ConfigEntityBase::setSyncing	public	function	Sets the status of the isSyncing flag. Overrides ConfigEntityInterface::setSyncing
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	2
ConfigEntityBase::toArray	public	function	Gets an array of all property values. Overrides Entity::toArray	2
ConfigEntityBase::toUrl	public	function	Gets the URL object for the entity. Overrides Entity::toUrl
ConfigEntityBase::trustData	public	function	Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData	1
ConfigEntityBase::unsetThirdPartySetting	public	function	Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url	public	function	Gets the public URL for this entity. Overrides Entity::url
ConfigEntityBase::urlInfo	public	function	Gets the URL object for the entity. Overrides Entity::urlInfo
ConfigEntityBase::__construct	public	function	Constructs an Entity object. Overrides Entity::__construct	10
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 Entity::postSave	2
ConfigEntityBundleBase::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	1
DependencySerializationTrait::__wakeup	public	function		2
DependencyTrait::$dependencies	protected	property	The object's dependencies.	1
DependencyTrait::addDependencies	protected	function	Adds multiple dependencies.
DependencyTrait::addDependency	protected	function	Adds a dependency. Aliased as: addDependencyTrait
Entity::$enforceIsNew	protected	property	Boolean indicating whether the entity should be forced to be new.
Entity::$entityTypeId	protected	property	The entity type.
Entity::$typedData	protected	property	A typed data object wrapping this entity.
Entity::access	public	function	Checks data value access. Overrides AccessibleInterface::access	1
Entity::bundle	public	function	Gets the bundle of the entity. Overrides EntityInterface::bundle	1
Entity::create	public static	function	Overrides EntityInterface::create
Entity::delete	public	function	Deletes an entity permanently. Overrides EntityInterface::delete	2
Entity::enforceIsNew	public	function	Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
Entity::entityManager Deprecated	protected	function	Gets the entity manager.
Entity::entityTypeManager	protected	function	Gets the entity type manager.
Entity::getCacheContexts	public	function	The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts
Entity::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge
Entity::getCacheTags	public	function	The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags
Entity::getConfigDependencyKey	public	function	Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
Entity::getEntityType	public	function	Gets the entity type definition. Overrides EntityInterface::getEntityType
Entity::getEntityTypeId	public	function	Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
Entity::getTypedData	public	function	Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
Entity::hasLinkTemplate	public	function	Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
Entity::label	public	function	Gets the label of the entity. Overrides EntityInterface::label	5
Entity::language	public	function	Gets the language of the entity. Overrides EntityInterface::language	1
Entity::languageManager	protected	function	Gets the language manager.
Entity::linkTemplates	protected	function	Gets an array link templates.	1
Entity::load	public static	function	Overrides EntityInterface::load
Entity::loadMultiple	public static	function	Overrides EntityInterface::loadMultiple
Entity::postCreate	public	function	Acts on an entity after it is created but before hooks are invoked. Overrides EntityInterface::postCreate	4
Entity::postLoad	public static	function	Acts on loaded entities. Overrides EntityInterface::postLoad	2
Entity::preCreate	public static	function	Changes the values of an entity before it is created. Overrides EntityInterface::preCreate	6
Entity::referencedEntities	public	function	Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities	1
Entity::toLink	public	function	Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
Entity::uriRelationships	public	function	Returns a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
Entity::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
Entity::uuid	public	function	Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid	1
Entity::uuidGenerator	protected	function	Gets the UUID generator.
Entity::__sleep	public	function		5
PluginDependencyTrait::calculatePluginDependencies	protected	function	Calculates and adds dependencies of a specific plugin instance.	1
RefinableCacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
RefinableCacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
RefinableCacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
Vocabulary::$description	protected	property	Description of the vocabulary.
Vocabulary::$hierarchy	protected	property	The type of hierarchy allowed within the vocabulary.
Vocabulary::$name	protected	property	Name of the 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::getHierarchy	public	function	Returns the vocabulary hierarchy. Overrides VocabularyInterface::getHierarchy
Vocabulary::id	public	function	Gets the identifier. Overrides Entity::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::setHierarchy	public	function	Sets the vocabulary hierarchy. Overrides VocabularyInterface::setHierarchy

You are here

class Vocabulary in Zircon Profile 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation