class FormTestLabelForm
Same name in other branches
- 8.9.x core/modules/system/tests/modules/form_test/src/Form/FormTestLabelForm.php \Drupal\form_test\Form\FormTestLabelForm
- 10 core/modules/system/tests/modules/form_test/src/Form/FormTestLabelForm.php \Drupal\form_test\Form\FormTestLabelForm
- 11.x core/modules/system/tests/modules/form_test/src/Form/FormTestLabelForm.php \Drupal\form_test\Form\FormTestLabelForm
A form for testing form labels and required marks.
@internal
Hierarchy
- class \Drupal\Core\Form\FormBase implements \Drupal\Core\Form\FormInterface, \Drupal\Core\DependencyInjection\ContainerInjectionInterface uses \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Logger\LoggerChannelTrait, \Drupal\Core\Messenger\MessengerTrait, \Drupal\Core\Routing\RedirectDestinationTrait, \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\form_test\Form\FormTestLabelForm extends \Drupal\Core\Form\FormBase
Expanded class hierarchy of FormTestLabelForm
1 file declares its use of FormTestLabelForm
- ElementsLabelsTest.php in core/
modules/ system/ tests/ src/ Functional/ Form/ ElementsLabelsTest.php
1 string reference to 'FormTestLabelForm'
- 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/ FormTestLabelForm.php, line 13
Namespace
Drupal\form_test\FormView source
class FormTestLabelForm extends FormBase {
/**
* An array of elements that render a title.
*
* @var array
*/
public static $typesWithTitle = [
'checkbox',
'checkboxes',
'color',
'date',
'datelist',
'datetime',
'details',
'email',
'fieldset',
'file',
'item',
'managed_file',
'number',
'password',
'password_confirm',
'radio',
'radios',
'range',
'search',
'select',
'tel',
'textarea',
'textfield',
'text_format',
'url',
'weight',
];
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'form_label_test_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$form['form_checkboxes_test'] = [
'#type' => 'checkboxes',
'#title' => t('Checkboxes test'),
'#options' => [
'first-checkbox' => t('First checkbox'),
'second-checkbox' => t('Second checkbox'),
'third-checkbox' => t('Third checkbox'),
'0' => t('0'),
],
];
$form['form_radios_test'] = [
'#type' => 'radios',
'#title' => t('Radios test'),
'#options' => [
'first-radio' => t('First radio'),
'second-radio' => t('Second radio'),
'third-radio' => t('Third radio'),
'0' => t('0'),
],
// Test #field_prefix and #field_suffix placement.
'#field_prefix' => '<span id="form-test-radios-field-prefix">' . t('Radios #field_prefix element') . '</span>',
'#field_suffix' => '<span id="form-test-radios-field-suffix">' . t('Radios #field_suffix element') . '</span>',
];
$form['form_checkbox_test'] = [
'#type' => 'checkbox',
'#title' => t('Checkbox test'),
];
$form['form_textfield_test_title_and_required'] = [
'#type' => 'textfield',
'#title' => t('Textfield test for required with title'),
'#required' => TRUE,
];
$form['form_textfield_test_no_title_required'] = [
'#type' => 'textfield',
// We use an empty title, since not setting #title suppresses the label
// and required marker.
'#title' => '',
'#required' => TRUE,
];
$form['form_textfield_test_title'] = [
'#type' => 'textfield',
'#title' => t('Textfield test for title only'),
// Not required.
// Test #prefix and #suffix placement.
'#prefix' => '<div id="form-test-textfield-title-prefix">' . t('Textfield #prefix element') . '</div>',
'#suffix' => '<div id="form-test-textfield-title-suffix">' . t('Textfield #suffix element') . '</div>',
];
$form['form_textfield_test_title_after'] = [
'#type' => 'textfield',
'#title' => t('Textfield test for title after element'),
'#title_display' => 'after',
];
$form['form_textfield_test_title_invisible'] = [
'#type' => 'textfield',
'#title' => t('Textfield test for invisible title'),
'#title_display' => 'invisible',
];
// Textfield test for title set not to display.
$form['form_textfield_test_title_no_show'] = [
'#type' => 'textfield',
];
// Checkboxes & radios with title as attribute.
$form['form_checkboxes_title_attribute'] = [
'#type' => 'checkboxes',
'#title' => 'Checkboxes test',
'#title_display' => 'attribute',
'#options' => [
'first-checkbox' => 'First checkbox',
'second-checkbox' => 'Second checkbox',
],
'#required' => TRUE,
];
$form['form_radios_title_attribute'] = [
'#type' => 'radios',
'#title' => 'Radios test',
'#title_display' => 'attribute',
'#options' => [
'first-radio' => 'First radio',
'second-radio' => 'Second radio',
],
'#required' => TRUE,
];
$form['form_checkboxes_title_invisible'] = [
'#type' => 'checkboxes',
'#title' => 'Checkboxes test invisible',
'#title_display' => 'invisible',
'#options' => [
'first-checkbox' => 'First checkbox',
'second-checkbox' => 'Second checkbox',
],
'#required' => TRUE,
];
$form['form_radios_title_invisible'] = [
'#type' => 'radios',
'#title' => 'Radios test invisible',
'#title_display' => 'invisible',
'#options' => [
'first-radio' => 'First radio',
'second-radio' => 'Second radio',
],
'#required' => TRUE,
];
foreach (static::$typesWithTitle as $type) {
$form['form_' . $type . '_title_no_xss'] = [
'#type' => $type,
'#title' => "{$type} <script>alert('XSS')</script> is XSS filtered!",
];
// Add keys that are required for some elements to be processed correctly.
if (in_array($type, [
'checkboxes',
'radios',
], TRUE)) {
$form['form_' . $type . '_title_no_xss']['#options'] = [];
}
if ($type === 'datetime') {
$form['form_' . $type . '_title_no_xss']['#default_value'] = NULL;
}
}
return $form;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
}
}
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 |
FormTestLabelForm::$typesWithTitle | public static | property | An array of elements that render a title. | ||
FormTestLabelForm::buildForm | public | function | Form constructor. | Overrides FormInterface::buildForm | |
FormTestLabelForm::getFormId | public | function | Returns a unique string identifying the form. | Overrides FormInterface::getFormId | |
FormTestLabelForm::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. | 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 '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. | 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.