class FormTestCheckboxForm in Drupal 9

Form for testing checkbox.

@internal

Hierarchy

• class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, RedirectDestinationTrait, StringTranslationTrait
  • class \Drupal\form_test\Form\FormTestCheckboxForm

1 string reference to 'FormTestCheckboxForm'

form_test.routing.yml in core/modules/system/tests/modules/form_test/form_test.routing.yml

core/modules/system/tests/modules/form_test/form_test.routing.yml

File

core/modules/system/tests/modules/form_test/src/Form/FormTestCheckboxForm.php, line 14

Namespace

Drupal\form_test\Form

class FormTestCheckboxForm extends FormBase {

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return '_test_checkbox_form';
  }

  /**
   * {@inheritdoc}
   */
  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;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $form_state
      ->setResponse(new JsonResponse($form_state
      ->getValues()));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
FormBase::$configFactory	protected	property	The config factory.	3
FormBase::$requestStack	protected	property	The request stack.	1
FormBase::$routeMatch	protected	property	The route match.
FormBase::config	protected	function	Retrieves a configuration object.
FormBase::configFactory	protected	function	Gets the config factory for this form.	3
FormBase::container	private	function	Returns the service container.
FormBase::create	public static	function	Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create	105
FormBase::currentUser	protected	function	Gets the current user.
FormBase::getRequest	protected	function	Gets the request object.
FormBase::getRouteMatch	protected	function	Gets the route match.
FormBase::logger	protected	function	Gets the logger for a specific channel.
FormBase::redirect	protected	function	Returns a redirect response object for the specified route.
FormBase::resetConfigFactory	public	function	Resets the configuration factory.
FormBase::setConfigFactory	public	function	Sets the config factory for this form.
FormBase::setRequestStack	public	function	Sets the request stack object to use.
FormBase::validateForm	public	function	Form validation handler. Overrides FormInterface::validateForm	72
FormTestCheckboxForm::buildForm	public	function	Form constructor. Overrides FormInterface::buildForm
FormTestCheckboxForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormTestCheckboxForm::submitForm	public	function	Form submission handler. Overrides FormInterface::submitForm
LoggerChannelTrait::$loggerFactory	protected	property	The logger channel factory service.
LoggerChannelTrait::getLogger	protected	function	Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory	public	function	Injects the logger channel factory.
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
RedirectDestinationTrait::$redirectDestination	protected	property	The redirect destination service.	1
RedirectDestinationTrait::getDestinationArray	protected	function	Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination	protected	function	Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination	public	function	Sets the redirect destination service.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.