public function NodeSearch::buildConfigurationForm in Drupal 9

Same name and namespace in other branches

8 core/modules/node/src/Plugin/Search/NodeSearch.php \Drupal\node\Plugin\Search\NodeSearch::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

core/modules/node/src/Plugin/Search/NodeSearch.php, line 822

Class

NodeSearch: Handles searching for node entities using the Search module index.

Namespace

Drupal\node\Plugin\Search

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {

  // Output form for defining rank factor weights.
  $form['content_ranking'] = [
    '#type' => 'details',
    '#title' => t('Content ranking'),
    '#open' => TRUE,
  ];
  $form['content_ranking']['info'] = [
    '#markup' => '<p><em>' . $this
      ->t('Influence is a numeric multiplier used in ordering search results. A higher number means the corresponding factor has more influence on search results; zero means the factor is ignored. Changing these numbers does not require the search index to be rebuilt. Changes take effect immediately.') . '</em></p>',
  ];

  // Prepare table.
  $header = [
    $this
      ->t('Factor'),
    $this
      ->t('Influence'),
  ];
  $form['content_ranking']['rankings'] = [
    '#type' => 'table',
    '#header' => $header,
  ];

  // Note: reversed to reflect that higher number = higher ranking.
  $range = range(0, 10);
  $options = array_combine($range, $range);
  foreach ($this
    ->getRankings() as $var => $values) {
    $form['content_ranking']['rankings'][$var]['name'] = [
      '#markup' => $values['title'],
    ];
    $form['content_ranking']['rankings'][$var]['value'] = [
      '#type' => 'select',
      '#options' => $options,
      '#attributes' => [
        'aria-label' => $this
          ->t("Influence of '@title'", [
          '@title' => $values['title'],
        ]),
      ],
      '#default_value' => isset($this->configuration['rankings'][$var]) ? $this->configuration['rankings'][$var] : 0,
    ];
  }
  return $form;
}

You are here