interface TranslatableRevisionableInterface
Same name in other branches
- 9 core/lib/Drupal/Core/Entity/TranslatableRevisionableInterface.php \Drupal\Core\Entity\TranslatableRevisionableInterface
- 10 core/lib/Drupal/Core/Entity/TranslatableRevisionableInterface.php \Drupal\Core\Entity\TranslatableRevisionableInterface
- 11.x core/lib/Drupal/Core/Entity/TranslatableRevisionableInterface.php \Drupal\Core\Entity\TranslatableRevisionableInterface
Provides methods for an entity to support revision translation.
Hierarchy
- interface \Drupal\Core\Entity\RevisionableInterface extends \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Entity\TranslatableInterface extends \Drupal\Core\TypedData\TranslatableInterface \Drupal\Core\Entity\EntityInterface
- interface \Drupal\Core\Entity\TranslatableRevisionableInterface extends \Drupal\Core\Entity\TranslatableInterface \Drupal\Core\Entity\RevisionableInterface
Expanded class hierarchy of TranslatableRevisionableInterface
All classes that implement TranslatableRevisionableInterface
File
-
core/
lib/ Drupal/ Core/ Entity/ TranslatableRevisionableInterface.php, line 8
Namespace
Drupal\Core\EntityView source
interface TranslatableRevisionableInterface extends TranslatableInterface, RevisionableInterface {
/**
* Checks whether this is the latest revision affecting this translation.
*
* @return bool
* TRUE if this revision is the latest one affecting the active translation,
* FALSE otherwise.
*/
public function isLatestTranslationAffectedRevision();
/**
* Marks the current revision translation as affected.
*
* Setting the revision translation affected flag through the setter or
* through the field directly will always enforce it, which will be used by
* the entity storage to determine if the flag should be recomputed or the set
* value should be used instead.
* @see \Drupal\Core\Entity\ContentEntityStorageBase::populateAffectedRevisionTranslations()
*
* @param bool|null $affected
* The flag value. A NULL value can be specified to reset the current value
* and make sure a new value will be computed by the system.
*
* @return $this
*/
public function setRevisionTranslationAffected($affected);
/**
* Checks whether the current translation is affected by the current revision.
*
* @return bool
* TRUE if the entity object is affected by the current revision, FALSE
* otherwise.
*/
public function isRevisionTranslationAffected();
/**
* Checks if the revision translation affected flag value has been enforced.
*
* @return bool
* TRUE if revision translation affected flag is enforced, FALSE otherwise.
*
* @internal
*/
public function isRevisionTranslationAffectedEnforced();
/**
* Enforces the revision translation affected flag value.
*
* Note that this method call will not have any influence on the storage if
* the value of the revision translation affected flag is NULL which is used
* as an indication for the storage to recompute the flag.
* @see \Drupal\Core\Entity\ContentEntityInterface::setRevisionTranslationAffected()
*
* @param bool $enforced
* If TRUE, the value of the revision translation affected flag will be
* enforced so that on entity save the entity storage will not recompute it.
* Otherwise the storage will recompute it.
*
* @return $this
*
* @internal
*/
public function setRevisionTranslationAffectedEnforced($enforced);
/**
* Checks if untranslatable fields should affect only the default translation.
*
* @return bool
* TRUE if untranslatable fields should affect only the default translation,
* FALSE otherwise.
*/
public function isDefaultTranslationAffectedOnly();
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overrides |
---|---|---|---|---|---|
AccessibleInterface::access | public | function | Checks data value access. | 9 | |
CacheableDependencyInterface::getCacheContexts | public | function | The cache contexts associated with this object. | 34 | |
CacheableDependencyInterface::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | 34 | |
CacheableDependencyInterface::getCacheTags | public | function | The cache tags associated with this object. | 27 | |
EntityInterface::bundle | public | function | Gets the bundle of the entity. | 2 | |
EntityInterface::create | public static | function | Constructs a new entity object, without permanently saving it. | 2 | |
EntityInterface::createDuplicate | public | function | Creates a duplicate of the entity. | 2 | |
EntityInterface::delete | public | function | Deletes an entity permanently. | 2 | |
EntityInterface::enforceIsNew | public | function | Enforces an entity to be new. | 2 | |
EntityInterface::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | 2 | |
EntityInterface::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | 2 | |
EntityInterface::getConfigDependencyName | public | function | Gets the configuration dependency name. | 2 | |
EntityInterface::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | 2 | |
EntityInterface::getEntityType | public | function | Gets the entity type definition. | 2 | |
EntityInterface::getEntityTypeId | public | function | Gets the ID of the type of the entity. | 2 | |
EntityInterface::getOriginalId | public | function | Gets the original ID. | 2 | |
EntityInterface::getTypedData | public | function | Gets a typed data object for this entity object. | 2 | |
EntityInterface::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | 2 | |
EntityInterface::id | public | function | Gets the identifier. | 2 | |
EntityInterface::isNew | public | function | Determines whether the entity is new. | 2 | |
EntityInterface::label | public | function | Gets the label of the entity. | 2 | |
EntityInterface::link | Deprecated | public | function | Deprecated way of generating a link to the entity. See toLink(). | 2 |
EntityInterface::load | public static | function | Loads an entity. | 2 | |
EntityInterface::loadMultiple | public static | function | Loads one or more entities. | 2 | |
EntityInterface::postCreate | public | function | Acts on a created entity before hooks are invoked. | 2 | |
EntityInterface::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | 2 | |
EntityInterface::postLoad | public static | function | Acts on loaded entities. | 3 | |
EntityInterface::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | 2 | |
EntityInterface::preCreate | public static | function | Changes the values of an entity before it is created. | 2 | |
EntityInterface::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | 2 | |
EntityInterface::preSave | public | function | Acts on an entity before the presave hook is invoked. | 2 | |
EntityInterface::referencedEntities | public | function | Gets a list of entities referenced by this entity. | 2 | |
EntityInterface::save | public | function | Saves an entity permanently. | 2 | |
EntityInterface::setOriginalId | public | function | Sets the original ID. | 2 | |
EntityInterface::toArray | public | function | Gets an array of all property values. | 3 | |
EntityInterface::toLink | public | function | Generates the HTML for a link to this entity. | 2 | |
EntityInterface::toUrl | public | function | Gets the URL object for the entity. | 2 | |
EntityInterface::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | 2 | |
EntityInterface::url | Deprecated | public | function | Gets the public URL for this entity. | 2 |
EntityInterface::urlInfo | Deprecated | public | function | Gets the URL object for the entity. | 2 |
EntityInterface::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | 2 | |
RefinableCacheableDependencyInterface::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. | 1 | |
RefinableCacheableDependencyInterface::addCacheContexts | public | function | Adds cache contexts. | 1 | |
RefinableCacheableDependencyInterface::addCacheTags | public | function | Adds cache tags. | 1 | |
RefinableCacheableDependencyInterface::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. | 1 | |
RevisionableInterface::getLoadedRevisionId | public | function | Gets the loaded Revision ID of the entity. | ||
RevisionableInterface::getRevisionId | public | function | Gets the revision identifier of the entity. | ||
RevisionableInterface::isDefaultRevision | public | function | Checks if this entity is the default revision. | ||
RevisionableInterface::isLatestRevision | public | function | Checks if this entity is the latest revision. | ||
RevisionableInterface::isNewRevision | public | function | Determines whether a new revision should be created on save. | ||
RevisionableInterface::preSaveRevision | public | function | Acts on a revision before it gets saved. | ||
RevisionableInterface::setNewRevision | public | function | Enforces an entity to be saved as a new revision. | ||
RevisionableInterface::updateLoadedRevisionId | public | function | Updates the loaded Revision ID with the revision ID. | ||
RevisionableInterface::wasDefaultRevision | public | function | Checks whether the entity object was a default revision when it was saved. | ||
TranslatableInterface::addTranslation | public | function | Adds a new translation to the translatable object. | ||
TranslatableInterface::getTranslation | public | function | Gets a translation of the data. | ||
TranslatableInterface::getTranslationLanguages | public | function | Returns the languages the data is translated to. | ||
TranslatableInterface::getUntranslated | public | function | Returns the translatable object referring to the original language. | ||
TranslatableInterface::hasTranslation | public | function | Checks there is a translation for the given language code. | ||
TranslatableInterface::hasTranslationChanges | public | function | Determines if the current translation of the entity has unsaved changes. | ||
TranslatableInterface::isDefaultTranslation | public | function | Checks whether the translation is the default one. | ||
TranslatableInterface::isNewTranslation | public | function | Checks whether the translation is new. | ||
TranslatableInterface::isTranslatable | public | function | Returns the translation support status. | ||
TranslatableInterface::language | public | function | Returns the translation language. | ||
TranslatableInterface::removeTranslation | public | function | Removes the translation identified by the given language code. | ||
TranslatableRevisionableInterface::isDefaultTranslationAffectedOnly | public | function | Checks if untranslatable fields should affect only the default translation. | ||
TranslatableRevisionableInterface::isLatestTranslationAffectedRevision | public | function | Checks whether this is the latest revision affecting this translation. | ||
TranslatableRevisionableInterface::isRevisionTranslationAffected | public | function | Checks whether the current translation is affected by the current revision. | ||
TranslatableRevisionableInterface::isRevisionTranslationAffectedEnforced | public | function | Checks if the revision translation affected flag value has been enforced. | ||
TranslatableRevisionableInterface::setRevisionTranslationAffected | public | function | Marks the current revision translation as affected. | ||
TranslatableRevisionableInterface::setRevisionTranslationAffectedEnforced | public | function | Enforces the revision translation affected flag value. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.