class EditorialContentEntityBase

Same name and namespace in other branches
  1. 11.x core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php \Drupal\Core\Entity\EditorialContentEntityBase
  2. 9 core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php \Drupal\Core\Entity\EditorialContentEntityBase
  3. 8.9.x core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php \Drupal\Core\Entity\EditorialContentEntityBase

Provides a base entity class with extended revision and publishing support.

Hierarchy

Expanded class hierarchy of EditorialContentEntityBase

Related topics

Entity API
Describes how to define and manipulate content and configuration entities.
5 files declare their use of EditorialContentEntityBase
BlockContent.php in core/modules/block_content/src/Entity/BlockContent.php
Media.php in core/modules/media/src/Entity/Media.php
MenuLinkContent.php in core/modules/menu_link_content/src/Entity/MenuLinkContent.php
Node.php in core/modules/node/src/Entity/Node.php
Term.php in core/modules/taxonomy/src/Entity/Term.php

File

core/lib/Drupal/Core/Entity/EditorialContentEntityBase.php, line 10

Namespace

Drupal\Core\Entity
View on git.drupalcode.org
View source 
abstract class EditorialContentEntityBase extends ContentEntityBase implements EntityChangedInterface, EntityPublishedInterface, RevisionLogInterface {
  use EntityChangedTrait;
  use EntityPublishedTrait;
  use RevisionLogEntityTrait;
  
  /**
   * {@inheritdoc}
   */
  public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
    $fields = parent::baseFieldDefinitions($entity_type);
    // Add the revision metadata fields.
    $fields += static::revisionLogBaseFieldDefinitions($entity_type);
    // Add the published field.
    $fields += static::publishedBaseFieldDefinitions($entity_type);
    return $fields;
  }

}

Members

