class BooleanCheckboxWidget
Same name in other branches
- 9 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\BooleanCheckboxWidget
- 10 core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\BooleanCheckboxWidget
- 11.x core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/BooleanCheckboxWidget.php \Drupal\Core\Field\Plugin\Field\FieldWidget\BooleanCheckboxWidget
Plugin implementation of the 'boolean_checkbox' widget.
Plugin annotation
@FieldWidget(
id = "boolean_checkbox",
label = @Translation("Single on/off checkbox"),
field_types = {
"boolean"
},
multiple_values = TRUE
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Field\AllowedTagsXssTrait
- class \Drupal\Core\Field\Plugin\Field\FieldWidget\BooleanCheckboxWidget extends \Drupal\Core\Field\WidgetBase
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\PluginSettingsBase implements \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface uses \Drupal\Core\Field\AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of BooleanCheckboxWidget
File
-
core/
lib/ Drupal/ Core/ Field/ Plugin/ Field/ FieldWidget/ BooleanCheckboxWidget.php, line 21
Namespace
Drupal\Core\Field\Plugin\Field\FieldWidgetView source
class BooleanCheckboxWidget extends WidgetBase {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'display_label' => TRUE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element['display_label'] = [
'#type' => 'checkbox',
'#title' => t('Use field label instead of the "On" label as the label.'),
'#default_value' => $this->getSetting('display_label'),
'#weight' => -1,
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$display_label = $this->getSetting('display_label');
$summary[] = t('Use field label: @display_label', [
'@display_label' => $display_label ? t('Yes') : t('No'),
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element['value'] = $element + [
'#type' => 'checkbox',
'#default_value' => !empty($items[0]->value),
];
// Override the title from the incoming $element.
if ($this->getSetting('display_label')) {
$element['value']['#title'] = $this->fieldDefinition
->getLabel();
}
else {
$element['value']['#title'] = $this->fieldDefinition
->getSetting('on_label');
}
return $element;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AllowedTagsXssTrait::allowedTags | public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | ||
AllowedTagsXssTrait::displayAllowedTags | public | function | Returns a human-readable list of allowed tags for display in help texts. | ||
AllowedTagsXssTrait::fieldFilterXss | public | function | Filters an HTML string to prevent XSS vulnerabilities. | ||
BooleanCheckboxWidget::defaultSettings | public static | function | Defines the default settings for this plugin. | Overrides PluginSettingsBase::defaultSettings | |
BooleanCheckboxWidget::formElement | public | function | Returns the form for a single field widget. | Overrides WidgetInterface::formElement | |
BooleanCheckboxWidget::settingsForm | public | function | Returns a form to configure settings for the widget. | Overrides WidgetBase::settingsForm | |
BooleanCheckboxWidget::settingsSummary | public | function | Returns a short summary for the current widget settings. | Overrides WidgetBase::settingsSummary | |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
PluginSettingsBase::$defaultSettingsMerged | protected | property | Whether default settings have been merged into the current $settings. | ||
PluginSettingsBase::$thirdPartySettings | protected | property | The plugin settings injected by third party modules. | ||
PluginSettingsBase::calculateDependencies | public | function | Calculates dependencies for the configured plugin. | Overrides DependentPluginInterface::calculateDependencies | 6 |
PluginSettingsBase::getSetting | public | function | Returns the value of a setting, or its default value if absent. | Overrides PluginSettingsInterface::getSetting | |
PluginSettingsBase::getSettings | public | function | Returns the array of settings, including defaults for missing settings. | Overrides PluginSettingsInterface::getSettings | |
PluginSettingsBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |
PluginSettingsBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |
PluginSettingsBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |
PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | ||
PluginSettingsBase::onDependencyRemoval | public | function | Informs the plugin that some configuration it depends on will be deleted. | Overrides PluginSettingsInterface::onDependencyRemoval | 3 |
PluginSettingsBase::setSetting | public | function | Sets the value of a setting for the plugin. | Overrides PluginSettingsInterface::setSetting | |
PluginSettingsBase::setSettings | public | function | Sets the settings for the plugin. | Overrides PluginSettingsInterface::setSettings | |
PluginSettingsBase::setThirdPartySetting | public | function | Sets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |
PluginSettingsBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |
WidgetBase::$fieldDefinition | protected | property | The field definition. | ||
WidgetBase::$settings | protected | property | The widget settings. | Overrides PluginSettingsBase::$settings | |
WidgetBase::addMoreAjax | public static | function | Ajax callback for the "Add another item" button. | ||
WidgetBase::addMoreSubmit | public static | function | Submission handler for the "Add another item" button. | ||
WidgetBase::afterBuild | public static | function | After-build handler for field elements in a form. | ||
WidgetBase::create | public static | function | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 5 |
WidgetBase::errorElement | public | function | Assigns a field-level validation error to the right widget sub-element. | Overrides WidgetInterface::errorElement | 8 |
WidgetBase::extractFormValues | public | function | Extracts field values from submitted form values. | Overrides WidgetBaseInterface::extractFormValues | 2 |
WidgetBase::flagErrors | public | function | Reports field-level validation errors against actual form elements. | Overrides WidgetBaseInterface::flagErrors | 2 |
WidgetBase::form | public | function | Creates a form element for a field. | Overrides WidgetBaseInterface::form | 3 |
WidgetBase::formMultipleElements | protected | function | Special handling to create form elements for multiple values. | 1 | |
WidgetBase::formSingleElement | protected | function | Generates the form element for a single copy of the widget. | ||
WidgetBase::getFieldSetting | protected | function | Returns the value of a field setting. | ||
WidgetBase::getFieldSettings | protected | function | Returns the array of field settings. | ||
WidgetBase::getFilteredDescription | protected | function | Returns the filtered field description. | ||
WidgetBase::getWidgetState | public static | function | Retrieves processing information about the widget from $form_state. | Overrides WidgetBaseInterface::getWidgetState | |
WidgetBase::getWidgetStateParents | protected static | function | Returns the location of processing information within $form_state. | ||
WidgetBase::handlesMultipleValues | protected | function | Returns whether the widget handles multiple values. | ||
WidgetBase::isApplicable | public static | function | Returns if the widget can be used for the provided field. | Overrides WidgetInterface::isApplicable | 4 |
WidgetBase::isDefaultValueWidget | protected | function | Returns whether the widget used for default value form. | ||
WidgetBase::massageFormValues | public | function | Massages the form values into the format expected for field values. | Overrides WidgetInterface::massageFormValues | 7 |
WidgetBase::setWidgetState | public static | function | Stores processing information about the widget in $form_state. | Overrides WidgetBaseInterface::setWidgetState | |
WidgetBase::__construct | public | function | Constructs a WidgetBase object. | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.