You are here

public function WorkflowItem::getPossibleOptions in Workflow 8

Returns an array of possible values with labels for display.

If the optional $account parameter is passed, then the array is filtered to values viewable by the account.

Parameters

\Drupal\Core\Session\AccountInterface $account: (optional) The user account for which to filter the possible options. If omitted, all possible options are returned.

Return value

array An array of possible options for the object that may be used in an Options widget, for example when existing data should be filtered. It may either be a flat array of option labels keyed by values, or a two-dimensional array of option groups (array of flat option arrays, keyed by option group label). Note that labels should NOT be sanitized.

Overrides ListItemBase::getPossibleOptions

1 call to WorkflowItem::getPossibleOptions()
WorkflowItem::getPossibleValues in src/Plugin/Field/FieldType/WorkflowItem.php
Returns an array of possible values.

File

src/Plugin/Field/FieldType/WorkflowItem.php, line 329

Class

WorkflowItem
Plugin implementation of the 'workflow' field type.

Namespace

Drupal\workflow\Plugin\Field\FieldType

Code

public function getPossibleOptions(AccountInterface $account = NULL) {
  $allowed_options = [];

  // When we are initially on the Storage settings form, no wid is set, yet.
  if (!($wid = $this
    ->getSetting('workflow_type'))) {
    return $allowed_options;
  }

  // Create an empty State. This triggers to show all possible states for the Workflow.
  if ($workflow = Workflow::load($wid)) {

    // There is no entity, E.g., on the Rules action "Set a data value".
    $user = workflow_current_user($account);

    // @todo #2287057: OK?

    /** @var \Drupal\workflow\Entity\WorkflowState $state */
    $state = WorkflowState::create([
      'wid' => $wid,
      'id' => '',
    ]);
    $allowed_options = $state
      ->getOptions(NULL, '', $user, FALSE);
  }
  return $allowed_options;
}