ModerationHandler.php in Workbench Moderation 8

Namespace

Drupal\workbench_moderation\Entity\Handler

File

src/Entity/Handler/ModerationHandler.php

<?php

namespace Drupal\workbench_moderation\Entity\Handler;

use Drupal\Core\Config\Entity\ConfigEntityInterface;
use Drupal\Core\Entity\ContentEntityInterface;
use Drupal\Core\Entity\EntityHandlerInterface;
use Drupal\Core\Entity\EntityPublishedInterface;
use Drupal\Core\Entity\EntityTypeInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * Common customizations for most/all entities.
 *
 * This class is intended primarily as a base class.
 */
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) {
  }

}

Classes

Name	Description
ModerationHandler	Common customizations for most/all entities.