interface ModerationInformationInterface in Config Entity Revisions 8.2
Interface for moderation_information service.
Doesn't extend the content_moderation version because we're making a less restrictive version (ContentEntityInterface -> EntityInterface).
Hierarchy
- interface \Drupal\config_entity_revisions\ModerationInformationInterface
Expanded class hierarchy of ModerationInformationInterface
All classes that implement ModerationInformationInterface
File
- src/
ModerationInformationInterface.php, line 15
Namespace
Drupal\config_entity_revisionsView source
interface ModerationInformationInterface {
/**
* Determines if an entity is moderated.
*
* @param \Drupal\Core\Entity\EntityInterface $entity
* The entity we may be moderating.
*
* @return bool
* TRUE if this entity is moderated, FALSE otherwise.
*/
public function isModeratedEntity(EntityInterface $entity);
/**
* Determines if an entity type can have moderated entities.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* An entity type object.
*
* @return bool
* TRUE if this entity type can have moderated entities, FALSE otherwise.
*/
public function canModerateEntitiesOfEntityType(EntityTypeInterface $entity_type);
/**
* Determines if an entity type/bundle entities should be moderated.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type definition to check.
* @param string $bundle
* The bundle to check.
*
* @return bool
* TRUE if an entity type/bundle entities should be moderated, FALSE
* otherwise.
*/
public function shouldModerateEntitiesOfBundle(EntityTypeInterface $entity_type, $bundle);
/**
* Loads the latest revision of a specific entity.
*
* @param string $entity_type_id
* The entity type ID.
* @param int $entity_id
* The entity ID.
*
* @return \Drupal\Core\Entity\ContentEntityInterface|null
* The latest entity revision or NULL, if the entity type / entity doesn't
* exist.
*/
public function getLatestRevision($entity_type_id, $entity_id);
/**
* Returns the revision ID of the latest revision of the given entity.
*
* @param string $entity_type_id
* The entity type ID.
* @param int $entity_id
* The entity ID.
*
* @return int
* The revision ID of the latest revision for the specified entity, or
* NULL if there is no such entity.
*/
public function getLatestRevisionId($entity_type_id, $entity_id);
/**
* Returns the revision ID of the default revision for the specified entity.
*
* @param string $entity_type_id
* The entity type ID.
* @param int $entity_id
* The entity ID.
*
* @return int
* The revision ID of the default revision, or NULL if the entity was
* not found.
*/
public function getDefaultRevisionId($entity_type_id, $entity_id);
/**
* Returns the revision translation affected translation of a revision.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The content entity.
*
* @return \Drupal\Core\Entity\ContentEntityInterface
* The revision translation affected translation.
*/
public function getAffectedRevisionTranslation(ContentEntityInterface $entity);
/**
* Determines if an entity is a latest revision.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* A revisionable content entity.
*
* @return bool
* TRUE if the specified object is the latest revision of its entity,
* FALSE otherwise.
*/
public function isLatestRevision(ContentEntityInterface $entity);
/**
* Determines if a pending revision exists for the specified entity.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The entity which may or may not have a pending revision.
*
* @return bool
* TRUE if this entity has pending revisions available, FALSE otherwise.
*/
public function hasPendingRevision(ContentEntityInterface $entity);
/**
* Determines if an entity is "live".
*
* A "live" entity revision is one whose latest revision is also the default,
* and whose moderation state, if any, is a published state.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The entity to check.
*
* @return bool
* TRUE if the specified entity is a live revision, FALSE otherwise.
*/
public function isLiveRevision(ContentEntityInterface $entity);
/**
* Determines if the default revision for the given entity is published.
*
* The default revision is the same as the entity retrieved by "default" from
* the storage handler. If the entity is translated, check if any of the
* translations are published.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The entity being saved.
*
* @return bool
* TRUE if the default revision is published. FALSE otherwise.
*/
public function isDefaultRevisionPublished(ContentEntityInterface $entity);
/**
* Gets the workflow for the given content entity.
*
* @param \Drupal\Core\Entity\ContentEntityInterface $entity
* The content entity to get the workflow for.
*
* @return \Drupal\workflows\WorkflowInterface|null
* The workflow entity. NULL if there is no workflow.
*/
public function getWorkflowForEntity(ContentEntityInterface $entity);
/**
* Gets unsupported features for a given entity type.
*
* @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
* The entity type to get the unsupported features for.
*
* @return array
* An array of unsupported features for this entity type.
*/
public function getUnsupportedFeatures(EntityTypeInterface $entity_type);
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ModerationInformationInterface:: |
public | function | Determines if an entity type can have moderated entities. | |
ModerationInformationInterface:: |
public | function | Returns the revision translation affected translation of a revision. | |
ModerationInformationInterface:: |
public | function | Returns the revision ID of the default revision for the specified entity. | |
ModerationInformationInterface:: |
public | function | Loads the latest revision of a specific entity. | |
ModerationInformationInterface:: |
public | function | Returns the revision ID of the latest revision of the given entity. | |
ModerationInformationInterface:: |
public | function | Gets unsupported features for a given entity type. | |
ModerationInformationInterface:: |
public | function | Gets the workflow for the given content entity. | |
ModerationInformationInterface:: |
public | function | Determines if a pending revision exists for the specified entity. | |
ModerationInformationInterface:: |
public | function | Determines if the default revision for the given entity is published. | |
ModerationInformationInterface:: |
public | function | Determines if an entity is a latest revision. | |
ModerationInformationInterface:: |
public | function | Determines if an entity is "live". | |
ModerationInformationInterface:: |
public | function | Determines if an entity is moderated. | |
ModerationInformationInterface:: |
public | function | Determines if an entity type/bundle entities should be moderated. |