class FormTestTableSelectFormBase

Same name in other branches
  1. 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php \Drupal\form_test\Form\FormTestTableSelectFormBase
  2. 10 core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php \Drupal\form_test\Form\FormTestTableSelectFormBase
  3. 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php \Drupal\form_test\Form\FormTestTableSelectFormBase

Provides a base class for tableselect forms.

@internal

Hierarchy

Expanded class hierarchy of FormTestTableSelectFormBase

File

core/modules/system/tests/modules/form_test/src/Form/FormTestTableSelectFormBase.php, line 13

Namespace

Drupal\form_test\Form
View source
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;
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 1
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 73
FormInterface::buildForm public function Form constructor. 198
FormInterface::getFormId public function Returns a unique string identifying the form. 270
FormInterface::submitForm public function Form submission handler. 220
FormTestTableSelectFormBase::tableselectFormBuilder public function Build a form to test the tableselect element.
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. 17
MessengerTrait::messenger public function Gets the messenger. 17
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a &#039;destination&#039; 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. 3
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.

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