class EntityTypeInfo in Workbench Moderation 8

Service class for manipulating entity type information.

This class contains primarily bridged hooks for compile-time or cache-clear-time hooks. Runtime hooks should be placed in EntityOperations.

Hierarchy

• class \Drupal\workbench_moderation\EntityTypeInfo uses StringTranslationTrait

1 string reference to 'EntityTypeInfo'

workbench_moderation.services.yml in ./workbench_moderation.services.yml

workbench_moderation.services.yml

1 service uses EntityTypeInfo

workbench_moderation.entity_type in ./workbench_moderation.services.yml

Drupal\workbench_moderation\EntityTypeInfo

File

src/EntityTypeInfo.php, line 28

Namespace

Drupal\workbench_moderation

class EntityTypeInfo {
  use StringTranslationTrait;

  /**
   * The moderation information service.
   *
   * @var \Drupal\workbench_moderation\ModerationInformationInterface
   */
  protected $moderationInfo;

  /**
   * The entitytype manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * A keyed array of custom moderation handlers for given entity types.
   *
   * Any entity not specified will use a common default.
   *
   * @var array
   */
  protected $moderationHandlers = [
    'node' => NodeModerationHandler::class,
    'block_content' => BlockContentModerationHandler::class,
  ];

  /**
   * EntityTypeInfo constructor.
   *
   * @param \Drupal\Core\StringTranslation\TranslationInterface $translation
   *   The translation service. for form alters.
   * @param \Drupal\workbench_moderation\ModerationInformationInterface $moderation_information
   *   The moderation information service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   Entity type manager.
   */
  public function __construct(TranslationInterface $translation, ModerationInformationInterface $moderation_information, EntityTypeManagerInterface $entity_type_manager) {
    $this->stringTranslation = $translation;
    $this->moderationInfo = $moderation_information;
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * Adds Moderation configuration to appropriate entity types.
   *
   * This is an alter hook bridge.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface[] $entity_types
   *   The master entity type list to alter.
   *
   * @see hook_entity_type_alter()
   */
  public function entityTypeAlter(array &$entity_types) {
    foreach ($this->moderationInfo
      ->selectRevisionableEntityTypes($entity_types) as $type_name => $type) {
      $entity_types[$type_name] = $this
        ->addModerationToEntityType($type);
      $entity_types[$type
        ->get('bundle_of')] = $this
        ->addModerationToEntity($entity_types[$type
        ->get('bundle_of')]);
    }
  }

  /**
   * Modifies an entity definition to include moderation support.
   *
   * This primarily just means an extra handler. A Generic one is provided,
   * but individual entity types can provide their own as appropriate.
   *
   * @param \Drupal\Core\Entity\ContentEntityTypeInterface $type
   *   The content entity definition to modify.
   *
   * @return \Drupal\Core\Entity\ContentEntityTypeInterface
   *   The modified content entity definition.
   */
  protected function addModerationToEntity(ContentEntityTypeInterface $type) {
    if (!$type
      ->hasHandlerClass('moderation')) {
      $handler_class = !empty($this->moderationHandlers[$type
        ->id()]) ? $this->moderationHandlers[$type
        ->id()] : ModerationHandler::class;
      $type
        ->setHandlerClass('moderation', $handler_class);
    }
    if (!$type
      ->hasLinkTemplate('latest-version') && $type
      ->hasLinkTemplate('canonical')) {
      $type
        ->setLinkTemplate('latest-version', $type
        ->getLinkTemplate('canonical') . '/latest');
    }

    // @todo Core forgot to add a direct way to manipulate route_provider, so
    // we have to do it the sloppy way for now.
    $providers = $type
      ->getRouteProviderClasses() ?: [];
    if (empty($providers['moderation'])) {
      $providers['moderation'] = EntityModerationRouteProvider::class;
      $type
        ->setHandlerClass('route_provider', $providers);
    }
    return $type;
  }

  /**
   * Modifies entity type definition to include configuration support.
   *
   * That "configuration support" includes a configuration form, a hypermedia
   * link, and a route provider to tie it all together. There's also a
   * moderation handler for per-entity-type variation.
   *
   * @param \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $type
   *   The config entity definition to modify.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityTypeInterface
   *   The modified config entity definition.
   */
  protected function addModerationToEntityType(ConfigEntityTypeInterface $type) {
    if ($type
      ->hasLinkTemplate('edit-form') && !$type
      ->hasLinkTemplate('moderation-form')) {
      $type
        ->setLinkTemplate('moderation-form', $type
        ->getLinkTemplate('edit-form') . '/moderation');
    }
    if (!$type
      ->getFormClass('moderation')) {
      $type
        ->setFormClass('moderation', BundleModerationConfigurationForm::class);
    }

    // @todo Core forgot to add a direct way to manipulate route_provider, so
    // we have to do it the sloppy way for now.
    $providers = $type
      ->getRouteProviderClasses() ?: [];
    if (empty($providers['moderation'])) {
      $providers['moderation'] = EntityTypeModerationRouteProvider::class;
      $type
        ->setHandlerClass('route_provider', $providers);
    }
    return $type;
  }

  /**
   * Adds an operation on bundles that should have a Moderation form.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity on which to define an operation.
   *
   * @return array
   *   An array of operation definitions.
   *
   * @see hook_entity_operation()
   */
  public function entityOperation(EntityInterface $entity) {
    $operations = [];
    $type = $entity
      ->getEntityType();
    if ($this->moderationInfo
      ->isBundleForModeratableEntity($entity)) {
      $operations['manage-moderation'] = [
        'title' => t('Manage moderation'),
        'weight' => 27,
        'url' => Url::fromRoute("entity.{$type->id()}.moderation", [
          $entity
            ->getEntityTypeId() => $entity
            ->id(),
        ]),
      ];
    }
    return $operations;
  }

  /**
   * Gets the "extra fields" for a bundle.
   *
   * This is a hook bridge.
   *
   * @see hook_entity_extra_field_info()
   *
   * @return array
   *   A nested array of 'pseudo-field' elements. Each list is nested within the
   *   following keys: entity type, bundle name, context (either 'form' or
   *   'display'). The keys are the name of the elements as appearing in the
   *   renderable array (either the entity form or the displayed entity). The
   *   value is an associative array:
   *   - label: The human readable name of the element. Make sure you sanitize
   *     this appropriately.
   *   - description: A short description of the element contents.
   *   - weight: The default weight of the element.
   *   - visible: (optional) The default visibility of the element. Defaults to
   *     TRUE.
   *   - edit: (optional) String containing markup (normally a link) used as the
   *     element's 'edit' operation in the administration interface. Only for
   *     'form' context.
   *   - delete: (optional) String containing markup (normally a link) used as
   *     the element's 'delete' operation in the administration interface. Only
   *     for 'form' context.
   */
  public function entityExtraFieldInfo() {
    $return = [];
    foreach ($this
      ->getModeratedBundles() as $bundle) {
      $return[$bundle['entity']][$bundle['bundle']]['display']['workbench_moderation_control'] = [
        'label' => $this
          ->t('Moderation control'),
        'description' => $this
          ->t("Status listing and form for the entitiy's moderation state."),
        'weight' => -20,
        'visible' => TRUE,
      ];
    }
    return $return;
  }

  /**
   * Returns an iterable list of entity names and bundle names under moderation.
   *
   * That is, this method returns a list of bundles that have Workbench
   * Moderation enabled on them.
   *
   * @return \Generator
   *   A generator, yielding a 2 element associative array:
   *   - entity: The machine name of an entity,
   *     such as "node" or "block_content".
   *   - bundle: The machine name of a bundle, such as "page" or "article".
   */
  protected function getModeratedBundles() {
    $revisionable_types = $this->moderationInfo
      ->selectRevisionableEntityTypes($this->entityTypeManager
      ->getDefinitions());

    /** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $type */
    foreach ($revisionable_types as $type_name => $type) {
      $result = $this->entityTypeManager
        ->getStorage($type_name)
        ->getQuery()
        ->condition('third_party_settings.workbench_moderation.enabled', TRUE)
        ->execute();
      foreach ($result as $bundle_name) {
        (yield [
          'entity' => $type
            ->getBundleOf(),
          'bundle' => $bundle_name,
        ]);
      }
    }
  }

  /**
   * Adds base field info to an entity type.
   *
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   Entity type for adding base fields to.
   *
   * @return \Drupal\Core\Field\BaseFieldDefinition[]
   *   New fields added by moderation state.
   */
  public function entityBaseFieldInfo(EntityTypeInterface $entity_type) {
    if (!$this->moderationInfo
      ->isModeratableEntityType($entity_type)) {
      return [];
    }
    $fields = [];

    // @todo write a test for this.
    $fields['moderation_state'] = BaseFieldDefinition::create('entity_reference')
      ->setLabel(t('Moderation state'))
      ->setDescription(t('The moderation state of this piece of content.'))
      ->setSetting('target_type', 'moderation_state')
      ->setTargetEntityTypeId($entity_type
      ->id())
      ->setRevisionable(TRUE)
      ->setTranslatable(TRUE)
      ->setDisplayOptions('view', [
      'label' => 'hidden',
      'region' => 'hidden',
      'weight' => -5,
    ])
      ->setDisplayOptions('form', [
      'type' => 'moderation_state_default',
      'weight' => 5,
      'settings' => [],
    ])
      ->addConstraint('ModerationState', [])
      ->setDisplayConfigurable('form', FALSE)
      ->setDisplayConfigurable('view', FALSE);
    return $fields;
  }

  /**
   * Force moderatable bundles to have a moderation_state field.
   *
   * @param \Drupal\Core\Field\FieldDefinitionInterface[] $fields
   *   The array of bundle field definitions.
   * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
   *   The entity type definition.
   * @param string $bundle
   *   The bundle.
   *
   * @see hook_entity_bundle_field_info_alter();
   */
  public function entityBundleFieldInfoAlter(array &$fields, EntityTypeInterface $entity_type, $bundle) {
    if ($this->moderationInfo
      ->isModeratableBundle($entity_type, $bundle) && !empty($fields['moderation_state'])) {
      $fields['moderation_state']
        ->addConstraint('ModerationState', []);
    }
  }

  /**
   * Alters bundle forms to enforce revision handling.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param string $form_id
   *   The form id.
   *
   * @see hook_form_alter()
   */
  public function bundleFormAlter(array &$form, FormStateInterface $form_state, $form_id) {
    if ($this->moderationInfo
      ->isRevisionableBundleForm($form_state
      ->getFormObject())) {

      /* @var ConfigEntityTypeInterface $bundle */
      $bundle = $form_state
        ->getFormObject()
        ->getEntity();
      $this->entityTypeManager
        ->getHandler($bundle
        ->getEntityType()
        ->getBundleOf(), 'moderation')
        ->enforceRevisionsBundleFormAlter($form, $form_state, $form_id);
    }
    elseif ($this->moderationInfo
      ->isModeratedEntityForm($form_state
      ->getFormObject())) {

      /* @var ContentEntityInterface $entity */
      $entity = $form_state
        ->getFormObject()
        ->getEntity();
      $this->entityTypeManager
        ->getHandler($entity
        ->getEntityTypeId(), 'moderation')
        ->enforceRevisionsEntityFormAlter($form, $form_state, $form_id);

      // Submit handler to redirect to the.
      $form['actions']['submit']['#submit'][] = '\\Drupal\\workbench_moderation\\EntityTypeInfo::bundleFormRedirect';
    }
  }

  /**
   * Redirect content entity edit forms on save, if there is a forward revision.
   *
   * When saving their changes, editors should see those changes displayed on
   * the next page.
   *
   * @param array $form
   *   Form array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public static function bundleFormRedirect(array &$form, FormStateInterface $form_state) {

    /* @var ContentEntityInterface $entity */
    $entity = $form_state
      ->getFormObject()
      ->getEntity();
    $moderation_info = \Drupal::getContainer()
      ->get('workbench_moderation.moderation_information');
    if ($moderation_info
      ->hasForwardRevision($entity) && $entity
      ->hasLinkTemplate('latest-version')) {
      $entity_type_id = $entity
        ->getEntityTypeId();
      $form_state
        ->setRedirect("entity.{$entity_type_id}.latest_version", [
        $entity_type_id => $entity
          ->id(),
      ]);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
EntityTypeInfo::$entityTypeManager	protected	property	The entitytype manager.
EntityTypeInfo::$moderationHandlers	protected	property	A keyed array of custom moderation handlers for given entity types.
EntityTypeInfo::$moderationInfo	protected	property	The moderation information service.
EntityTypeInfo::addModerationToEntity	protected	function	Modifies an entity definition to include moderation support.
EntityTypeInfo::addModerationToEntityType	protected	function	Modifies entity type definition to include configuration support.
EntityTypeInfo::bundleFormAlter	public	function	Alters bundle forms to enforce revision handling.
EntityTypeInfo::bundleFormRedirect	public static	function	Redirect content entity edit forms on save, if there is a forward revision.
EntityTypeInfo::entityBaseFieldInfo	public	function	Adds base field info to an entity type.
EntityTypeInfo::entityBundleFieldInfoAlter	public	function	Force moderatable bundles to have a moderation_state field.
EntityTypeInfo::entityExtraFieldInfo	public	function	Gets the "extra fields" for a bundle.
EntityTypeInfo::entityOperation	public	function	Adds an operation on bundles that should have a Moderation form.
EntityTypeInfo::entityTypeAlter	public	function	Adds Moderation configuration to appropriate entity types.
EntityTypeInfo::getModeratedBundles	protected	function	Returns an iterable list of entity names and bundle names under moderation.
EntityTypeInfo::__construct	public	function	EntityTypeInfo constructor.
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.