Mercurial > hg > isophonics-drupal-site
diff core/lib/Drupal/Core/Entity/ContentEntityInterface.php @ 0:4c8ae668cc8c
Initial import (non-working)
author | Chris Cannam |
---|---|
date | Wed, 29 Nov 2017 16:09:58 +0000 |
parents | |
children | 1fec387a4317 |
line wrap: on
line diff
--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/core/lib/Drupal/Core/Entity/ContentEntityInterface.php Wed Nov 29 16:09:58 2017 +0000 @@ -0,0 +1,74 @@ +<?php + +namespace Drupal\Core\Entity; + +use Drupal\Core\TypedData\TranslatableInterface; + +/** + * Defines a common interface for all content entity objects. + * + * Content entities use fields for all their entity properties and are + * translatable and revisionable, while translations and revisions can be + * enabled per entity type. It's best practice to always implement + * ContentEntityInterface for content-like entities that should be stored in + * some database, and enable/disable revisions and translations as desired. + * + * When implementing this interface which extends Traversable, make sure to list + * IteratorAggregate or Iterator before this interface in the implements clause. + * + * @see \Drupal\Core\Entity\ContentEntityBase + * + * @ingroup entity_api + */ +interface ContentEntityInterface extends \Traversable, FieldableEntityInterface, RevisionableInterface, TranslatableInterface { + + /** + * Determines if the current translation of the entity has unsaved changes. + * + * @return bool + * TRUE if the current translation of the entity has changes. + */ + public function hasTranslationChanges(); + + /** + * Marks the current revision translation as affected. + * + * @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(); + + /** + * Gets the loaded Revision ID of the entity. + * + * @return int + * The loaded Revision identifier of the entity, or NULL if the entity + * does not have a revision identifier. + */ + public function getLoadedRevisionId(); + + /** + * Updates the loaded Revision ID with the revision ID. + * + * This method should not be used, it could unintentionally cause the original + * revision ID property value to be lost. + * + * @internal + * + * @return $this + */ + public function updateLoadedRevisionId(); + +}