class BlockContent
Defines the content block entity class.
Note that render caching of block_content entities is disabled because they are always rendered as blocks, and blocks already have their own render caching. See https://www.drupal.org/node/2284917#comment-9132521 for more information.
Attributes
#[ContentEntityType(id: 'block_content', label: new TranslatableMarkup('Content block'), label_collection: new TranslatableMarkup('Content blocks'), label_singular: new TranslatableMarkup('content block'), label_plural: new TranslatableMarkup('content blocks'), render_cache: FALSE, entity_keys: [
'id' => 'id',
'revision' => 'revision_id',
'bundle' => 'type',
'label' => 'info',
'langcode' => 'langcode',
'uuid' => 'uuid',
'published' => 'status',
], handlers: [
'storage' => SqlContentEntityStorage::class,
'storage_schema' => BlockContentStorageSchema::class,
'access' => BlockContentAccessControlHandler::class,
'list_builder' => BlockContentListBuilder::class,
'view_builder' => BlockContentViewBuilder::class,
'views_data' => BlockContentViewsData::class,
'form' => [
'add' => BlockContentForm::class,
'edit' => BlockContentForm::class,
'delete' => BlockContentDeleteForm::class,
'default' => BlockContentForm::class,
'revision-delete' => RevisionDeleteForm::class,
'revision-revert' => RevisionRevertForm::class,
],
'route_provider' => [
'html' => BlockContentRouteProvider::class,
'revision' => RevisionHtmlRouteProvider::class,
],
'translation' => BlockContentTranslationHandler::class,
], links: [
'add-page' => '/block/add',
'add-form' => '/block/add/{block_content_type}',
'canonical' => '/admin/content/block/{block_content}',
'delete-form' => '/admin/content/block/{block_content}/delete',
'edit-form' => '/admin/content/block/{block_content}',
'collection' => '/admin/content/block',
'create' => '/block',
'revision-delete-form' => '/admin/content/block/{block_content}/revision/{block_content_revision}/delete',
'revision-revert-form' => '/admin/content/block/{block_content}/revision/{block_content_revision}/revert',
'version-history' => '/admin/content/block/{block_content}/revisions',
], admin_permission: 'administer block content', collection_permission: 'access block library', bundle_entity_type: 'block_content_type', bundle_label: new TranslatableMarkup('Block type'), base_table: 'block_content', data_table: 'block_content_field_data', revision_table: 'block_content_revision', revision_data_table: 'block_content_field_revision', translatable: TRUE, show_revision_ui: TRUE, label_count: [
'singular' => '@count content block',
'plural' => '@count content blocks',
], field_ui_base_route: 'entity.block_content_type.edit_form', revision_metadata_keys: [
'revision_user' => 'revision_user',
'revision_created' => 'revision_created',
'revision_log_message' => 'revision_log',
])]
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\Core\Entity\EditorialContentEntityBase implements \Drupal\Core\Entity\EntityChangedInterface, \Drupal\Core\Entity\EntityPublishedInterface, \Drupal\Core\Entity\RevisionLogInterface uses \Drupal\Core\Entity\EntityChangedTrait, \Drupal\Core\Entity\EntityPublishedTrait, \Drupal\Core\Entity\RevisionLogEntityTrait extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\block_content\Entity\BlockContent implements \Drupal\block_content\BlockContentInterface uses \Drupal\Core\Access\RefinableDependentAccessTrait extends \Drupal\Core\Entity\EditorialContentEntityBase
- class \Drupal\Core\Entity\EditorialContentEntityBase implements \Drupal\Core\Entity\EntityChangedInterface, \Drupal\Core\Entity\EntityPublishedInterface, \Drupal\Core\Entity\RevisionLogInterface uses \Drupal\Core\Entity\EntityChangedTrait, \Drupal\Core\Entity\EntityPublishedTrait, \Drupal\Core\Entity\RevisionLogEntityTrait extends \Drupal\Core\Entity\ContentEntityBase
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, \Drupal\Core\Entity\ContentEntityInterface, \Drupal\Core\TypedData\TranslationStatusInterface uses \Drupal\Core\Entity\EntityChangesDetectionTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of BlockContent
35 files declare their use of BlockContent
- BlockContentAccessHandlerTest.php in core/
modules/ block_content/ tests/ src/ Kernel/ BlockContentAccessHandlerTest.php - BlockContentCacheTagsTest.php in core/
modules/ block_content/ tests/ src/ Functional/ BlockContentCacheTagsTest.php - BlockContentCreationTest.php in core/
modules/ block_content/ tests/ src/ Functional/ BlockContentCreationTest.php - BlockContentCreationTrait.php in core/
modules/ block_content/ tests/ src/ Traits/ BlockContentCreationTrait.php - BlockContentDeletionTest.php in core/
modules/ block_content/ tests/ src/ Kernel/ BlockContentDeletionTest.php
File
-
core/
modules/ block_content/ src/ Entity/ BlockContent.php, line 35
Namespace
Drupal\block_content\EntityView source
class BlockContent extends EditorialContentEntityBase implements BlockContentInterface {
use RefinableDependentAccessTrait;
/**
* The theme the block is being created in.
*
* When creating a new content block from the block library, the user is
* redirected to the configure form for that block in the given theme. The
* theme is stored against the block when the content block add form is shown.
*
* @var string
*/
protected $theme;
/**
* {@inheritdoc}
*/
public function createDuplicate() {
$duplicate = parent::createDuplicate();
$duplicate->revision_id->value = NULL;
$duplicate->id->value = NULL;
return $duplicate;
}
/**
* {@inheritdoc}
*/
public function setTheme($theme) {
$this->theme = $theme;
return $this;
}
/**
* {@inheritdoc}
*/
public function getTheme() {
return $this->theme;
}
/**
* {@inheritdoc}
*/
public function postSave(EntityStorageInterface $storage, $update = TRUE) {
parent::postSave($storage, $update);
if ($this->isReusable() || $this->getOriginal()?->isReusable()) {
static::invalidateBlockPluginCache();
}
}
/**
* {@inheritdoc}
*/
public static function preDelete(EntityStorageInterface $storage, array $entities) {
parent::preDelete($storage, $entities);
/** @var \Drupal\block_content\BlockContentInterface $block */
foreach ($entities as $block) {
foreach ($block->getInstances() as $instance) {
$instance->delete();
}
}
}
/**
* {@inheritdoc}
*/
public static function postDelete(EntityStorageInterface $storage, array $entities) {
parent::postDelete($storage, $entities);
/** @var \Drupal\block_content\BlockContentInterface $block */
foreach ($entities as $block) {
if ($block->isReusable()) {
// If any deleted blocks are reusable clear the block cache.
static::invalidateBlockPluginCache();
return;
}
}
}
/**
* {@inheritdoc}
*/
public function getInstances() {
return \Drupal::entityTypeManager()->getStorage('block')
->loadByProperties([
'plugin' => 'block_content:' . $this->uuid(),
]);
}
/**
* {@inheritdoc}
*/
public function preSaveRevision(EntityStorageInterface $storage, \stdClass $record) {
parent::preSaveRevision($storage, $record);
if (!$this->isNewRevision() && $this->getOriginal() && empty($record->revision_log_message)) {
// If we are updating an existing block_content without adding a new
// revision and the user did not supply a revision log, keep the existing
// one.
$record->revision_log = $this->getOriginal()
->getRevisionLogMessage();
}
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
/** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
$fields = parent::baseFieldDefinitions($entity_type);
$fields['id']->setLabel(t('Content block ID'))
->setDescription(t('The content block ID.'));
$fields['uuid']->setDescription(t('The content block UUID.'));
$fields['revision_id']->setDescription(t('The revision ID.'));
$fields['langcode']->setDescription(t('The content block language code.'));
$fields['type']->setLabel(t('Block type'))
->setDescription(t('The block type.'));
$fields['revision_log']->setDescription(t('The log entry explaining the changes in this revision.'));
$fields['info'] = BaseFieldDefinition::create('string')->setLabel(t('Block description'))
->setDescription(t('A brief description of your block.'))
->setRevisionable(TRUE)
->setTranslatable(TRUE)
->setRequired(TRUE)
->setDisplayOptions('form', [
'type' => 'string_textfield',
'weight' => -5,
])
->setDisplayConfigurable('form', TRUE);
$fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(t('Changed'))
->setDescription(t('The time that the content block was last edited.'))
->setTranslatable(TRUE)
->setRevisionable(TRUE);
$fields['reusable'] = BaseFieldDefinition::create('boolean')->setLabel(t('Reusable'))
->setDescription(t('A boolean indicating whether this block is reusable.'))
->setTranslatable(FALSE)
->setRevisionable(FALSE)
->setDefaultValue(TRUE);
return $fields;
}
/**
* {@inheritdoc}
*/
public function setInfo($info) {
$this->set('info', $info);
return $this;
}
/**
* {@inheritdoc}
*/
public function isReusable() {
return (bool) $this->get('reusable')->value;
}
/**
* {@inheritdoc}
*/
public function setReusable() {
return $this->set('reusable', TRUE);
}
/**
* {@inheritdoc}
*/
public function setNonReusable() {
return $this->set('reusable', FALSE);
}
/**
* Invalidates the block plugin cache after changes and deletions.
*/
protected static function invalidateBlockPluginCache() {
// Invalidate the block cache to update content block-based derivatives.
\Drupal::service('plugin.manager.block')->clearCachedDefinitions();
}
}
Members
| Title Sort descending | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
|---|---|---|---|---|---|---|
| BlockContent::$theme | protected | property | The theme the block is being created in. | |||
| BlockContent::baseFieldDefinitions | public static | function | Provides base field definitions for an entity type. | Overrides EditorialContentEntityBase::baseFieldDefinitions | ||
| BlockContent::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides ContentEntityBase::createDuplicate | ||
| BlockContent::getInstances | public | function | Gets the configured instances of this content block. | Overrides BlockContentInterface::getInstances | ||
| BlockContent::getTheme | public | function | Gets the theme value. | Overrides BlockContentInterface::getTheme | ||
| BlockContent::invalidateBlockPluginCache | protected static | function | Invalidates the block plugin cache after changes and deletions. | |||
| BlockContent::isReusable | public | function | Determines if the block is reusable or not. | Overrides BlockContentInterface::isReusable | ||
| BlockContent::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityBase::postDelete | ||
| BlockContent::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides ContentEntityBase::postSave | ||
| BlockContent::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | ||
| BlockContent::preSaveRevision | public | function | Acts on a revision before it gets saved. | Overrides ContentEntityBase::preSaveRevision | ||
| BlockContent::setInfo | public | function | Sets the block description. | Overrides BlockContentInterface::setInfo | ||
| BlockContent::setNonReusable | public | function | Sets the block to be non-reusable. | Overrides BlockContentInterface::setNonReusable | ||
| BlockContent::setReusable | public | function | Sets the block to be reusable. | Overrides BlockContentInterface::setReusable | ||
| BlockContent::setTheme | public | function | Sets the theme value. | Overrides BlockContentInterface::setTheme | ||
| 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. | |||
| ContentEntityBase::$activeLangcode | protected | property | Language code identifying the entity active language. | |||
| ContentEntityBase::$defaultLangcode | protected | property | Local cache for the default language code. | |||
| ContentEntityBase::$defaultLangcodeKey | protected | property | The default langcode entity key. | |||
| ContentEntityBase::$enforceDefaultTranslation | protected | property | Override the result of isDefaultTranslation(). | |||
| ContentEntityBase::$enforceRevisionTranslationAffected | protected | property | Whether the revision translation affected flag has been enforced. | |||
| ContentEntityBase::$entityKeys | protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |||
| ContentEntityBase::$fieldDefinitions | protected | property | Local cache for field definitions. | |||
| ContentEntityBase::$fields | protected | property | The array of fields, each being an instance of FieldItemListInterface. | |||
| ContentEntityBase::$fieldsToSkipFromTranslationChangesCheck | protected static | property | Local cache for fields to skip from the checking for translation changes. | |||
| ContentEntityBase::$isDefaultRevision | protected | property | Indicates whether this is the default revision. | |||
| ContentEntityBase::$langcodeKey | protected | property | The language entity key. | |||
| ContentEntityBase::$languages | protected | property | Local cache for the available language objects. | |||
| ContentEntityBase::$loadedRevisionId | protected | property | The loaded revision ID before the new revision was set. | |||
| ContentEntityBase::$newRevision | protected | property | Boolean indicating whether a new revision should be created on save. | |||
| ContentEntityBase::$revisionTranslationAffectedKey | protected | property | The revision translation affected entity key. | |||
| ContentEntityBase::$translatableEntityKeys | protected | property | Holds translatable entity keys such as the label. | |||
| ContentEntityBase::$translationInitialize | protected | property | A flag indicating whether a translation object is being initialized. | |||
| ContentEntityBase::$translations | protected | property | An array of entity translation metadata. | |||
| ContentEntityBase::$validated | protected | property | Whether entity validation was performed. | |||
| ContentEntityBase::$validationRequired | protected | property | Whether entity validation is required before saving the entity. | |||
| ContentEntityBase::$values | protected | property | The plain data values of the contained fields. | |||
| ContentEntityBase::access | public | function | Checks data value access. | Overrides EntityBase::access | 1 | |
| ContentEntityBase::addTranslation | public | function | Adds a new translation to the translatable object. | Overrides TranslatableInterface::addTranslation | ||
| ContentEntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityBase::bundle | ||
| ContentEntityBase::bundleFieldDefinitions | public static | function | Provides field definitions for a specific bundle. | Overrides FieldableEntityInterface::bundleFieldDefinitions | 5 | |
| ContentEntityBase::clearTranslationCache | protected | function | Clears entity translation object cache to remove stale references. | |||
| ContentEntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityBase::create | ||
| ContentEntityBase::get | public | function | Gets a field item list. | Overrides FieldableEntityInterface::get | ||
| ContentEntityBase::getBundleEntity | public | function | Gets the bundle entity of this entity. | Overrides ContentEntityInterface::getBundleEntity | ||
| ContentEntityBase::getEntityKey | protected | function | Gets the value of the given entity key, if defined. | 1 | ||
| ContentEntityBase::getFieldDefinition | public | function | Gets the definition of a contained field. | Overrides FieldableEntityInterface::getFieldDefinition | ||
| ContentEntityBase::getFieldDefinitions | public | function | Gets an array of field definitions of all contained fields. | Overrides FieldableEntityInterface::getFieldDefinitions | ||
| ContentEntityBase::getFields | public | function | Gets an array of all field item lists. | Overrides FieldableEntityInterface::getFields | ||
| ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip in ::hasTranslationChanges. | 1 | ||
| ContentEntityBase::getIterator | public | function | ||||
| ContentEntityBase::getLanguages | protected | function | ||||
| ContentEntityBase::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | Overrides RevisionableInterface::getLoadedRevisionId | ||
| ContentEntityBase::getRevisionId | public | function | Gets the revision identifier of the entity. | Overrides RevisionableInterface::getRevisionId | ||
| ContentEntityBase::getTranslatableFields | public | function | Gets an array of field item lists for translatable fields. | Overrides FieldableEntityInterface::getTranslatableFields | ||
| ContentEntityBase::getTranslatedField | protected | function | Gets a translated field. | |||
| ContentEntityBase::getTranslation | public | function | Gets a translation of the data. | Overrides TranslatableInterface::getTranslation | ||
| ContentEntityBase::getTranslationLanguages | public | function | Returns the languages the data is translated to. | Overrides TranslatableInterface::getTranslationLanguages | ||
| ContentEntityBase::getTranslationStatus | public | function | Returns the translation status. | Overrides TranslationStatusInterface::getTranslationStatus | ||
| ContentEntityBase::getUntranslated | public | function | Returns the translatable object in the language it was created. | Overrides TranslatableInterface::getUntranslated | ||
| ContentEntityBase::hasField | public | function | Determines whether the entity has a field with the given name. | Overrides FieldableEntityInterface::hasField | ||
| ContentEntityBase::hasTranslation | public | function | Checks there is a translation for the given language code. | Overrides TranslatableInterface::hasTranslation | ||
| ContentEntityBase::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | Overrides TranslatableInterface::hasTranslationChanges | ||
| ContentEntityBase::id | public | function | Gets the identifier. | Overrides EntityBase::id | ||
| ContentEntityBase::initializeTranslation | protected | function | Instantiates a translation object for an existing translation. | |||
| ContentEntityBase::isDefaultRevision | public | function | Checks if this entity is the default revision. | Overrides RevisionableInterface::isDefaultRevision | ||
| ContentEntityBase::isDefaultTranslation | public | function | Checks whether the translation is the default one. | Overrides TranslatableInterface::isDefaultTranslation | ||
| ContentEntityBase::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | ||
| ContentEntityBase::isLatestRevision | public | function | Checks if this entity is the latest revision. | Overrides RevisionableInterface::isLatestRevision | ||
| ContentEntityBase::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | ||
| ContentEntityBase::isNewRevision | public | function | Determines whether a new revision should be created on save. | Overrides RevisionableInterface::isNewRevision | ||
| ContentEntityBase::isNewTranslation | public | function | Checks whether the translation is new. | Overrides TranslatableInterface::isNewTranslation | ||
| ContentEntityBase::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected | ||
| ContentEntityBase::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | ||
| ContentEntityBase::isTranslatable | public | function | Returns the translation support status. | Overrides TranslatableInterface::isTranslatable | ||
| ContentEntityBase::isValidationRequired | public | function | Checks whether entity validation is required before saving the entity. | Overrides FieldableEntityInterface::isValidationRequired | ||
| ContentEntityBase::label | public | function | Gets the label of the entity. | Overrides EntityBase::label | 4 | |
| ContentEntityBase::language | public | function | Gets the language of the entity. | Overrides EntityBase::language | ||
| ContentEntityBase::onChange | public | function | Reacts to changes to a field. | Overrides FieldableEntityInterface::onChange | ||
| ContentEntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityBase::postCreate | 1 | |
| ContentEntityBase::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides EntityBase::preSave | 8 | |
| ContentEntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityBase::referencedEntities | 1 | |
| ContentEntityBase::removeTranslation | public | function | Removes the translation identified by the given language code. | Overrides TranslatableInterface::removeTranslation | ||
| ContentEntityBase::set | public | function | Sets a field value. | Overrides FieldableEntityInterface::set | ||
| ContentEntityBase::setDefaultLangcode | protected | function | Populates the local cache for the default language code. | |||
| ContentEntityBase::setDefaultTranslationEnforced | public | function | Set or clear an override of the isDefaultTranslation() result. | |||
| ContentEntityBase::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | Overrides RevisionableInterface::setNewRevision | ||
| ContentEntityBase::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected | ||
| ContentEntityBase::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. | Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | ||
| ContentEntityBase::setValidationRequired | public | function | Sets whether entity validation is required before saving the entity. | Overrides FieldableEntityInterface::setValidationRequired | ||
| ContentEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | ||
| ContentEntityBase::updateFieldLangcodes | protected | function | Updates language for already instantiated fields. | |||
| ContentEntityBase::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | Overrides RevisionableInterface::updateLoadedRevisionId | ||
| ContentEntityBase::updateOriginalValues | public | function | Updates the original values with the interim changes. | |||
| ContentEntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityBase::uuid | ||
| ContentEntityBase::validate | public | function | Validates the currently set values. | Overrides FieldableEntityInterface::validate | 1 | |
| ContentEntityBase::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | Overrides RevisionableInterface::wasDefaultRevision | ||
| ContentEntityBase::__clone | public | function | Magic method: Implements a deep clone. | |||
| ContentEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | ||
| ContentEntityBase::__get | public | function | Implements the magic method for getting object properties. | Overrides EntityBase::__get | ||
| ContentEntityBase::__isset | public | function | Implements the magic method for isset(). | Overrides EntityBase::__isset | ||
| ContentEntityBase::__set | public | function | Implements the magic method for setting object properties. | Overrides EntityBase::__set | ||
| ContentEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | |||
| ContentEntityBase::__unset | public | function | Implements the magic method for unset(). | Overrides EntityBase::__unset | ||
| DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
| DependencySerializationTrait::__sleep | public | function | Aliased as: traitSleep | 2 | ||
| DependencySerializationTrait::__wakeup | public | function | 2 | |||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | |||
| EntityBase::$entityTypeId | protected | property | The entity type. | |||
| EntityBase::$originalEntity | protected | property | The original unchanged entity. | |||
| EntityBase::$typedData | protected | property | A typed data object wrapping this entity. | |||
| 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::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityInterface::getCacheTagsToInvalidate | 3 | |
| EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | ||
| EntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityInterface::getConfigDependencyName | 1 | |
| EntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityInterface::getConfigTarget | 1 | |
| 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::getOriginal | public | function | Returns the original unchanged entity. | Overrides EntityInterface::getOriginal | ||
| EntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityInterface::getOriginalId | 1 | |
| 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::invalidateTagsOnDelete | protected static | function | Invalidates an entity's cache tags upon delete. | 1 | ||
| EntityBase::invalidateTagsOnSave | protected | function | Invalidates an entity's cache tags upon save. | 2 | ||
| EntityBase::isNew | public | function | Determines whether the entity is new. | Overrides EntityInterface::isNew | 2 | |
| 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::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::save | public | function | Saves an entity permanently. | Overrides EntityInterface::save | 3 | |
| EntityBase::setOriginal | public | function | Sets the original unchanged entity. | Overrides EntityInterface::setOriginal | ||
| EntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityInterface::setOriginalId | 1 | |
| EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | ||
| EntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityInterface::toUrl | 2 | |
| 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::uuidGenerator | protected | function | Gets the UUID generator. | |||
| EntityChangedTrait::getChangedTime | public | function | Gets the timestamp of the last entity change for the current translation. | |||
| EntityChangedTrait::getChangedTimeAcrossTranslations | public | function | Returns the timestamp of the last entity change across all translations. | |||
| EntityChangedTrait::setChangedTime | public | function | Sets the timestamp of the last entity change for the current translation. | |||
| EntityChangesDetectionTrait::getFieldsToSkipFromTranslationChangesCheck | protected | function | Returns an array of field names to skip when checking for changes. | Aliased as: traitGetFieldsToSkipFromTranslationChangesCheck | ||
| EntityPublishedTrait::isPublished | public | function | ||||
| EntityPublishedTrait::publishedBaseFieldDefinitions | public static | function | Returns an array of base field definitions for publishing status. | |||
| EntityPublishedTrait::setPublished | public | function | ||||
| EntityPublishedTrait::setUnpublished | public | function | ||||
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | |||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | ||||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | ||||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | ||||
| RefinableDependentAccessTrait::$accessDependency | protected | property | The access dependency. | |||
| RefinableDependentAccessTrait::addAccessDependency | public | function | ||||
| RefinableDependentAccessTrait::getAccessDependency | public | function | ||||
| RefinableDependentAccessTrait::setAccessDependency | public | function | ||||
| RevisionLogEntityTrait::getEntityType | abstract public | function | Gets the entity type definition. | |||
| RevisionLogEntityTrait::getRevisionCreationTime | public | function | ||||
| RevisionLogEntityTrait::getRevisionLogMessage | public | function | ||||
| RevisionLogEntityTrait::getRevisionUser | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUser(). | |||
| RevisionLogEntityTrait::getRevisionUserId | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionUserId(). | |||
| RevisionLogEntityTrait::revisionLogBaseFieldDefinitions | public static | function | Provides revision-related base field definitions for an entity type. | |||
| RevisionLogEntityTrait::setRevisionCreationTime | public | function | ||||
| RevisionLogEntityTrait::setRevisionLogMessage | public | function | ||||
| RevisionLogEntityTrait::setRevisionUser | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUser(). | |||
| RevisionLogEntityTrait::setRevisionUserId | public | function | Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionUserId(). | |||
| SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | |||
| SynchronizableEntityTrait::isSyncing | public | function | ||||
| SynchronizableEntityTrait::setSyncing | public | function | ||||
| TranslationStatusInterface::TRANSLATION_CREATED | constant | Status code identifying a newly created translation. | ||||
| TranslationStatusInterface::TRANSLATION_EXISTING | constant | Status code identifying an existing translation. | ||||
| TranslationStatusInterface::TRANSLATION_REMOVED | constant | Status code identifying a removed translation. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.