class ModerationHandler in Workbench Moderation 8

Common customizations for most/all entities.

This class is intended primarily as a base class.

Hierarchy

• class \Drupal\workbench_moderation\Entity\Handler\ModerationHandler implements EntityHandlerInterface, ModerationHandlerInterface uses StringTranslationTrait

1 file declares its use of ModerationHandler

EntityTypeInfo.php in src/EntityTypeInfo.php

File

src/Entity/Handler/ModerationHandler.php, line 19

Namespace

Drupal\workbench_moderation\Entity\Handler

class ModerationHandler implements ModerationHandlerInterface, EntityHandlerInterface {
  use StringTranslationTrait;

  /**
   * {@inheritdoc}
   */
  public static function createInstance(ContainerInterface $container, EntityTypeInterface $entity_type) {
    return new static();
  }

  /**
   * {@inheritdoc}
   */
  public function onPresave(ContentEntityInterface $entity, $default_revision, $published_state) {

    // When entities are syncing, content moderation should not force a new
    // revision to be created and should not update the default status of a
    // revision. This is useful if changes are being made to entities or
    // revisions which are not part of editorial updates triggered by normal
    // content changes.
    if (!$entity
      ->isSyncing()) {
      $entity
        ->setNewRevision(TRUE);
      $entity
        ->isDefaultRevision($default_revision);
    }

    // Update publishing status if it can be updated and if it needs updating.
    if ($entity instanceof EntityPublishedInterface && $entity
      ->isPublished() !== $published_state) {
      $published_state ? $entity
        ->setPublished() : $entity
        ->setUnpublished();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function onBundleModerationConfigurationFormSubmit(ConfigEntityInterface $bundle) {

    // The Revisions portion of Entity API is not uniformly applied or
    // consistent. Until that's fixed in core, we'll make a best-attempt to
    // apply it to the common entity patterns so as to avoid every entity type
    // needing to implement this method, although some will still need to do so
    // for now. This is the API that should be universal, but isn't yet.
    // See NodeType for an example.
    if (method_exists($bundle, 'setNewRevision')) {
      $bundle
        ->setNewRevision(TRUE);
    }
    elseif ($bundle
      ->get('new_revision') !== NULL) {
      $bundle
        ->set('new_revision', TRUE);
    }
    elseif ($bundle
      ->get('revision') !== NULL) {
      $bundle
        ->set('revision', TRUE);
    }
    $bundle
      ->save();
  }

  /**
   * {@inheritdoc}
   */
  public function enforceRevisionsEntityFormAlter(array &$form, FormStateInterface $form_state, $form_id) {
  }

  /**
   * {@inheritdoc}
   */
  public function enforceRevisionsBundleFormAlter(array &$form, FormStateInterface $form_state, $form_id) {
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ModerationHandler::createInstance	public static	function	Instantiates a new instance of this entity handler. Overrides EntityHandlerInterface::createInstance
ModerationHandler::enforceRevisionsBundleFormAlter	public	function	Alters bundle forms to enforce revision handling. Overrides ModerationHandlerInterface::enforceRevisionsBundleFormAlter	2
ModerationHandler::enforceRevisionsEntityFormAlter	public	function	Alters entity forms to enforce revision handling. Overrides ModerationHandlerInterface::enforceRevisionsEntityFormAlter	2
ModerationHandler::onBundleModerationConfigurationFormSubmit	public	function	Operates on the bundle definition that has been marked as moderatable. Overrides ModerationHandlerInterface::onBundleModerationConfigurationFormSubmit
ModerationHandler::onPresave	public	function	Work to be done before saving en entity. Overrides ModerationHandlerInterface::onPresave
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.