public function DomainSelection::buildConfigurationForm in Domain Access 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 DefaultSelection::buildConfigurationForm

File

domain/src/Plugin/EntityReferenceSelection/DomainSelection.php, line 64

Class

DomainSelection

Provides entity reference selections for the domain entity type.

Namespace

Drupal\domain\Plugin\EntityReferenceSelection

Code

public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
  $form = parent::buildConfigurationForm($form, $form_state);
  $selection_handler_settings = $this->configuration;

  // Merge-in default values.
  $selection_handler_settings += [
    // For the 'target_bundles' setting, a NULL value is equivalent to "allow
    // entities from any bundle to be referenced" and an empty array value is
    // equivalent to "no entities from any bundle can be referenced".
    'target_bundles' => NULL,
    'sort' => [
      'field' => 'weight',
      'direction' => 'ASC',
    ],
    'auto_create' => FALSE,
    'default_selection' => 'current',
  ];
  $form['target_bundles'] = [
    '#type' => 'value',
    '#value' => NULL,
  ];
  $fields = [
    'weight' => $this
      ->t('Weight'),
    'label' => $this
      ->t('Name'),
    'hostname' => $this
      ->t('Hostname'),
  ];
  $form['sort']['field'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Sort by'),
    '#options' => $fields,
    '#ajax' => FALSE,
    '#default_value' => $selection_handler_settings['sort']['field'],
  ];
  $form['sort']['direction'] = [
    '#type' => 'select',
    '#title' => $this
      ->t('Sort direction'),
    '#required' => TRUE,
    '#options' => [
      'ASC' => $this
        ->t('Ascending'),
      'DESC' => $this
        ->t('Descending'),
    ],
    '#default_value' => $selection_handler_settings['sort']['direction'],
  ];
  return $form;
}