You are here

Home » API reference » Config Entity Revisions 1.x » ConfigEntityRevisionsInterface.php

interface ConfigEntityRevisionsInterface in Config Entity Revisions 1.x

Same name and namespace in other branches
  1. 8 src/ConfigEntityRevisionsInterface.php \Drupal\config_entity_revisions\ConfigEntityRevisionsInterface

ConfigEntityRevisionsInterface.

Adds revision related fields to a configuration entity.

Hierarchy

Expanded class hierarchy of ConfigEntityRevisionsInterface

All classes that implement ConfigEntityRevisionsInterface

6 files declare their use of ConfigEntityRevisionsInterface
ConfigEntityRevisionsRevertFormBaseTest.php in tests/src/Unit/ConfigEntityRevisionsRevertFormBaseTest.php
ViewsRevisions.php in modules/views_revisions/src/Entity/ViewsRevisions.php
views_revisions.module in modules/views_revisions/views_revisions.module
WebformRevisions.php in modules/webform_revisions/src/Entity/WebformRevisions.php
WebformRevisionsSubmission.php in modules/webform_revisions/src/Entity/WebformRevisionsSubmission.php

... See full list

File

src/ConfigEntityRevisionsInterface.php, line 16

Namespace

Drupal\config_entity_revisions
View source 
interface ConfigEntityRevisionsInterface extends ConfigEntityInterface {

  /**
   * @return string
   *   The name of the module implementing the API.
   */
  public function module_name();

  /**
   * @return string
   *   The name of the entity being revisioned.
   */
  public function config_entity_name();

  /**
   * @return string
   *   The name of the content entity in which revisions are being stored.
   */
  public function revisions_entity_name();

  /**
   * @return string
   *   The name of the setting on the config entity in which content entity
   *   ids are stored.
   */
  public function setting_name();

  /**
   * @return string
   *   The proper name (displayed to the user) of the module implementing the
   *   API.
   */
  public function title();

  /**
   * @return boolean
   *   Does the config entity have its own content entities?
   */
  public function has_own_content();

  /**
   * @return string
   *   The name of the content entities that the config entity has.
   */
  public function content_entity_type();

  /**
   * @return string
   *   @TODO.
   */
  public function content_parameter_name();

  /**
   * @return string
   *   @TODO.
   */
  public function content_parent_reference_field();

  /**
   * @return string
   *   The name of the module implementing the API.
   */
  public function admin_permission();

  /**
   * Get the config entity storage.
   *
   * @return ConfigEntityStorageInterface
   *   The storage for the config entity.
   */
  public function configEntityStorage();

  /**
   * Get the revisions entity storage.
   *
   * @return ContentEntityStorageInterface
   *   The storage for the revisions entity.
   */
  public function contentEntityStorage();

  /**
   * Set in the configEntity an identifier for the matching content entity.
   *
   * @param mixed $contentEntityID
   *   The ID used to match the content entity.
   */
  public function setContentEntityID($contentEntityID);

  /**
   * Get from the configEntity the ID of the matching content entity.
   *
   * @return int|null
   *   The ID (if any) of the matching content entity.
   */
  public function getContentEntityID();

  /**
   * Default revision of revisions entity that matches the config entity.
   *
   * @return \Drupal\Core\Entity\EntityInterface|null
   *   The matching entity.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  public function getContentEntity();

  /**
   * Gets the revision identifier of the entity.
   *
   * @return int
   *   The revision identifier of the entity, or NULL if the entity does not
   *   have a revision identifier.
   */
  public function getRevisionId();

  /**
   * Set revision ID.
   *
   * @param int $revisionID
   *   The revision ID that this class instance represents.
   */
  public function updateLoadedRevisionId($revisionID);

}

Members

Namesort descending Modifiers Type Description 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
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
ConfigEntityRevisionsInterface::admin_permission public function
ConfigEntityRevisionsInterface::configEntityStorage public function Get the config entity storage.
ConfigEntityRevisionsInterface::config_entity_name public function
ConfigEntityRevisionsInterface::contentEntityStorage public function Get the revisions entity storage.
ConfigEntityRevisionsInterface::content_entity_type public function
ConfigEntityRevisionsInterface::content_parameter_name public function
ConfigEntityRevisionsInterface::content_parent_reference_field public function
ConfigEntityRevisionsInterface::getContentEntity public function Default revision of revisions entity that matches the config entity.
ConfigEntityRevisionsInterface::getContentEntityID public function Get from the configEntity the ID of the matching content entity. 2
ConfigEntityRevisionsInterface::getRevisionId public function Gets the revision identifier of the entity.
ConfigEntityRevisionsInterface::has_own_content public function
ConfigEntityRevisionsInterface::module_name public function
ConfigEntityRevisionsInterface::revisions_entity_name public function
ConfigEntityRevisionsInterface::setContentEntityID public function Set in the configEntity an identifier for the matching content entity. 2
ConfigEntityRevisionsInterface::setting_name public function
ConfigEntityRevisionsInterface::title public function
ConfigEntityRevisionsInterface::updateLoadedRevisionId public function Set revision ID.
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::language public function Gets the language of the entity. 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::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
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5