interface LingotekModerationHandlerInterface in Lingotek Translation 3.0.x

Moderation handler managing the Lingotek integration.

@package Drupal\lingotek\Moderation

Hierarchy

• interface \Drupal\lingotek\Moderation\LingotekModerationServiceInterface
  • interface \Drupal\lingotek\Moderation\LingotekModerationHandlerInterface

1 file declares its use of LingotekModerationHandlerInterface

LingotekModerationFactoryTest.php in tests/src/Unit/Moderation/LingotekModerationFactoryTest.php

File

src/Moderation/LingotekModerationHandlerInterface.php, line 13

Namespace

Drupal\lingotek\Moderation

interface LingotekModerationHandlerInterface extends LingotekModerationServiceInterface {

  /**
   * Checks if we should prevent upload based on content moderation settings.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The content entity.
   *
   * @return bool
   *   Returns TRUE if we should prevent the upload based on content moderation.
   */
  public function shouldModerationPreventUpload(EntityInterface $entity);

  /**
   * Performs a moderation transition if needed.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity.
   */
  public function performModerationTransitionIfNeeded(ContentEntityInterface &$entity);

  /**
   * Gets the moderation state ID.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity.
   *
   * @return string
   *   The moderation state ID.
   */
  public function getModerationState(ContentEntityInterface $entity);

  /**
   * Sets the moderation state ID.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity.
   * @param string $state
   *   The moderation state ID.
   */
  public function setModerationState(ContentEntityInterface $entity, $state);

  /**
   * Checks if the moderation is enabled for this entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The content entity.
   *
   * @return bool
   *   If moderation is enabled, returns TRUE. Returns FALSE otherwise.
   */
  public function isModerationEnabled(EntityInterface $entity);

}

Members

Name	Modifiers	Type	Description	Overrides
LingotekModerationHandlerInterface::getModerationState	public	function	Gets the moderation state ID.	2
LingotekModerationHandlerInterface::isModerationEnabled	public	function	Checks if the moderation is enabled for this entity.	2
LingotekModerationHandlerInterface::performModerationTransitionIfNeeded	public	function	Performs a moderation transition if needed.	2
LingotekModerationHandlerInterface::setModerationState	public	function	Sets the moderation state ID.	2
LingotekModerationHandlerInterface::shouldModerationPreventUpload	public	function	Checks if we should prevent upload based on content moderation settings.	2
LingotekModerationServiceInterface::applies	public	function	Checks if this service applies.
LingotekModerationServiceInterface::setModuleHandler	public	function	Sets the module handler for this service.