public function StandardSolrCloudConnector::buildConfigurationForm in Search API Solr 8.2

Same name and namespace in other branches

8.3 src/Plugin/SolrConnector/StandardSolrCloudConnector.php \Drupal\search_api_solr\Plugin\SolrConnector\StandardSolrCloudConnector::buildConfigurationForm()
4.x src/Plugin/SolrConnector/StandardSolrCloudConnector.php \Drupal\search_api_solr\Plugin\SolrConnector\StandardSolrCloudConnector::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 SolrConnectorPluginBase::buildConfigurationForm

File

src/Plugin/SolrConnector/StandardSolrCloudConnector.php, line 23

Class

StandardSolrCloudConnector: Standard Solr Cloud connector.

Namespace

Drupal\search_api_solr\Plugin\SolrConnector

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $form['host']['#title'] = $this
    ->t('Solr node');
  $form['host']['#description'] = $this
    ->t('The host name or IP of a Solr node, e.g. <code>localhost</code> or <code>www.example.com</code>.');
  $form['path']['#description'] = $this
    ->t('The path that identifies the Solr instance to use on the node.');
  $form['core']['#title'] = $this
    ->t('Solr collection');
  $form['core']['#description'] = $this
    ->t('The name that identifies the Solr collection to use.');
  $form['timeout']['#description'] = $this
    ->t('The timeout in seconds for search queries sent to the Solr collection.');
  $form['index_timeout']['#description'] = $this
    ->t('The timeout in seconds for indexing requests to the Solr collection.');
  $form['optimize_timeout']['#description'] = $this
    ->t('The timeout in seconds for background index optimization queries on the Solr collection.');
  return $form;
}

You are here