public function Oauth::buildConfigurationForm in Entity Share 8.3

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

File

modules/entity_share_client/src/Plugin/ClientAuthorization/Oauth.php, line 164

Class

Oauth

Provides Oauth2 based client authorization.

Namespace

Drupal\entity_share_client\Plugin\ClientAuthorization

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['entity_share']['#title'] = $this
    ->t('Oauth using <em>Resource owner password credentials</em> grant');
  $form['entity_share']['#description'] = $this
    ->t('A token will be requested and saved in State storage when this form is submitted. The username and password entered here are not saved, but are only used to request the token.');
  $form['entity_share']['username'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Username'),
  ];
  $form['entity_share']['password'] = [
    '#type' => 'password',
    '#title' => $this
      ->t('Password'),
  ];
  $credentials = $this->keyService
    ->getCredentials($this);
  $form['entity_share']['client_id'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Client ID'),
    '#default_value' => $credentials['client_id'] ?? '',
  ];
  $form['entity_share']['client_secret'] = [
    '#type' => 'password',
    '#title' => $this
      ->t('Client secret'),
  ];
  $form['entity_share']['authorization_path'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Authorization path on the remote website'),
    '#default_value' => $credentials['authorization_path'] ?? '/oauth/authorize',
  ];
  $form['entity_share']['token_path'] = [
    '#type' => 'textfield',
    '#title' => $this
      ->t('Token path on the remote website'),
    '#default_value' => $credentials['token_path'] ?? '/oauth/token',
  ];
  if ($this->keyService
    ->additionalProviders()) {
    $this
      ->expandedProviderOptions($form);

    // Username and password are also required if Key module is involved.
    $form['key']['#description'] = $this
      ->t('A token will be requested and saved in State storage when this form is submitted. The username and password entered here are not saved, but are only used to request the token.');
    $form['key']['username'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Username'),
    ];
    $form['key']['password'] = [
      '#type' => 'password',
      '#title' => $this
        ->t('Password'),
    ];
    $form['key']['id']['#key_filters'] = [
      'type' => 'entity_share_oauth',
    ];
    $form['key']['id']['#description'] = $this
      ->t('Select the key you have configured to hold the Oauth credentials.');
  }
  return $form;
}