class Comment in Zircon Profile 8
Same name in this branch
- 8 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
- 8 core/modules/comment/src/Plugin/views/wizard/Comment.php \Drupal\comment\Plugin\views\wizard\Comment
- 8 core/modules/comment/src/Plugin/migrate/source/d6/Comment.php \Drupal\comment\Plugin\migrate\source\d6\Comment
- 8 core/modules/comment/src/Plugin/migrate/source/d7/Comment.php \Drupal\comment\Plugin\migrate\source\d7\Comment
Same name and namespace in other branches
- 8.0 core/modules/comment/src/Entity/Comment.php \Drupal\comment\Entity\Comment
Defines the comment entity class.
Plugin annotation
@ContentEntityType(
id = "comment",
label = @Translation("Comment"),
bundle_label = @Translation("Content 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"
},
links = {
"canonical" = "/comment/{comment}",
"delete-form" = "/comment/{comment}/delete",
"edit-form" = "/comment/{comment}/edit",
},
bundle_entity_type = "comment_type",
field_ui_base_route = "entity.comment_type.edit_form",
constraints = {
"CommentName" = {}
}
)
Hierarchy
- class \Drupal\Core\Entity\Entity implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface
- class \Drupal\comment\Entity\Comment implements CommentInterface uses EntityChangedTrait
- class \Drupal\Core\Entity\ContentEntityBase implements \Drupal\Core\Entity\IteratorAggregate, ContentEntityInterface
Expanded class hierarchy of Comment
24 files declare their use of Comment
- ArgumentUserUIDTest.php in core/
modules/ comment/ src/ Tests/ Views/ ArgumentUserUIDTest.php - Contains \Drupal\comment\Tests\Views\ArgumentUserUIDTest.
- CommentActionsTest.php in core/
modules/ comment/ src/ Tests/ CommentActionsTest.php - Contains \Drupal\comment\Tests\CommentActionsTest.
- CommentCacheTagsTest.php in core/
modules/ comment/ src/ Tests/ CommentCacheTagsTest.php - Contains \Drupal\comment\Tests\CommentCacheTagsTest.
- CommentFieldAccessTest.php in core/
modules/ comment/ src/ Tests/ CommentFieldAccessTest.php - Contains \Drupal\comment\Tests\CommentFieldAccessTest.
- CommentFieldNameTest.php in core/
modules/ comment/ src/ Tests/ Views/ CommentFieldNameTest.php - Contains \Drupal\comment\Tests\Views\CommentFieldNameTest.
13 string references to 'Comment'
- 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
- comment.views.schema.yml in core/
modules/ comment/ config/ schema/ comment.views.schema.yml - core/modules/comment/config/schema/comment.views.schema.yml
- CommentManager::addBodyField in core/
modules/ comment/ src/ CommentManager.php - Creates a comment_body field.
File
- core/
modules/ comment/ src/ Entity/ Comment.php, line 65 - Contains \Drupal\comment\Entity\Comment.
Namespace
Drupal\comment\EntityView source
class Comment extends ContentEntityBase implements CommentInterface {
use EntityChangedTrait;
/**
* The thread for which a lock was acquired.
*/
protected $threadLock = '';
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) {
parent::preSave($storage);
if (is_null($this
->get('status')->value)) {
$published = \Drupal::currentUser()
->hasPermission('skip comment approval') ? CommentInterface::PUBLISHED : CommentInterface::NOT_PUBLISHED;
$this
->setPublished($published);
}
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($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;
}
// We test the value with '===' because we need to modify anonymous
// users as well.
if ($this
->getOwnerId() === \Drupal::currentUser()
->id() && \Drupal::currentUser()
->isAuthenticated()) {
$this
->setAuthorName(\Drupal::currentUser()
->getUsername());
}
// Add the values which aren't passed into the function.
$this
->setThread($thread);
$this
->setHostname(\Drupal::request()
->getClientIP());
}
}
/**
* {@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);
entity_delete_multiple('comment', $child_cids);
foreach ($entities as $id => $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() {
$entity = $this
->getCommentedEntity();
$uri = $entity
->urlInfo();
$uri
->setOption('fragment', 'comment-' . $this
->id());
return $uri;
}
/**
* {@inheritdoc}
*/
public static function baseFieldDefinitions(EntityTypeInterface $entity_type) {
$fields['cid'] = BaseFieldDefinition::create('integer')
->setLabel(t('Comment ID'))
->setDescription(t('The comment ID.'))
->setReadOnly(TRUE)
->setSetting('unsigned', TRUE);
$fields['uuid'] = BaseFieldDefinition::create('uuid')
->setLabel(t('UUID'))
->setDescription(t('The comment UUID.'))
->setReadOnly(TRUE);
$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['langcode'] = BaseFieldDefinition::create('language')
->setLabel(t('Language'))
->setDescription(t('The comment language code.'))
->setTranslatable(TRUE)
->setDisplayOptions('view', array(
'type' => 'hidden',
))
->setDisplayOptions('form', array(
'type' => 'language_select',
'weight' => 2,
));
$fields['subject'] = BaseFieldDefinition::create('string')
->setLabel(t('Subject'))
->setTranslatable(TRUE)
->setSetting('max_length', 64)
->setDisplayOptions('form', array(
'type' => 'string_textfield',
// Default comment body field has weight 20.
'weight' => 10,
))
->setDisplayConfigurable('form', TRUE);
$fields['uid'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('User ID'))
->setDescription(t('The user ID of the comment author.'))
->setTranslatable(TRUE)
->setSetting('target_type', 'user')
->setDefaultValue(0);
$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);
$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['status'] = BaseFieldDefinition::create('boolean')
->setLabel(t('Publishing status'))
->setDescription(t('A boolean indicating whether the comment is published.'))
->setTranslatable(TRUE)
->setDefaultValue(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'))
->setDescription(t('The entity type to which this comment is attached.'))
->setSetting('is_ascii', TRUE)
->setSetting('max_length', EntityTypeInterface::ID_MAX_LENGTH);
$fields['comment_type'] = BaseFieldDefinition::create('entity_reference')
->setLabel(t('Comment Type'))
->setDescription(t('The comment type.'))
->setSetting('target_type', 'comment_type');
$fields['field_name'] = BaseFieldDefinition::create('string')
->setLabel(t('Comment field name'))
->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 array();
}
/**
* {@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 ($this
->get('uid')->target_id) {
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 isPublished() {
return $this
->get('status')->value == CommentInterface::PUBLISHED;
}
/**
* {@inheritdoc}
*/
public function getStatus() {
return $this
->get('status')->value;
}
/**
* {@inheritdoc}
*/
public function setPublished($status) {
$this
->set('status', $status ? CommentInterface::PUBLISHED : CommentInterface::NOT_PUBLISHED);
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'])) {
$field_storage = FieldStorageConfig::loadByName($values['entity_type'], $values['field_name']);
$values['comment_type'] = $field_storage
->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;
}
/**
* {@inheritdoc}
*/
public function getOwnerId() {
return $this
->get('uid')->target_id;
}
/**
* {@inheritdoc}
*/
public function setOwnerId($uid) {
$this
->set('uid', $uid);
return $this;
}
/**
* {@inheritdoc}
*/
public function setOwner(UserInterface $account) {
$this
->set('uid', $account
->id());
return $this;
}
/**
* Get the comment type ID for this comment.
*
* @return string
* The ID of the comment type.
*/
public function getTypeId() {
return $this
->bundle();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Comment:: |
protected | property | The thread for which a lock was acquired. | |
Comment:: |
public static | function |
Provides base field definitions for an entity type. Overrides FieldableEntityInterface:: |
|
Comment:: |
public static | function |
Provides field definitions for a specific bundle. Overrides ContentEntityBase:: |
|
Comment:: |
public | function |
Returns the comment author's email address. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the comment author's name. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the entity to which the comment is attached. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the ID of the entity to which the comment is attached. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the type of the entity to which the comment is attached. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the time that the comment was created. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the name of the field the comment is attached to. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the comment author's home page address. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the comment author's hostname. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the entity owner's user entity. Overrides EntityOwnerInterface:: |
|
Comment:: |
public | function |
Returns the entity owner's user ID. Overrides EntityOwnerInterface:: |
|
Comment:: |
public | function |
Returns the parent comment entity if this is a reply to a comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the comment's status. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the subject of the comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the alphadecimal representation of the comment's place in a thread. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Get the comment type ID for this comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Determines if this comment is a reply to another comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Checks if the comment is published. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Returns the permalink URL for this comment. Overrides CommentInterface:: |
|
Comment:: |
public static | function |
Acts on deleted entities before the delete hook is invoked. Overrides Entity:: |
|
Comment:: |
public | function |
Acts on a saved entity before the insert or update hook is invoked. Overrides Entity:: |
|
Comment:: |
public static | function |
Changes the values of an entity before it is created. Overrides Entity:: |
|
Comment:: |
public | function |
Acts on an entity before the presave hook is invoked. Overrides ContentEntityBase:: |
|
Comment:: |
public | function |
Gets a list of entities referenced by this entity. Overrides ContentEntityBase:: |
|
Comment:: |
protected | function | Release the lock acquired for the thread in preSave(). | |
Comment:: |
public | function |
Sets the name of the author of the comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the creation date of the comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the field ID for which this comment is attached. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the comment author's home page address. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the hostname of the author of the comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the entity owner's user entity. Overrides EntityOwnerInterface:: |
|
Comment:: |
public | function |
Sets the entity owner's user ID. Overrides EntityOwnerInterface:: |
|
Comment:: |
public | function |
Sets the published status of the comment entity. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the subject of the comment. Overrides CommentInterface:: |
|
Comment:: |
public | function |
Sets the alphadecimal representation of the comment's place in a thread. Overrides CommentInterface:: |
|
CommentInterface:: |
constant | Comment is awaiting approval. | ||
CommentInterface:: |
constant | Comment is published. | ||
ContentEntityBase:: |
protected | property | Language code identifying the entity active language. | |
ContentEntityBase:: |
protected | property | Local cache for the default language code. | |
ContentEntityBase:: |
protected | property | The default langcode entity key. | |
ContentEntityBase:: |
protected | property | Holds untranslatable entity keys such as the ID, bundle, and revision ID. | |
ContentEntityBase:: |
protected | property | Local cache for field definitions. | |
ContentEntityBase:: |
protected | property | The array of fields, each being an instance of FieldItemListInterface. | |
ContentEntityBase:: |
protected | property | Indicates whether this is the default revision. | |
ContentEntityBase:: |
protected | property | The language entity key. | |
ContentEntityBase:: |
protected | property | Local cache for the available language objects. | |
ContentEntityBase:: |
protected | property | Boolean indicating whether a new revision should be created on save. | |
ContentEntityBase:: |
protected | property | Holds translatable entity keys such as the label. | |
ContentEntityBase:: |
protected | property | A flag indicating whether a translation object is being initialized. | |
ContentEntityBase:: |
protected | property | An array of entity translation metadata. | |
ContentEntityBase:: |
protected | property | Whether entity validation was performed. | |
ContentEntityBase:: |
protected | property | Whether entity validation is required before saving the entity. | |
ContentEntityBase:: |
protected | property | The plain data values of the contained fields. | |
ContentEntityBase:: |
public | function |
Checks data value access. Overrides Entity:: |
1 |
ContentEntityBase:: |
public | function |
Adds a new translation to the translatable object. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the bundle of the entity. Overrides Entity:: |
|
ContentEntityBase:: |
protected | function | Clear entity translation object cache to remove stale references. | |
ContentEntityBase:: |
public | function |
Creates a duplicate of the entity. Overrides Entity:: |
1 |
ContentEntityBase:: |
public | function |
Gets a field item list. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets the value of the given entity key, if defined. | |
ContentEntityBase:: |
public | function |
Gets the definition of a contained field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field definitions of all contained fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all field item lists. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function | ||
ContentEntityBase:: |
protected | function | ||
ContentEntityBase:: |
public | function |
Gets the revision identifier of the entity. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of field item lists for translatable fields. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Gets a translated field. | |
ContentEntityBase:: |
public | function |
Gets a translation of the data. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the languages the data is translated to. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translatable object referring to the original language. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether the entity has a field with the given name. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Returns TRUE there is a translation for the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines if the current translation of the entity has unsaved changes. Overrides ContentEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the identifier. Overrides Entity:: |
|
ContentEntityBase:: |
protected | function | Instantiates a translation object for an existing translation. | |
ContentEntityBase:: |
public | function |
Checks if this entity is the default revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is the default one. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Determines whether a new revision should be created on save. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the translation is new. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether the current translation is affected by the current revision. Overrides ContentEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Returns the translation support status. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Checks whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets the label of the entity. Overrides Entity:: |
3 |
ContentEntityBase:: |
public | function |
Gets the language of the entity. Overrides Entity:: |
|
ContentEntityBase:: |
public | function |
Reacts to changes to a field. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Acts on an entity after it is created but before hooks are invoked. Overrides Entity:: |
|
ContentEntityBase:: |
public | function |
Acts on a revision before it gets saved. Overrides RevisionableInterface:: |
2 |
ContentEntityBase:: |
public | function |
Removes the translation identified by the given language code. Overrides TranslatableInterface:: |
|
ContentEntityBase:: |
public | function |
Sets a field value. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
protected | function | Populates the local cache for the default language code. | |
ContentEntityBase:: |
public | function |
Enforces an entity to be saved as a new revision. Overrides RevisionableInterface:: |
|
ContentEntityBase:: |
public | function |
Marks the current revision translation as affected. Overrides ContentEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Sets whether entity validation is required before saving the entity. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function |
Gets an array of all property values. Overrides Entity:: |
|
ContentEntityBase:: |
constant | Status code identifying a newly created translation. | ||
ContentEntityBase:: |
constant | Status code identifying an existing translation. | ||
ContentEntityBase:: |
constant | Status code identifying a removed translation. | ||
ContentEntityBase:: |
protected | function | Updates language for already instantiated fields. | |
ContentEntityBase:: |
public | function | Updates the original values with the interim changes. | |
ContentEntityBase:: |
public | function |
Gets the entity UUID (Universally Unique Identifier). Overrides Entity:: |
|
ContentEntityBase:: |
public | function |
Validates the currently set values. Overrides FieldableEntityInterface:: |
|
ContentEntityBase:: |
public | function | Magic method: Implements a deep clone. | |
ContentEntityBase:: |
public | function |
Constructs an Entity object. Overrides Entity:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for getting object properties. | |
ContentEntityBase:: |
public | function | Implements the magic method for isset(). | |
ContentEntityBase:: |
public | function | Implements the magic method for setting object properties. | |
ContentEntityBase:: |
public | function |
Overrides Entity:: |
|
ContentEntityBase:: |
public | function | Implements the magic method for unset(). | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | Aliased as: traitSleep | 1 |
DependencySerializationTrait:: |
public | function | 2 | |
Entity:: |
protected | property | Boolean indicating whether the entity should be forced to be new. | |
Entity:: |
protected | property | The entity type. | |
Entity:: |
protected | property | A typed data object wrapping this entity. | |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public | function |
Deletes an entity permanently. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Enforces an entity to be new. Overrides EntityInterface:: |
|
Entity:: |
protected | function | Gets the entity manager. | |
Entity:: |
protected | function | Gets the entity type manager. | |
Entity:: |
public | function |
The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait:: |
|
Entity:: |
public | function |
Returns the cache tags that should be used to invalidate caches. Overrides EntityInterface:: |
3 |
Entity:: |
public | function |
Gets the key that is used to store configuration dependencies. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the configuration dependency name. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Gets the configuration target identifier for the entity. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Gets the entity type definition. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the ID of the type of the entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the original ID. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Gets a typed data object for this entity object. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Indicates if a link template exists for a given key. Overrides EntityInterface:: |
|
Entity:: |
protected static | function | Invalidates an entity's cache tags upon delete. | 1 |
Entity:: |
protected | function | Invalidates an entity's cache tags upon save. | 1 |
Entity:: |
public | function |
Determines whether the entity is new. Overrides EntityInterface:: |
2 |
Entity:: |
protected | function | Gets the language manager. | |
Entity:: |
public | function |
Deprecated way of generating a link to the entity. See toLink(). Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets an array link templates. | 1 |
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public static | function |
Overrides EntityInterface:: |
|
Entity:: |
public static | function |
Acts on loaded entities. Overrides EntityInterface:: |
2 |
Entity:: |
public static | function |
Acts on entities before they are deleted and before hooks are invoked. Overrides EntityInterface:: |
5 |
Entity:: |
public | function |
Saves an entity permanently. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Sets the original ID. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Generates the HTML for a link to this entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
Entity:: |
public | function |
Returns a list of URI relationships supported by this entity. Overrides EntityInterface:: |
|
Entity:: |
public | function |
Gets the public URL for this entity. Overrides EntityInterface:: |
2 |
Entity:: |
public | function |
Gets the URL object for the entity. Overrides EntityInterface:: |
1 |
Entity:: |
protected | function | Gets an array of placeholders for this entity. | 1 |
Entity:: |
protected | function | Gets the UUID generator. | |
EntityChangedTrait:: |
public | function | Gets the timestamp of the last entity change for the current translation. | |
EntityChangedTrait:: |
public | function | Returns the timestamp of the last entity change across all translations. | |
EntityChangedTrait:: |
public | function | Sets the timestamp of the last entity change for the current translation. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache contexts. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache max-age. | |
RefinableCacheableDependencyTrait:: |
protected | property | Cache tags. | |
RefinableCacheableDependencyTrait:: |
public | function | 1 | |
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function | ||
RefinableCacheableDependencyTrait:: |
public | function |