class ConfigEntityBundleBase
Same name in other branches
- 9 core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- 8.9.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php \Drupal\Core\Config\Entity\ConfigEntityBundleBase
- 11.x core/lib/Drupal/Core/Config/Entity/ConfigEntityBundleBase.php \Drupal\Core\Config\Entity\ConfigEntityBundleBase
A base class for config entity types that act as bundles.
Entity types that want to use this base class must use bundle_of in their annotation to specify for which entity type they are providing bundles for.
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBundleBase extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase extends \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait
Expanded class hierarchy of ConfigEntityBundleBase
9 files declare their use of ConfigEntityBundleBase
- BlockContentType.php in core/
modules/ block_content/ src/ Entity/ BlockContentType.php - CommentType.php in core/
modules/ comment/ src/ Entity/ CommentType.php - ContactForm.php in core/
modules/ contact/ src/ Entity/ ContactForm.php - EntityTestBundle.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Entity/ EntityTestBundle.php - EntityTestMulBundle.php in core/
modules/ system/ tests/ modules/ entity_test/ src/ Entity/ EntityTestMulBundle.php
File
-
core/
lib/ Drupal/ Core/ Config/ Entity/ ConfigEntityBundleBase.php, line 14
Namespace
Drupal\Core\Config\EntityView source
abstract class ConfigEntityBundleBase extends ConfigEntityBase {
/**
* Deletes display if a bundle is deleted.
*/
protected function deleteDisplays() {
// Remove entity displays of the deleted bundle.
if ($displays = $this->loadDisplays('entity_view_display')) {
$storage = $this->entityTypeManager()
->getStorage('entity_view_display');
$storage->delete($displays);
}
// Remove entity form displays of the deleted bundle.
if ($displays = $this->loadDisplays('entity_form_display')) {
$storage = $this->entityTypeManager()
->getStorage('entity_form_display');
$storage->delete($displays);
}
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
$entity_type_manager = $this->entityTypeManager();
$bundle_of = $this->getEntityType()
->getBundleOf();
if (!$update) {
\Drupal::service('entity_bundle.listener')->onBundleCreate($this->id(), $bundle_of);
}
else {
// Invalidate the render cache of entities for which this entity
// is a bundle.
if ($entity_type_manager->hasHandler($bundle_of, 'view_builder')) {
$entity_type_manager->getViewBuilder($bundle_of)
->resetCache();
}
// Entity bundle field definitions may depend on bundle settings.
\Drupal::service('entity_field.manager')->clearCachedFieldDefinitions();
$this->entityTypeBundleInfo()
->clearCachedBundles();
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
foreach ($entities as $entity) {
$entity->deleteDisplays();
\Drupal::service('entity_bundle.listener')->onBundleDelete($entity->id(), $entity->getEntityType()
->getBundleOf());
}
}
/**
* Acts on an entity before the presave hook is invoked.
*
* Used before the entity is saved and before invoking the presave hook.
*
* Ensure that config entities which are bundles of other entities cannot have
* their ID changed.
*
* @param \Drupal\Core\Entity\EntityStorageInterface $storage
* The entity storage object.
*
* @throws \Drupal\Core\Config\ConfigNameException
* Thrown when attempting to rename a bundle entity.
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
// Only handle renames, not creations.
if (!$this->isNew() && $this->getOriginalId() !== $this->id()) {
$bundle_type = $this->getEntityType();
$bundle_of = $bundle_type->getBundleOf();
if (!empty($bundle_of)) {
throw new ConfigNameException("The machine name of the '{$bundle_type->getLabel()}' bundle cannot be changed.");
}
}
}
/**
* Returns view or form displays for this bundle.
*
* @param string $entity_type_id
* The entity type ID of the display type to load.
*
* @return \Drupal\Core\Entity\Display\EntityDisplayInterface[]
* A list of matching displays.
*/
protected function loadDisplays($entity_type_id) {
/** @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface $storage */
$storage = $this->entityTypeManager()
->getStorage($entity_type_id);
$ids = $storage->getQuery()
->condition('id', $this->getEntityType()
->getBundleOf() . '.' . $this->getOriginalId() . '.', 'STARTS_WITH')
->execute();
if ($ids) {
$storage = $this->entityTypeManager()
->getStorage($entity_type_id);
return $storage->loadMultiple($ids);
}
return [];
}
}
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::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 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::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityBase::postDelete | 2 | |
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::id | public | function | Gets the identifier. | Overrides EntityInterface::id | 10 | |
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 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.