Same name and namespace in other branches

1. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php \Drupal\form_test\Form\FormTestClickedButtonForm::buildForm()
2. 9 core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php \Drupal\form_test\Form\FormTestClickedButtonForm::buildForm()
3. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php \Drupal\form_test\Form\FormTestClickedButtonForm::buildForm()
4. main core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php \Drupal\form_test\Form\FormTestClickedButtonForm::buildForm()

Form constructor.

Parameters

array $form: An associative array containing the structure of the form.

\Drupal\Core\Form\FormStateInterface $form_state: The current state of the form.

Return value

array The form structure.

Overrides FormInterface::buildForm

File

core/modules/system/tests/modules/form_test/src/Form/FormTestClickedButtonForm.php, line 27

Class

FormTestClickedButtonForm

Form builder to test button click detection.

Namespace

Drupal\form_test\Form

Code

public function buildForm(array $form, FormStateInterface $form_state, $first = NULL, $second = NULL, $third = NULL) {
  // A single text field. In IE, when a form has only one non-button input
  // field and the ENTER key is pressed while that field has focus, the form
  // is submitted without any information identifying the button responsible
  // for the submission. In other browsers, the form is submitted as though
  // the first button were clicked.
  $form['text'] = [
    '#title' => 'Text',
    '#type' => 'textfield',
  ];
  // Get button configurations, filter out NULL values.
  $args = array_filter([
    $first,
    $second,
    $third,
  ]);
  // Define button types for each argument.
  $button_types = [
    's' => 'submit',
    'i' => 'image_button',
    'b' => 'button',
  ];
  // Loop through each path argument, adding buttons based on the information
  // in the argument. For example, if the path is
  // form-test/clicked-button/s/i/rb, then 3 buttons are added: a 'submit', an
  // 'image_button', and a 'button' with #access=FALSE. This enables form.test
  // to test a variety of combinations.
  foreach ($args as $index => $arg) {
    // Get the button type based on the index of the argument.
    $type = $button_types[$arg] ?? NULL;
    $name = 'button' . ($index + 1);
    if ($type) {
      // Define the button.
      $form[$name] = [
        '#type' => $type,
        '#name' => $name,
      ];
      // Image buttons need a #src; the others need a #value.
      if ($type == 'image_button') {
        $form[$name]['#src'] = 'core/misc/druplicon.png';
      }
      else {
        $form[$name]['#value'] = $name;
      }
      // 'r' for restricted, so we can test that button click detection code
      // correctly takes #access security into account.
      if (str_contains($arg, 'r')) {
        $form[$name]['#access'] = FALSE;
      }
    }
  }
  return $form;
}

---