Title 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.
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 Overrides EntityBase::access 1
ContentEntityBase::addTranslation public function Overrides TranslatableInterface::addTranslation
ContentEntityBase::bundle public function Overrides EntityBase::bundle
ContentEntityBase::bundleFieldDefinitions public static function Overrides FieldableEntityInterface::bundleFieldDefinitions 5
ContentEntityBase::clearTranslationCache protected function Clears entity translation object cache to remove stale references.
ContentEntityBase::create public static function Overrides EntityBase::create
ContentEntityBase::createDuplicate public function Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function Overrides FieldableEntityInterface::get
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function Overrides FieldableEntityInterface::getFieldDefinition
ContentEntityBase::getFieldDefinitions public function Overrides FieldableEntityInterface::getFieldDefinitions
ContentEntityBase::getFields public function Overrides FieldableEntityInterface::getFields
ContentEntityBase::getFieldsToSkipFromTranslationChangesCheck protected function Returns an array of field names to skip in ::hasTranslationChanges. 1
ContentEntityBase::getIterator public function #[\ReturnTypeWillChange]
ContentEntityBase::getLanguages protected function
ContentEntityBase::getLoadedRevisionId public function Overrides RevisionableInterface::getLoadedRevisionId
ContentEntityBase::getRevisionId public function Overrides RevisionableInterface::getRevisionId
ContentEntityBase::getTranslatableFields public function Overrides FieldableEntityInterface::getTranslatableFields
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function Overrides TranslatableInterface::getTranslation
ContentEntityBase::getTranslationLanguages public function Overrides TranslatableInterface::getTranslationLanguages
ContentEntityBase::getTranslationStatus public function Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function Overrides TranslatableInterface::getUntranslated
ContentEntityBase::hasField public function Overrides FieldableEntityInterface::hasField
ContentEntityBase::hasTranslation public function Overrides TranslatableInterface::hasTranslation
ContentEntityBase::hasTranslationChanges public function Overrides TranslatableInterface::hasTranslationChanges
ContentEntityBase::id public function Overrides EntityBase::id
ContentEntityBase::initializeTranslation protected function Instantiates a translation object for an existing translation.
ContentEntityBase::isDefaultRevision public function Overrides RevisionableInterface::isDefaultRevision
ContentEntityBase::isDefaultTranslation public function Overrides TranslatableInterface::isDefaultTranslation
ContentEntityBase::isDefaultTranslationAffectedOnly public function Overrides TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly
ContentEntityBase::isLatestRevision public function Overrides RevisionableInterface::isLatestRevision
ContentEntityBase::isLatestTranslationAffectedRevision public function Overrides TranslatableRevisionableInterface::isLatestTranslationAffectedRevision
ContentEntityBase::isNewRevision public function Overrides RevisionableInterface::isNewRevision
ContentEntityBase::isNewTranslation public function Overrides TranslatableInterface::isNewTranslation
ContentEntityBase::isRevisionTranslationAffected public function Overrides TranslatableRevisionableInterface::isRevisionTranslationAffected
ContentEntityBase::isRevisionTranslationAffectedEnforced public function Overrides TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced
ContentEntityBase::isTranslatable public function Overrides TranslatableInterface::isTranslatable
ContentEntityBase::isValidationRequired public function Overrides FieldableEntityInterface::isValidationRequired
ContentEntityBase::label public function Overrides EntityBase::label 4
ContentEntityBase::language public function Overrides EntityBase::language
ContentEntityBase::onChange public function Overrides FieldableEntityInterface::onChange
ContentEntityBase::postCreate public function Overrides EntityBase::postCreate 1
ContentEntityBase::postSave public function Overrides EntityBase::postSave 8
ContentEntityBase::preSave public function Overrides EntityBase::preSave 8
ContentEntityBase::preSaveRevision public function Overrides RevisionableInterface::preSaveRevision 3
ContentEntityBase::referencedEntities public function Overrides EntityBase::referencedEntities 1
ContentEntityBase::removeTranslation public function Overrides TranslatableInterface::removeTranslation
ContentEntityBase::set public function 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 Overrides RevisionableInterface::setNewRevision
ContentEntityBase::setRevisionTranslationAffected public function Overrides TranslatableRevisionableInterface::setRevisionTranslationAffected
ContentEntityBase::setRevisionTranslationAffectedEnforced public function Overrides TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced
ContentEntityBase::setValidationRequired public function Overrides FieldableEntityInterface::setValidationRequired
ContentEntityBase::toArray public function Overrides EntityBase::toArray
ContentEntityBase::updateFieldLangcodes protected function Updates language for already instantiated fields.
ContentEntityBase::updateLoadedRevisionId public function Overrides RevisionableInterface::updateLoadedRevisionId
ContentEntityBase::updateOriginalValues public function Updates the original values with the interim changes.
ContentEntityBase::uuid public function Overrides EntityBase::uuid
ContentEntityBase::validate public function Overrides FieldableEntityInterface::validate 1
ContentEntityBase::wasDefaultRevision public function Overrides RevisionableInterface::wasDefaultRevision
ContentEntityBase::__clone public function Magic method: Implements a deep clone.
ContentEntityBase::__construct public function Overrides EntityBase::__construct
ContentEntityBase::__get public function Implements the magic method for getting object properties.
ContentEntityBase::__isset public function Implements the magic method for isset().
ContentEntityBase::__set public function Implements the magic method for setting object properties.
ContentEntityBase::__sleep public function Overrides EntityBase::__sleep
ContentEntityBase::__unset public function Implements the magic method for 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 #[\ReturnTypeWillChange] 2
EditorialContentEntityBase::baseFieldDefinitions public static function Overrides ContentEntityBase::baseFieldDefinitions 5
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::delete public function Overrides EntityInterface::delete 1
EntityBase::enforceIsNew public function 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 Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getCacheTagsToInvalidate public function Overrides EntityInterface::getCacheTagsToInvalidate 3
EntityBase::getConfigDependencyKey public function Overrides EntityInterface::getConfigDependencyKey
EntityBase::getConfigDependencyName public function Overrides EntityInterface::getConfigDependencyName 1
EntityBase::getConfigTarget public function Overrides EntityInterface::getConfigTarget 1
EntityBase::getEntityTypeId public function Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getOriginalId public function Overrides EntityInterface::getOriginalId 1
EntityBase::getTypedData public function Overrides EntityInterface::getTypedData
EntityBase::getTypedDataClass private function Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate public function 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 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 Overrides EntityInterface::load
EntityBase::loadMultiple public static function Overrides EntityInterface::loadMultiple
EntityBase::postDelete public static function Overrides EntityInterface::postDelete 17
EntityBase::postLoad public static function Overrides EntityInterface::postLoad 3
EntityBase::preCreate public static function Overrides EntityInterface::preCreate 6
EntityBase::preDelete public static function Overrides EntityInterface::preDelete 7
EntityBase::save public function Overrides EntityInterface::save 3
EntityBase::setOriginalId public function Overrides EntityInterface::setOriginalId 1
EntityBase::toLink public function Overrides EntityInterface::toLink
EntityBase::toUrl public function Overrides EntityInterface::toUrl 2
EntityBase::uriRelationships public function 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
RevisionLogEntityTrait::getEntityType abstract public function Gets the entity type definition.
RevisionLogEntityTrait::getRevisionCreationTime public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionCreationTime().
RevisionLogEntityTrait::getRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::getRevisionLogMessage().
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 Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionCreationTime().
RevisionLogEntityTrait::setRevisionLogMessage public function Implements \Drupal\Core\Entity\RevisionLogInterface::setRevisionLogMessage().
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.