public function SalesforceOAuthPlugin::buildConfigurationForm in Salesforce Suite 5.0.x

Same name and namespace in other branches

1. 8.4 modules/salesforce_oauth/src/Plugin/SalesforceAuthProvider/SalesforceOAuthPlugin.php \Drupal\salesforce_oauth\Plugin\SalesforceAuthProvider\SalesforceOAuthPlugin::buildConfigurationForm()

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

modules/salesforce_oauth/src/Plugin/SalesforceAuthProvider/SalesforceOAuthPlugin.php, line 41

Class

SalesforceOAuthPlugin

Salesforce OAuth user-agent flow auth provider plugin.

Namespace

Drupal\salesforce_oauth\Plugin\SalesforceAuthProvider

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form['consumer_key'] = [
    '#title' => $this
      ->t('Salesforce consumer key'),
    '#type' => 'textfield',
    '#description' => $this
      ->t('Consumer key of the Salesforce remote application you want to grant access to'),
    '#required' => TRUE,
    '#default_value' => $this
      ->getCredentials()
      ->getConsumerKey(),
  ];
  $form['consumer_secret'] = [
    '#title' => $this
      ->t('Salesforce consumer secret'),
    '#type' => 'textfield',
    '#description' => $this
      ->t('Consumer secret of the Salesforce remote application.'),
    '#required' => TRUE,
    '#default_value' => $this
      ->getCredentials()
      ->getConsumerSecret(),
  ];
  $form['login_url'] = [
    '#title' => $this
      ->t('Login URL'),
    '#type' => 'textfield',
    '#default_value' => $this
      ->getCredentials()
      ->getLoginUrl(),
    '#description' => $this
      ->t('Enter a login URL, either https://login.salesforce.com or https://test.salesforce.com.'),
    '#required' => TRUE,
  ];
  return $form;
}