FormTestTableSelectFormBase.php

Same filename in other branches
  1. 9 core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php
  2. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php
  3. 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php

Namespace

Drupal\form_test\Form

File

core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php

View source
<?php

namespace Drupal\form_test\Form;

use Drupal\Core\Form\FormBase;
use Drupal\Core\Form\FormStateInterface;

/**
 * Provides a base class for tableselect forms.
 *
 * @internal
 */
abstract class FormTestTableSelectFormBase extends FormBase {
    
    /**
     * Build a form to test the tableselect element.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param $element_properties
     *   An array of element properties for the tableselect element.
     *
     * @return array
     *   A form with a tableselect element and a submit button.
     */
    public function tableselectFormBuilder($form, FormStateInterface $form_state, $element_properties) {
        [
            $header,
            $options,
        ] = _form_test_tableselect_get_data();
        $form['tableselect'] = $element_properties;
        $form['tableselect'] += [
            '#prefix' => '<div id="tableselect-wrapper">',
            '#suffix' => '</div>',
            '#type' => 'tableselect',
            '#header' => $header,
            '#options' => $options,
            '#multiple' => FALSE,
            '#empty' => t('Empty text.'),
            '#ajax' => [
                'callback' => 'form_test_tableselect_ajax_callback',
                'wrapper' => 'tableselect-wrapper',
            ],
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        return $form;
    }

}

Classes

Title Deprecated Summary
FormTestTableSelectFormBase Provides a base class for tableselect forms.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.