public function FormTestCheckboxForm::buildForm in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxForm.php \Drupal\form_test\Form\FormTestCheckboxForm::buildForm()
2. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxForm.php \Drupal\form_test\Form\FormTestCheckboxForm::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/FormTestCheckboxForm.php, line 26

Class

FormTestCheckboxForm

Form for testing checkbox.

Namespace

Drupal\form_test\Form

Code

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

  // A required checkbox.
  $form['required_checkbox'] = [
    '#type' => 'checkbox',
    '#required' => TRUE,
    '#title' => 'required_checkbox',
  ];

  // A disabled checkbox should get its default value back.
  $form['disabled_checkbox_on'] = [
    '#type' => 'checkbox',
    '#disabled' => TRUE,
    '#return_value' => 'disabled_checkbox_on',
    '#default_value' => 'disabled_checkbox_on',
    '#title' => 'disabled_checkbox_on',
  ];
  $form['disabled_checkbox_off'] = [
    '#type' => 'checkbox',
    '#disabled' => TRUE,
    '#return_value' => 'disabled_checkbox_off',
    '#default_value' => NULL,
    '#title' => 'disabled_checkbox_off',
  ];

  // A checkbox is active when #default_value == #return_value.
  $form['checkbox_on'] = [
    '#type' => 'checkbox',
    '#return_value' => 'checkbox_on',
    '#default_value' => 'checkbox_on',
    '#title' => 'checkbox_on',
  ];

  // But inactive in any other case.
  $form['checkbox_off'] = [
    '#type' => 'checkbox',
    '#return_value' => 'checkbox_off',
    '#default_value' => 'checkbox_on',
    '#title' => 'checkbox_off',
  ];

  // Checkboxes with a #return_value of '0' are supported.
  $form['zero_checkbox_on'] = [
    '#type' => 'checkbox',
    '#return_value' => '0',
    '#default_value' => '0',
    '#title' => 'zero_checkbox_on',
  ];

  // In that case, passing a #default_value != '0'
  // means that the checkbox is off.
  $form['zero_checkbox_off'] = [
    '#type' => 'checkbox',
    '#return_value' => '0',
    '#default_value' => '1',
    '#title' => 'zero_checkbox_off',
  ];
  $form['submit'] = [
    '#type' => 'submit',
    '#value' => t('Submit'),
  ];
  return $form;
}