Issue #3525841: Introduce WorkflowTargetEntity::getWorkflow()

src/Access/WorkflowHistoryAccess.php

@@ -45,23 +45,17 @@ class WorkflowHistoryAccess implements AccessInterface {
       return $value;
     }
 
-    // When having multiple workflows per bundle,
-    // use Views display 'Workflow history per entity' instead!
-    $fields = _workflow_info_fields($entity, $entity_type, $entity_bundle, $field_name);
-    if (!$fields) {
-      return AccessResult::forbidden();
-    }
 
     /*
      * Determine if user has Access. Fill the cache.
      */
-    // Note: for multiple workflow_fields per bundle, use Views instead!
-    // @todo Use proper 'WORKFLOW_TYPE' permissions for workflow_tab_access.
+    // N.B. For multiple workflow_fields per bundle, use Views instead!
     // N.B. Keep aligned between WorkflowState, ~Transition, ~HistoryAccess.
+    // @todo Use proper 'WORKFLOW_TYPE' permissions for workflow_tab_access.
     $access_result = AccessResult::forbidden();
     $is_owner = WorkflowRole::isOwner($account, $entity);
+    $fields = _workflow_info_fields($entity, $entity_type, $entity_bundle, $field_name);
     foreach ($fields as $definition) {
-      $field_name = $definition->getName();
       $type_id = $definition->getSetting('workflow_type');
       $access_result = match (TRUE) {
         $account->hasPermission("access any $type_id workflow_transion overview")
@@ -74,6 +68,7 @@ class WorkflowHistoryAccess implements AccessInterface {
         => AccessResult::forbidden(),
       };
 
+      $field_name = $definition->getName();
       $access[$uid][$entity_type][$entity_id][$field_name] = $access_result;
     }
 

src/Entity/WorkflowTargetEntity.php

@@ -112,13 +112,12 @@ class WorkflowTargetEntity {
   public static function getCreationState(EntityInterface $entity, $field_name) {
     $state = NULL;
 
-    /** @var \Drupal\Core\Config\Entity\ConfigEntityBase $entity */
-    /** @var \Drupal\workflow\Entity\WorkflowInterface $workflow */
-    $workflow = $entity->{$field_name}?->first()?->getWorkflow();
-    if (!$workflow) {
-      \Drupal::messenger()->addError(t('Workflow %wid cannot be loaded. Contact your system administrator.', ['%wid' => $workflow?->id() ?? '']));
+    $wid = WorkflowTargetEntity::getWorkflowId($entity, $field_name);
+    if (!$wid) {
+      \Drupal::messenger()->addError(t('Workflow %wid cannot be loaded. Contact your system administrator.', ['%wid' => $wid]));
     }
     else {
+      $workflow = Workflow::load($wid);
       $state = $workflow->getCreationState();
     }
 
@@ -279,6 +278,54 @@ class WorkflowTargetEntity {
     return $sid;
   }
 
+  /**
+   * Gets the Workflow for a given $entity and $field_name.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $entity
+   * @param string $field_name
+   *
+   * @return \Drupal\workflow\Entity\Workflow
+   *   The Workflow entity of the field.
+   *
+   * @see WorkflowTargetEntity::getWorkflowId()
+   */
+  public static function getWorkflow(EntityInterface $entity, $field_name) {
+    $workflow = NULL;
+
+    $wid = WorkflowTargetEntity::getWorkflowId($entity, $field_name);
+    if (!$wid) {
+      \Drupal::messenger()->addError(t('Workflow %wid cannot be loaded. Contact your system administrator.', ['%wid' => $wid]));
+    }
+    else {
+      $workflow = Workflow::load($wid);
+    }
+
+    return $workflow;
+  }
+
+  /**
+   * Gets the Workflow ID for a given $entity and $field_name.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $entity
+   * @param string $field_name
+   *
+   * @return \Drupal\workflow\Entity\WorkflowState
+   *   The creation State for the Workflow of the field.
+   *
+   * @see WorkflowTargetEntity::getCurrentStateId()
+   */
+  public static function getWorkflowId(EntityInterface $entity, $field_name) {
+    $wid = NULL;
+
+    /** @var \Drupal\Core\Config\Entity\ConfigEntityBase $entity */
+    // Sometimes, no first item is available, so read wid from storage.
+    // $workflow = $entity->{$field_name}?->first()?->getWorkflow();
+    $definition = $entity->{$field_name}->getFieldDefinition();
+    $field_storage_definition = $definition->getFieldStorageDefinition();
+    $wid = $field_storage_definition->getSetting('workflow_type');
+    return $wid;
+  }
+
   /**
    * {@inheritdoc}
    *

src/Entity/WorkflowTransition.php

@@ -173,9 +173,10 @@ class WorkflowTransition extends ContentEntityBase implements WorkflowTransition
 
     $entity = $values['entity'] ?? NULL;
     $field_name = $values['field_name'];
+    $wid = $values['wid'];
     // Fieldname may not exist on entity, but only on Comment with workflow.
     // E.g, when adding comment with workflow, on entity w/o workflow field.
-    $wid = $entity?->{$field_name}?->first()?->getWorkflowId();
+    $wid ??= $entity?->{$field_name}?->first()?->getWorkflowId();
 
     if ($entity && $wid) {
       unset($values['entity']);

src/Hook/WorkflowEntityHooks.php

@@ -341,34 +341,24 @@ class WorkflowEntityHooks {
 
     $original_entity = WorkflowTargetEntity::getOriginal($entity);
     foreach ($field_names as $field_name => $label) {
-      /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $transition */
-      // @todo Transition is created in widget or WorkflowTransitionForm.
-      // @todo $transition = workflow_get_transition($entity, $field_name);
-      // Transition may be empty on node with mismatched CommentWithWorkflow.
-      $transition = $entity->{$field_name}->first()?->getTransition();
-      if (!$transition) {
-        // We come from creating/editing an entity via entity_form,
-        // with core widget or hidden Workflow widget.
-        // @todo D8: From an Edit form with hidden widget.
-        /* @noinspection PhpUndefinedFieldInspection */
       if ($original_entity) {
         // Editing a Node with hidden Widget. State change not possible, so bail out.
         // $entity->{$field_name}->value = $original_entity->{$field_name}->value;
         // continue;
       }
 
-        // Creating a Node with hidden Workflow Widget. Generate valid first transition.
-        $old_sid = WorkflowTargetEntity::getPreviousStateId($entity, $field_name);
-        $new_sid = $entity->{$field_name}->value;
-        /** @var \Drupal\workflow\Entity\WorkflowInterface $workflow */
-        $workflow = $entity->{$field_name}->first()?->getWorkflow();
-        if ($workflow && !$new_sid) {
-          $user = workflow_current_user();
-          $new_sid = $workflow->getFirstSid($entity, $field_name, $user);
-        }
-        $transition = WorkflowTransition::create([$old_sid, 'field_name' => $field_name])
-          ?->setValues($new_sid, NULL, NULL, NULL, TRUE);
-      }
+      /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $transition */
+      // Transition may be empty on node with mismatched CommentWithWorkflow.
+      $transition = $entity->{$field_name}?->first()?->getTransition();
+      // Note: Field is empty if node created before module installation.
+      // We come from creating/editing an entity via entity_form,
+      // with core widget or hidden Workflow widget.
+      // Or from WorkflowOnComment with core widget.
+      // @todo D8: From an Edit form with hidden widget.
+      $transition ??= WorkflowTransition::create([
+        'entity' => $entity,
+        'field_name' => $field_name,
+      ]);
 
       // We come from Content/Comment edit page, from widget.
       // Set the just-saved entity explicitly.

src/Plugin/Field/FieldType/WorkflowItem.php

@@ -308,6 +308,7 @@ class WorkflowItem extends ListItemBase {
     $transition ??= WorkflowTransition::create([
       'entity' => $this->getEntity(),
       'field_name' => $this->getParent()->getName(),
+      'wid' => $this->getWorkflowId(),
     ]);
     return $transition;
   }
@@ -438,10 +439,12 @@ class WorkflowItem extends ListItemBase {
     }
 
     // Get the allowed new states for the entity's current state.
-    $field_name = $this->getFieldDefinition()->getName();
-    $state = $this->getState();
-    // @todo use workflow_state_allowed_values, for executed transition.
-    $allowed_options = $state?->getOptions($entity, $field_name, NULL, FALSE);
+    $transition = $this->getTransition();
+    $allowed_options = $transition?->getSettableOptions($account, 'to_sid');
+    // $field_name = $this->getFieldDefinition()->getName();
+    // $state = $this->getState();
+    // @done use workflow_state_allowed_values, for executed transition.
+    // $allowed_options = $state?->getOptions($entity, $field_name, NULL, FALSE);
 
     return $allowed_options ?? [];
   }