public function WorkflowDefaultWidget::formElement in Workflow 8

Be careful: Widget may be shown in very different places. Test carefully!!

• On a entity add/edit page;
• On a entity preview page;
• On a entity view page;
• On a entity 'workflow history' tab;
• On a comment display, in the comment history;
• On a comment form, below the comment history.

Overrides WidgetInterface::formElement

File

src/Plugin/Field/FieldWidget/WorkflowDefaultWidget.php, line 37

Class

WorkflowDefaultWidget

Plugin implementation of the 'workflow_default' widget.

Namespace

Drupal\workflow\Plugin\Field\FieldWidget

Code

public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
  $wid = $this
    ->getFieldSetting('workflow_type');

  /** @var \Drupal\workflow\Entity\Workflow $workflow */
  if (!($workflow = Workflow::load($wid))) {

    // @todo Add error message.
    return $element;
  }
  if ($this
    ->isDefaultValueWidget($form_state)) {

    // On the Field settings page, User may not set a default value
    // (this is done by the Workflow module).
    return [];
  }

  /** @var \Drupal\workflow\Plugin\Field\FieldType\WorkflowItem $item */
  $item = $items[$delta];

  /** @var \Drupal\field\Entity\FieldConfig $field_config */
  $field_config = $item
    ->getFieldDefinition();

  /** @var \Drupal\field\Entity\FieldStorageConfig $field_storage */
  $field_storage = $field_config
    ->getFieldStorageDefinition();
  $entity = $item
    ->getEntity();
  $field_name = $field_storage
    ->getName();

  // Create a transition, to pass to the form. No need to use setValues().
  $from_sid = workflow_node_current_state($entity, $field_name);

  /** @var \Drupal\workflow\Entity\WorkflowTransitionInterface $transition */
  $transition = WorkflowTransition::create([
    $from_sid,
    'field_name' => $field_name,
  ]);
  $transition
    ->setTargetEntity($entity);

  // Here, on entity form, not the $element is added, but the entity form.
  // Problem 1: adding the element, does not add added fields.
  // Problem 2: adding the form, generates wrong UI.
  // Problem 3: does not work on ScheduledTransition.
  //
  // Step 1: use the Element.
  $element['#default_value'] = $transition;
  $element += WorkflowTransitionElement::transitionElement($element, $form_state, $form);

  // Step 2: use the Form, in order to get extra fields.
  $form_state_additions = [
    'input' => $form_state
      ->getUserInput(),
    'values' => $form_state
      ->getValues(),
    'triggering_element' => $form_state
      ->getTriggeringElement(),
  ];
  $workflow_form = WorkflowManager::getWorkflowTransitionForm($entity, $field_name, $form_state_additions);

  // Determine and add the attached fields.
  $attached_fields = WorkflowManager::getAttachedFields('workflow_transition', $wid);
  foreach ($attached_fields as $key => $attached_field) {
    $element[$key] = $workflow_form[$key];
  }

  // Option 3: use the true Element.
  // $form = $this->element($form, $form_state, $transition);

  //$element['workflow_transition'] = array(

  //      '#type' => 'workflow_transition',
  //      '#title' => $this->t('Workflow transition'),
  //      '#default_value' => $transition,
  // );
  return $element;
}