public function Role::buildConfigurationForm in Commerce License 8.2

Form constructor.

Plugin forms are embedded in other forms. In order to know where the plugin form is located in the parent form, #parents and #array_parents must be known, but these are not available during the initial build phase. In order to have these properties available when building the plugin form's elements, let this method return a form element that has a #process callback and build the rest of the form in the callback. By the time the callback is executed, the element's #parents and #array_parents properties will have been set by the form API. For more documentation on #parents and #array_parents, see \Drupal\Core\Render\Element\FormElement.

Parameters

array $form: An associative array containing the initial structure of the plugin form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form. Calling code should pass on a subform state created through \Drupal\Core\Form\SubformState::createForSubform().

Return value

array The form structure.

Overrides LicenseTypeBase::buildConfigurationForm

File

src/Plugin/Commerce/LicenseType/Role.php, line 116

Class

Role

Provides a license type which grants one or more roles.

Namespace

Drupal\commerce_license\Plugin\Commerce\LicenseType

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $roles = UserRole::loadMultiple();

  // Skip the built-in roles.
  unset($roles[RoleInterface::ANONYMOUS_ID]);
  unset($roles[RoleInterface::AUTHENTICATED_ID]);

  // Remove the admin role if it exists.
  // TODO: consider removing any role that has is_admin set.
  unset($roles['administrator']);

  // If no licensable roles exist, display an error message.
  // A radios element without options will result in an
  // "Illegal choice detected" error.
  if (!$roles) {
    $form['error'] = [
      '#markup' => $this
        ->t('No licensable roles can be configured, please review your configuration.'),
    ];
    return $form;
  }
  $options = EntityHelper::extractLabels($roles);
  $form['license_role'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Licensed role'),
    '#options' => EntityHelper::extractLabels($roles),
    '#default_value' => isset($options[$this->configuration['license_role']]) ? $this->configuration['license_role'] : key($options),
    '#required' => TRUE,
  ];
  return $form;
}