public function ApigeeAuthKeyInput::buildConfigurationForm in Apigee Edge 8

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 PluginFormInterface::buildConfigurationForm

File

src/Plugin/KeyInput/ApigeeAuthKeyInput.php, line 46

Class

ApigeeAuthKeyInput

Apigee Edge authentication credentials input text fields.

Namespace

Drupal\apigee_edge\Plugin\KeyInput

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $values = $this
    ->getFormDefaultValues($form_state);
  if (!empty($values['auth_type']) && $values['auth_type'] == EdgeKeyTypeInterface::EDGE_AUTH_TYPE_BASIC) {
    $this
      ->messenger()
      ->addWarning($this
      ->t('HTTP basic authentication will be deprecated. Please choose another authentication method.'));
  }
  $state_for_public = [
    ':input[name="key_input_settings[instance_type]"]' => [
      'value' => EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC,
    ],
  ];
  $state_for_private = [
    ':input[name="key_input_settings[instance_type]"]' => [
      'value' => EdgeKeyTypeInterface::INSTANCE_TYPE_PRIVATE,
    ],
  ];
  $state_for_hybrid = [
    ':input[name="key_input_settings[instance_type]"]' => [
      'value' => EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID,
    ],
  ];
  $form['instance_type'] = [
    '#type' => 'radios',
    '#title' => $this
      ->t('Apigee instance type'),
    '#description' => $this
      ->t('Select the Apigee instance type you are connecting to. More information can be found in the <a href="@link" target="_blank">Apigee documentation</a>.', [
      '@link' => 'https://www.drupal.org/docs/8/modules/apigee-edge/configure-the-connection-to-apigee-edge',
    ]),
    '#required' => TRUE,
    '#options' => [
      EdgeKeyTypeInterface::INSTANCE_TYPE_PUBLIC => $this
        ->t('Apigee Edge (Endpoint: https://api.enterprise.apigee.com/v1)'),
      EdgeKeyTypeInterface::INSTANCE_TYPE_HYBRID => $this
        ->t('Apigee X (Endpoint: https://apigee.googleapis.com/v1)'),
      EdgeKeyTypeInterface::INSTANCE_TYPE_PRIVATE => $this
        ->t('Private cloud (Custom endpoint)'),
    ],
    '#default_value' => $values['instance_type'] ?? 'public',
  ];
  $form['auth_type'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Authentication type'),
    '#description' => $this
      ->t('Select the authentication method to use.'),
    '#required' => TRUE,
    '#options' => [
      EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH => $this
        ->t('OAuth'),
      EdgeKeyTypeInterface::EDGE_AUTH_TYPE_BASIC => $this
        ->t('HTTP basic (deprecated)'),
    ],
    '#default_value' => $values['auth_type'] ?? EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
    '#states' => [
      'visible' => [
        $state_for_public,
        $state_for_private,
      ],
      'required' => [
        $state_for_public,
        $state_for_private,
      ],
    ],
  ];
  $form['organization'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Organization'),
    '#description' => $this
      ->t('Name of the organization on Apigee Edge. Changing this value could make your site stop working.'),
    '#default_value' => $values['organization'] ?? '',
    '#required' => TRUE,
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#prefix' => '<div id="edit-organization-field">',
    '#suffix' => '</div>',
  ];
  $form['username'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Username'),
    '#description' => $this
      ->t("Apigee user's email address or identity provider username that is used for authenticating with the endpoint."),
    '#default_value' => $values['username'] ?? '',
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => [
        $state_for_public,
        $state_for_private,
      ],
      'required' => [
        $state_for_public,
        $state_for_private,
      ],
    ],
  ];
  $form['password'] = [
    '#type' => 'password',
    '#title' => $this
      ->t('Password'),
    '#description' => $this
      ->t("Organization user's password that is used for authenticating with the endpoint.") . (empty($values['password']) ? '' : ' ' . $this
      ->t('Leave empty unless you want to change the stored password.')),
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => [
        $state_for_public,
        $state_for_private,
      ],
    ],
  ];

  // If password was never set make sure it is required.
  if (empty($values['organization'])) {
    $form['password']['#states']['required'] = [
      $state_for_public,
      $state_for_private,
    ];
  }
  $state_for_not_gcp_hosted = [];
  $gceServiceAccountAuth = new GceServiceAccountAuthentication(\Drupal::service('apigee_edge.authentication.oauth_token_storage'));
  if ($gceServiceAccountAuth
    ->isAvailable()) {
    $form['gcp_hosted'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Use the default service account if this portal is hosted on GCP'),
      '#description' => $this
        ->t("Please ensure you have added 'Apigee Developer Administrator' role to the default compute engine service account hosting this portal."),
      '#default_value' => $values['gcp_hosted'] ?? TRUE,
      '#states' => [
        'visible' => $state_for_hybrid,
      ],
    ];
    $state_for_not_gcp_hosted = [
      ':input[name="key_input_settings[gcp_hosted]"]' => [
        'checked' => FALSE,
      ],
    ];
  }
  $form['account_json_key'] = [
    '#type' => 'textarea',
    '#title' => $this
      ->t('GCP service account key'),
    '#description' => $this
      ->t("Paste the contents of the GCP service account key JSON file."),
    '#default_value' => $values['account_json_key'] ?? '',
    '#rows' => '8',
    '#states' => [
      'visible' => $state_for_hybrid + $state_for_not_gcp_hosted,
      'required' => $state_for_hybrid + $state_for_not_gcp_hosted,
    ],
  ];
  $form['endpoint'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Apigee Edge endpoint'),
    '#description' => $this
      ->t('Apigee Edge endpoint where the API calls are being sent. For a Private Cloud installation it is in the form: %form_a or %form_b.', [
      '%form_a' => 'http://ms_IP_or_DNS:8080/v1',
      '%form_b' => 'https://ms_IP_or_DNS:TLSport/v1',
    ]),
    '#default_value' => $values['endpoint'] ?? '',
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => $state_for_private,
      'required' => $state_for_private,
    ],
  ];
  $form['authorization_server_type'] = [
    '#title' => $this
      ->t('Authorization server'),
    '#type' => 'radios',
    '#required' => TRUE,
    '#default_value' => $values['authorization_server_type'] ?? 'default',
    '#options' => [
      'default' => $this
        ->t('Default'),
      'custom' => $this
        ->t('Custom'),
    ],
    '#description' => $this
      ->t('The server issuing access tokens to the client. Use the default (%authorization_server), unless using a SAML enabled organization.', [
      '%authorization_server' => Oauth::DEFAULT_AUTHORIZATION_SERVER,
    ]),
    '#states' => [
      'visible' => [
        [
          $state_for_public,
          $state_for_private,
        ],
        ':input[name="key_input_settings[auth_type]"]' => [
          'value' => EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
        ],
      ],
    ],
  ];
  $form['authorization_server'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Custom authorization server'),
    '#description' => $this
      ->t('The authorization server endpoint for a SAML enabled edge org is in the form: %form.', [
      '%form' => 'https://{zonename}.login.apigee.com/oauth/token',
    ]),
    '#default_value' => $values['authorization_server'] ?? '',
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => [
        [
          $state_for_public,
          $state_for_private,
        ],
        ':input[name="key_input_settings[auth_type]"]' => [
          'value' => EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
        ],
        ':input[name="key_input_settings[authorization_server_type]"]' => [
          'value' => 'custom',
        ],
      ],
      'required' => [
        [
          $state_for_public,
          $state_for_private,
        ],
        ':input[name="key_input_settings[auth_type]"]' => [
          'value' => EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
        ],
        ':input[name="key_input_settings[authorization_server_type]"]' => [
          'value' => 'custom',
        ],
      ],
    ],
  ];
  $form['client_id'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Client ID'),
    '#description' => $this
      ->t('The client identifier issued to the client during the registration process. Leave empty to use the default %client_id client ID.', [
      '%client_id' => Oauth::DEFAULT_CLIENT_ID,
    ]),
    '#default_value' => $values['client_id'] ?? '',
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => [
        [
          $state_for_public,
          $state_for_private,
        ],
        ':input[name="key_input_settings[auth_type]"]' => [
          'value' => EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
        ],
      ],
    ],
  ];
  $form['client_secret'] = [
    '#type' => 'password',
    '#title' => $this
      ->t('Client secret'),
    '#description' => $this
      ->t('A secret known only to the client and the authorization server. Leave empty to use the default %client_secret client secret.', [
      '%client_secret' => Oauth::DEFAULT_CLIENT_SECRET,
    ]),
    '#default_value' => $values['client_secret'] ?? '',
    '#attributes' => [
      'autocomplete' => 'off',
    ],
    '#states' => [
      'visible' => [
        [
          $state_for_public,
          $state_for_private,
        ],
        ':input[name="key_input_settings[auth_type]"]' => [
          'value' => EdgeKeyTypeInterface::EDGE_AUTH_TYPE_OAUTH,
        ],
      ],
    ],
  ];
  $form['key_value'] = [
    '#type' => 'value',
    '#value' => $form_state
      ->get('key_value')['current'],
  ];
  return $form;
}