class Comment

Same name in this branch
  1. 10 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  2. 10 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  3. 10 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
Same name and namespace in other branches
  1. 9 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  2. 9 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  3. 9 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  4. 9 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
  5. 9 core/modules/comment/tests/modules/d6_comment_test/src/Plugin/migrate/source/d6/Comment.php \Drupal\d6_comment_test\Plugin\migrate\source\d6\Comment
  6. 8.9.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  7. 8.9.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  8. 8.9.x core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  9. 8.9.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
  10. 11.x core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
  11. 11.x core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
  12. 11.x core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
  13. 11.x core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment

Defines the comment entity class.

Plugin annotation


@ContentEntityType(
  id = "comment",
  label = @Translation("Comment"),
  label_singular = @Translation("comment"),
  label_plural = @Translation("comments"),
  label_count = @PluralTranslation(
    singular = "@count comment",
    plural = "@count comments",
  ),
  bundle_label = @Translation("Comment type"),
  handlers = {
    "storage" = "Drupal\comment\CommentStorage",
    "storage_schema" = "Drupal\comment\CommentStorageSchema",
    "access" = "Drupal\comment\CommentAccessControlHandler",
    "list_builder" = "Drupal\Core\Entity\EntityListBuilder",
    "view_builder" = "Drupal\comment\CommentViewBuilder",
    "views_data" = "Drupal\comment\CommentViewsData",
    "form" = {
      "default" = "Drupal\comment\CommentForm",
      "delete" = "Drupal\comment\Form\DeleteForm"
    },
    "translation" = "Drupal\comment\CommentTranslationHandler"
  },
  base_table = "comment",
  data_table = "comment_field_data",
  uri_callback = "comment_uri",
  translatable = TRUE,
  entity_keys = {
    "id" = "cid",
    "bundle" = "comment_type",
    "label" = "subject",
    "langcode" = "langcode",
    "uuid" = "uuid",
    "published" = "status",
    "owner" = "uid",
  },
  links = {
    "canonical" = "/comment/{comment}",
    "delete-form" = "/comment/{comment}/delete",
    "delete-multiple-form" = "/admin/content/comment/delete",
    "edit-form" = "/comment/{comment}/edit",
    "create" = "/comment",
  },
  bundle_entity_type = "comment_type",
  field_ui_base_route  = "entity.comment_type.edit_form",
  constraints = {
    "CommentName" = {}
  }
)

Hierarchy

Expanded class hierarchy of Comment

57 files declare their use of Comment
CommentAccessTest.php in core/modules/comment/tests/src/Functional/CommentAccessTest.php
CommentActionsTest.php in core/modules/comment/tests/src/Kernel/CommentActionsTest.php
CommentAdminTest.php in core/modules/comment/tests/src/Functional/CommentAdminTest.php
CommentAdminTest.php in core/modules/comment/tests/src/Functional/Views/CommentAdminTest.php
CommentAdminViewTest.php in core/modules/comment/tests/src/Kernel/Views/CommentAdminViewTest.php

... See full list

366 string references to 'Comment'
ActionTest::providerSource in core/modules/system/tests/src/Kernel/Plugin/migrate/source/ActionTest.php
AuthorNameFormatter::isApplicable in core/modules/comment/src/Plugin/Field/FieldFormatter/AuthorNameFormatter.php
Returns if the formatter can be used for the provided field.
CategoryAutocompleteTest::providerTestAutocompleteSuggestions in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php
Data provider for testAutocompleteSuggestions().
CategoryAutocompleteTest::setUp in core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php
comment.info.yml in core/modules/comment/comment.info.yml
core/modules/comment/comment.info.yml

... See full list

File

core/modules/comment/src/Entity/Comment.php, line 71

Namespace

Drupal\comment\Entity
View source
class Comment extends ContentEntityBase implements CommentInterface {
    use EntityChangedTrait;
    use EntityOwnerTrait;
    use EntityPublishedTrait;
    
    /**
     * The thread for which a lock was acquired.
     *
     * @var string
     */
    protected $threadLock = '';
    
