You are here

public function BasicAuthSolrConnector::buildConfigurationForm in Search API Solr 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 SolrConnectorPluginBase::buildConfigurationForm

File

src/Plugin/SolrConnector/BasicAuthSolrConnector.php, line 34

Class

BasicAuthSolrConnector
Standard Solr connector.

Namespace

Drupal\search_api_solr\Plugin\SolrConnector

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['auth'] = array(
    '#type' => 'fieldset',
    '#title' => $this
      ->t('HTTP Basic Authentication'),
    '#description' => $this
      ->t('If your Solr server is protected by basic HTTP authentication, enter the login data here.'),
    '#collapsible' => TRUE,
    '#collapsed' => empty($this->configuration['username']),
  );
  $form['auth']['username'] = array(
    '#type' => 'textfield',
    '#title' => $this
      ->t('Username'),
    '#default_value' => $this->configuration['username'],
    '#required' => TRUE,
  );
  $form['auth']['password'] = array(
    '#type' => 'password',
    '#title' => $this
      ->t('Password'),
    '#description' => $this
      ->t('If this field is left blank and the HTTP username is filled out, the current password will not be changed.'),
  );
  return $form;
}