    /**
     * {@inheritdoc}
     */
    public function preSave(EntityStorageInterface $storage) {
        parent::preSave($storage);
        if ($this->isNew()) {
            // Add the comment to database. This next section builds the thread field.
            // @see \Drupal\comment\CommentViewBuilder::buildComponents()
            $thread = $this->getThread();
            if (empty($thread)) {
                if ($this->threadLock) {
                    // Thread lock was not released after being set previously.
                    // This suggests there's a bug in code using this class.
                    throw new \LogicException('preSave() is called again without calling postSave() or releaseThreadLock()');
                }
                if (!$this->hasParentComment()) {
                    // This is a comment with no parent comment (depth 0): we start
                    // by retrieving the maximum thread level.
                    $max = $storage->getMaxThread($this);
                    // Strip the "/" from the end of the thread.
                    $max = rtrim((string) $max, '/');
                    // We need to get the value at the correct depth.
                    $parts = explode('.', $max);
                    $n = Number::alphadecimalToInt($parts[0]);
                    $prefix = '';
                }
                else {
                    // This is a comment with a parent comment, so increase the part of
                    // the thread value at the proper depth.
                    // Get the parent comment:
                    $parent = $this->getParentComment();
                    // Strip the "/" from the end of the parent thread.
                    $parent->setThread((string) rtrim((string) $parent->getThread(), '/'));
                    $prefix = $parent->getThread() . '.';
                    // Get the max value in *this* thread.
                    $max = $storage->getMaxThreadPerThread($this);
                    if ($max == '') {
                        // First child of this parent. As the other two cases do an
                        // increment of the thread number before creating the thread
                        // string set this to -1 so it requires an increment too.
                        $n = -1;
                    }
                    else {
                        // Strip the "/" at the end of the thread.
                        $max = rtrim($max, '/');
                        // Get the value at the correct depth.
                        $parts = explode('.', $max);
                        $parent_depth = count(explode('.', $parent->getThread()));
                        $n = Number::alphadecimalToInt($parts[$parent_depth]);
                    }
                }
                // Finally, build the thread field for this new comment. To avoid
                // race conditions, get a lock on the thread. If another process already
                // has the lock, just move to the next integer.
                do {
                    $thread = $prefix . Number::intToAlphadecimal(++$n) . '/';
                    $lock_name = "comment:{$this->getCommentedEntityId()}:{$thread}";
                } while (!\Drupal::lock()->acquire($lock_name));
                $this->threadLock = $lock_name;
            }
            $this->setThread($thread);
        }
        // The entity fields for name and mail have no meaning if the user is not
        // Anonymous. Set them to NULL to make it clearer that they are not used.
        // For anonymous users see \Drupal\comment\CommentForm::form() for mail,
        // and \Drupal\comment\CommentForm::buildEntity() for name setting.
        if (!$this->getOwner()
            ->isAnonymous()) {
            $this->set('name', NULL);
            $this->set('mail', NULL);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function postSave(EntityStorageInterface $storage, $update = TRUE) {
        parent::postSave($storage, $update);
        // Always invalidate the cache tag for the commented entity.
        if ($commented_entity = $this->getCommentedEntity()) {
            Cache::invalidateTags($commented_entity->getCacheTagsToInvalidate());
        }
        $this->releaseThreadLock();
        // Update the {comment_entity_statistics} table prior to executing the hook.
        \Drupal::service('comment.statistics')->update($this);
    }
    
    /**
     * Release the lock acquired for the thread in preSave().
     */
    protected function releaseThreadLock() {
        if ($this->threadLock) {
            \Drupal::lock()->release($this->threadLock);
            $this->threadLock = '';
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function postDelete(EntityStorageInterface $storage, array $entities) {
        parent::postDelete($storage, $entities);
        $child_cids = $storage->getChildCids($entities);
        $comment_storage = \Drupal::entityTypeManager()->getStorage('comment');
        $comments = $comment_storage->loadMultiple($child_cids);
        $comment_storage->delete($comments);
        foreach ($entities as $entity) {
            \Drupal::service('comment.statistics')->update($entity);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function referencedEntities() {
        $referenced_entities = parent::referencedEntities();
        if ($this->getCommentedEntityId()) {
            $referenced_entities[] = $this->getCommentedEntity();
        }
        return $referenced_entities;
    }
    
    /**
     * {@inheritdoc}
     */
    public function permalink() {
        $uri = $this->toUrl();
        $uri->setOption('fragment', 'comment-' . $this->id());
        return $uri;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
        
        /** @var \Drupal\Core\Field\BaseFieldDefinition[] $fields */
        $fields = parent::baseFieldDefinitions($entity_type);
        $fields += static::publishedBaseFieldDefinitions($entity_type);
        $fields += static::ownerBaseFieldDefinitions($entity_type);
        $fields['cid']->setLabel(t('Comment ID'))
            ->setDescription(t('The comment ID.'));
        $fields['uuid']->setDescription(t('The comment UUID.'));
        $fields['comment_type']->setLabel(t('Comment Type'))
            ->setDescription(t('The comment type.'));
        $fields['langcode']->setDescription(t('The comment language code.'));
        // Set the default value callback for the status field.
        $fields['status']->setDefaultValueCallback('Drupal\\comment\\Entity\\Comment::getDefaultStatus');
        $fields['pid'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Parent ID'))
            ->setDescription(t('The parent comment ID if this is a reply to a comment.'))
            ->setSetting('target_type', 'comment');
        $fields['entity_id'] = BaseFieldDefinition::create('entity_reference')->setLabel(t('Entity ID'))
            ->setDescription(t('The ID of the entity of which this comment is a reply.'))
            ->setRequired(TRUE);
        $fields['subject'] = BaseFieldDefinition::create('string')->setLabel(t('Subject'))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 64)
            ->setDisplayOptions('form', [
            'type' => 'string_textfield',
            // Default comment body field has weight 20.
'weight' => 10,
        ])
            ->setDisplayConfigurable('form', TRUE);
        $fields['uid']->setDescription(t('The user ID of the comment author.'));
        $fields['name'] = BaseFieldDefinition::create('string')->setLabel(t('Name'))
            ->setDescription(t("The comment author's name."))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 60)
            ->setDefaultValue('');
        $fields['mail'] = BaseFieldDefinition::create('email')->setLabel(t('Email'))
            ->setDescription(t("The comment author's email address."))
            ->setTranslatable(TRUE);
        $fields['homepage'] = BaseFieldDefinition::create('uri')->setLabel(t('Homepage'))
            ->setDescription(t("The comment author's home page address."))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 255);
        $fields['hostname'] = BaseFieldDefinition::create('string')->setLabel(t('Hostname'))
            ->setDescription(t("The comment author's hostname."))
            ->setTranslatable(TRUE)
            ->setSetting('max_length', 128)
            ->setDefaultValueCallback(static::class . '::getDefaultHostname');
        $fields['created'] = BaseFieldDefinition::create('created')->setLabel(t('Created'))
            ->setDescription(t('The time that the comment was created.'))
            ->setTranslatable(TRUE);
        $fields['changed'] = BaseFieldDefinition::create('changed')->setLabel(t('Changed'))
            ->setDescription(t('The time that the comment was last edited.'))
            ->setTranslatable(TRUE);
        $fields['thread'] = BaseFieldDefinition::create('string')->setLabel(t('Thread place'))
            ->setDescription(t("The alphadecimal representation of the comment's place in a thread, consisting of a base 36 string prefixed by an integer indicating its length."))
            ->setSetting('max_length', 255);
        $fields['entity_type'] = BaseFieldDefinition::create('string')->setLabel(t('Entity type'))
            ->setRequired(TRUE)
            ->setDescription(t('The entity type to which this comment is attached.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);
        $fields['field_name'] = BaseFieldDefinition::create('string')->setLabel(t('Comment field name'))
            ->setRequired(TRUE)
            ->setDescription(t('The field name through which this comment was added.'))
            ->setSetting('is_ascii', TRUE)
            ->setSetting('max_length', FieldStorageConfig::NAME_MAX_LENGTH);
        return $fields;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function bundleFieldDefinitions(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
        if ($comment_type = CommentType::load($bundle)) {
            $fields['entity_id'] = clone $base_field_definitions['entity_id'];
            $fields['entity_id']->setSetting('target_type', $comment_type->getTargetEntityTypeId());
            return $fields;
        }
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    public function hasParentComment() {
        return (bool) $this->get('pid')->target_id;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getParentComment() {
        return $this->get('pid')->entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntity() {
        return $this->get('entity_id')->entity;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntityId() {
        return $this->get('entity_id')->target_id;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCommentedEntityTypeId() {
        return $this->get('entity_type')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setFieldName($field_name) {
        $this->set('field_name', $field_name);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFieldName() {
        return $this->get('field_name')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getSubject() {
        return $this->get('subject')->value ?? '';
    }
    
    /**
     * {@inheritdoc}
     */
    public function setSubject($subject) {
        $this->set('subject', $subject);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAuthorName() {
        // If their is a valid user id and the user entity exists return the label.
        if ($this->get('uid')->target_id && $this->get('uid')->entity) {
            return $this->get('uid')->entity
                ->label();
        }
        return $this->get('name')->value ?: \Drupal::config('user.settings')->get('anonymous');
    }
    
    /**
     * {@inheritdoc}
     */
    public function setAuthorName($name) {
        $this->set('name', $name);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getAuthorEmail() {
        $mail = $this->get('mail')->value;
        if ($this->get('uid')->target_id != 0) {
            $mail = $this->get('uid')->entity
                ->getEmail();
        }
        return $mail;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHomepage() {
        return $this->get('homepage')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setHomepage($homepage) {
        $this->set('homepage', $homepage);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getHostname() {
        return $this->get('hostname')->value;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setHostname($hostname) {
        $this->set('hostname', $hostname);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getCreatedTime() {
        if (isset($this->get('created')->value)) {
            return $this->get('created')->value;
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function setCreatedTime($created) {
        $this->set('created', $created);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public function getThread() {
        $thread = $this->get('thread');
        if (!empty($thread->value)) {
            return $thread->value;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function setThread($thread) {
        $this->set('thread', $thread);
        return $this;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function preCreate(EntityStorageInterface $storage, array &$values) {
        if (empty($values['comment_type']) && !empty($values['field_name']) && !empty($values['entity_type'])) {
            $fields = \Drupal::service('entity_field.manager')->getFieldStorageDefinitions($values['entity_type']);
            $values['comment_type'] = $fields[$values['field_name']]->getSetting('comment_type');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function getOwner() {
        $user = $this->get('uid')->entity;
        if (!$user || $user->isAnonymous()) {
            $user = User::getAnonymousUser();
            $user->name = $this->getAuthorName();
            $user->homepage = $this->getHomepage();
        }
        return $user;
    }
    
    /**
     * Get the comment type ID for this comment.
     *
     * @return string
     *   The ID of the comment type.
     */
    public function getTypeId() {
        return $this->bundle();
    }
    
    /**
     * Default value callback for 'status' base field definition.
     *
     * @see ::baseFieldDefinitions()
     *
     * @return bool
     *   TRUE if the comment should be published, FALSE otherwise.
     */
    public static function getDefaultStatus() {
        return \Drupal::currentUser()->hasPermission('skip comment approval') ? CommentInterface::PUBLISHED : CommentInterface::NOT_PUBLISHED;
    }
    
    /**
     * Returns the default value for entity hostname base field.
     *
     * @return string
     *   The client host name.
     */
    public static function getDefaultHostname() {
        if (\Drupal::config('comment.settings')->get('log_ip_addresses')) {
            return \Drupal::request()->getClientIP();
        }
        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.
Comment::$threadLock protected property The thread for which a lock was acquired.
Comment::baseFieldDefinitions public static function Overrides ContentEntityBase::baseFieldDefinitions
Comment::bundleFieldDefinitions public static function Overrides ContentEntityBase::bundleFieldDefinitions
Comment::getAuthorEmail public function Returns the comment author's email address. Overrides CommentInterface::getAuthorEmail
Comment::getAuthorName public function Returns the comment author's name. Overrides CommentInterface::getAuthorName
Comment::getCommentedEntity public function Returns the entity to which the comment is attached. Overrides CommentInterface::getCommentedEntity
Comment::getCommentedEntityId public function Returns the ID of the entity to which the comment is attached. Overrides CommentInterface::getCommentedEntityId
Comment::getCommentedEntityTypeId public function Returns the type of the entity to which the comment is attached. Overrides CommentInterface::getCommentedEntityTypeId
Comment::getCreatedTime public function Returns the time that the comment was created. Overrides CommentInterface::getCreatedTime
Comment::getDefaultHostname public static function Returns the default value for entity hostname base field.
Comment::getDefaultStatus public static function Default value callback for 'status' base field definition.
Comment::getFieldName public function Returns the name of the field the comment is attached to. Overrides CommentInterface::getFieldName
Comment::getHomepage public function Returns the comment author's home page address. Overrides CommentInterface::getHomepage
Comment::getHostname public function Returns the comment author's hostname. Overrides CommentInterface::getHostname
Comment::getOwner public function Returns the entity owner's user entity. Overrides EntityOwnerTrait::getOwner
Comment::getParentComment public function Returns the parent comment entity if this is a reply to a comment. Overrides CommentInterface::getParentComment
Comment::getSubject public function Returns the subject of the comment. Overrides CommentInterface::getSubject
Comment::getThread public function Returns the alphadecimal representation of the comment's place in a thread. Overrides CommentInterface::getThread
Comment::getTypeId public function Get the comment type ID for this comment. Overrides CommentInterface::getTypeId
Comment::hasParentComment public function Determines if this comment is a reply to another comment. Overrides CommentInterface::hasParentComment
Comment::permalink public function Returns the permalink URL for this comment. Overrides CommentInterface::permalink
Comment::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete
Comment::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ContentEntityBase::postSave
Comment::preCreate public static function Changes the values of an entity before it is created. Overrides EntityBase::preCreate
Comment::preSave public function Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase::preSave
Comment::referencedEntities public function Gets a list of entities referenced by this entity. Overrides ContentEntityBase::referencedEntities
Comment::releaseThreadLock protected function Release the lock acquired for the thread in preSave().
Comment::setAuthorName public function Sets the name of the author of the comment. Overrides CommentInterface::setAuthorName
Comment::setCreatedTime public function Sets the creation date of the comment. Overrides CommentInterface::setCreatedTime
Comment::setFieldName public function Sets the field ID for which this comment is attached. Overrides CommentInterface::setFieldName
Comment::setHomepage public function Sets the comment author's home page address. Overrides CommentInterface::setHomepage
Comment::setHostname public function Sets the hostname of the author of the comment. Overrides CommentInterface::setHostname
Comment::setSubject public function Sets the subject of the comment. Overrides CommentInterface::setSubject
Comment::setThread public function Sets the alphadecimal representation of the comment's place in a thread. Overrides CommentInterface::setThread
CommentInterface::ANONYMOUS_MAYNOT_CONTACT constant Anonymous posters cannot enter their contact information.
CommentInterface::ANONYMOUS_MAY_CONTACT constant Anonymous posters may leave their contact information.
CommentInterface::ANONYMOUS_MUST_CONTACT constant Anonymous posters are required to leave their contact information.
CommentInterface::NOT_PUBLISHED constant Comment is awaiting approval.
CommentInterface::PUBLISHED constant Comment is published.
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
ContentEntityBase::bundle public function Gets the bundle of the entity. Overrides EntityBase::bundle
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::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ContentEntityBase::get public function
ContentEntityBase::getEntityKey protected function Gets the value of the given entity key, if defined. 1
ContentEntityBase::getFieldDefinition public function
ContentEntityBase::getFieldDefinitions public function
ContentEntityBase::getFields public function
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
ContentEntityBase::getRevisionId public function
ContentEntityBase::getTranslatableFields public function
ContentEntityBase::getTranslatedField protected function Gets a translated field.
ContentEntityBase::getTranslation public function
ContentEntityBase::getTranslationLanguages public function
ContentEntityBase::getTranslationStatus public function Returns the translation status. Overrides TranslationStatusInterface::getTranslationStatus
ContentEntityBase::getUntranslated public function
ContentEntityBase::hasField public function
ContentEntityBase::hasTranslation public function
ContentEntityBase::hasTranslationChanges public function
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
ContentEntityBase::isDefaultTranslation public function
ContentEntityBase::isDefaultTranslationAffectedOnly public function
ContentEntityBase::isLatestRevision public function
ContentEntityBase::isLatestTranslationAffectedRevision public function
ContentEntityBase::isNewRevision public function
ContentEntityBase::isNewTranslation public function
ContentEntityBase::isRevisionTranslationAffected public function
ContentEntityBase::isRevisionTranslationAffectedEnforced public function
ContentEntityBase::isTranslatable public function
ContentEntityBase::isValidationRequired public function
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
ContentEntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityBase::postCreate 1
ContentEntityBase::preSaveRevision public function 3
ContentEntityBase::removeTranslation public function
ContentEntityBase::set public function
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
ContentEntityBase::setRevisionTranslationAffected public function
ContentEntityBase::setRevisionTranslationAffectedEnforced public function
ContentEntityBase::setValidationRequired public function
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
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 1
ContentEntityBase::wasDefaultRevision public function
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.
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
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
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::$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::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::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::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface::preDelete 7
EntityBase::save public function Saves an entity permanently. Overrides EntityInterface::save 3
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
EntityOwnerTrait::getDefaultEntityOwner public static function Default value callback for 'owner' base field. 1
EntityOwnerTrait::getOwnerId public function
EntityOwnerTrait::ownerBaseFieldDefinitions public static function Returns an array of base field definitions for entity owners.
EntityOwnerTrait::setOwner public function
EntityOwnerTrait::setOwnerId public function
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
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.