class TestFieldWidgetMultiple
Same name and namespace in other branches
- 9 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidgetMultiple.php \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple
- 8.9.x core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidgetMultiple.php \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple
- 10 core/modules/field/tests/modules/field_test/src/Plugin/Field/FieldWidget/TestFieldWidgetMultiple.php \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple
Plugin implementation of the 'test_field_widget_multiple' widget.
The 'field_types' entry is left empty, and is populated through hook_field_widget_info_alter().
Attributes
#[FieldWidget(id: 'test_field_widget_multiple', label: new TranslatableMarkup('Test widget - multiple'), multiple_values: TRUE, weight: 10)]
Hierarchy
- class \Drupal\Component\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Field\PluginSettingsBase
- class \Drupal\field_test\Plugin\Field\FieldWidget\TestFieldWidgetMultiple implements \Drupal\Core\Field\WidgetBase
- class \Drupal\Core\Field\WidgetBase extends \Drupal\Core\Field\WidgetInterface, \Drupal\Core\Plugin\ContainerFactoryPluginInterface implements \Drupal\Core\Field\PluginSettingsBase
- class \Drupal\Core\Field\PluginSettingsBase extends \Drupal\Core\Field\PluginSettingsInterface, \Drupal\Component\Plugin\DependentPluginInterface implements \Drupal\Core\Plugin\PluginBase
- class \Drupal\Core\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait implements \Drupal\Component\Plugin\PluginBase
Expanded class hierarchy of TestFieldWidgetMultiple
See also
field_test_field_widget_info_alter()
File
-
core/
modules/ field/ tests/ modules/ field_test/ src/ Plugin/ Field/ FieldWidget/ TestFieldWidgetMultiple.php, line 25
Namespace
Drupal\field_test\Plugin\Field\FieldWidgetView source
class TestFieldWidgetMultiple extends WidgetBase {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'test_widget_setting_multiple' => 'dummy test string',
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element['test_widget_setting_multiple'] = [
'#type' => 'textfield',
'#title' => $this->t('Field test field widget setting'),
'#description' => $this->t('A dummy form element to simulate field widget setting.'),
'#default_value' => $this->getSetting('test_widget_setting_multiple'),
'#required' => FALSE,
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = [];
$summary[] = $this->t('@setting: @value', [
'@setting' => 'test_widget_setting_multiple',
'@value' => $this->getSetting('test_widget_setting_multiple'),
]);
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$values = [];
foreach ($items as $item) {
$values[] = $item->value;
}
$element += [
'#type' => 'textfield',
'#default_value' => implode(', ', $values),
'#element_validate' => [
[
static::class,
'multipleValidate',
],
],
];
return $element;
}
/**
* {@inheritdoc}
*/
public function errorElement(array $element, ConstraintViolationInterface $violation, array $form, FormStateInterface $form_state) {
return $element;
}
/**
* Element validation helper.
*/
public static function multipleValidate($element, FormStateInterface $form_state) {
$values = array_map('trim', explode(',', $element['#value']));
$items = [];
foreach ($values as $value) {
$items[] = [
'value' => $value,
];
}
$form_state->setValueForElement($element, $items);
}
/**
* Test is the widget is applicable to the field definition.
*
* @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
* The field definition that should be checked.
*
* @return bool
* TRUE if the machine name of the field is not equals to
* field_onewidgetfield, FALSE otherwise.
*
* @see \Drupal\Tests\field\Functional\EntityReference\EntityReferenceAdminTest::testAvailableFormatters
*/
public static function isApplicable(FieldDefinitionInterface $field_definition) {
// Returns FALSE if machine name of the field equals field_onewidgetfield.
return $field_definition->getName() != "field_onewidgetfield";
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
DependencySerializationTrait::$_entityStorages | protected | property | An array of entity type IDs keyed by the property name of their storages. | |||
DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. | |||
DependencySerializationTrait::__sleep | public | function | 3 | |||
DependencySerializationTrait::__wakeup | public | function | 3 | |||
MessengerTrait::$messenger | protected | property | The messenger. | 25 | ||
MessengerTrait::messenger | public | function | Gets the messenger. | 25 | ||
MessengerTrait::setMessenger | public | function | Sets the messenger. | |||
PluginBase::$configuration | protected | property | Configuration information passed into the plugin. | 1 | ||
PluginBase::$pluginDefinition | protected | property | The plugin implementation definition. | 1 | ||
PluginBase::$pluginId | protected | property | The plugin ID. | |||
PluginBase::DERIVATIVE_SEPARATOR | constant | A string which is used to separate base plugin IDs from the derivative ID. | ||||
PluginBase::getBaseId | public | function | Overrides DerivativeInspectionInterface::getBaseId | |||
PluginBase::getDerivativeId | public | function | Overrides DerivativeInspectionInterface::getDerivativeId | |||
PluginBase::getPluginDefinition | public | function | Overrides PluginInspectionInterface::getPluginDefinition | 2 | ||
PluginBase::getPluginId | public | function | Overrides PluginInspectionInterface::getPluginId | |||
PluginBase::isConfigurable | Deprecated | public | function | Determines if the plugin is configurable. | ||
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 | Overrides DependentPluginInterface::calculateDependencies | 6 | ||
PluginSettingsBase::getSetting | public | function | Overrides PluginSettingsInterface::getSetting | |||
PluginSettingsBase::getSettings | public | function | Overrides PluginSettingsInterface::getSettings | |||
PluginSettingsBase::getThirdPartyProviders | public | function | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
PluginSettingsBase::getThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
PluginSettingsBase::getThirdPartySettings | public | function | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
PluginSettingsBase::mergeDefaults | protected | function | Merges default settings values into $settings. | |||
PluginSettingsBase::onDependencyRemoval | public | function | Overrides PluginSettingsInterface::onDependencyRemoval | 3 | ||
PluginSettingsBase::setSetting | public | function | Overrides PluginSettingsInterface::setSetting | |||
PluginSettingsBase::setSettings | public | function | Overrides PluginSettingsInterface::setSettings | |||
PluginSettingsBase::setThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |||
PluginSettingsBase::unsetThirdPartySetting | public | function | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
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. | 1 | ||
TestFieldWidgetMultiple::defaultSettings | public static | function | Overrides PluginSettingsBase::defaultSettings | |||
TestFieldWidgetMultiple::errorElement | public | function | Overrides WidgetBase::errorElement | |||
TestFieldWidgetMultiple::formElement | public | function | Overrides WidgetBase::formElement | |||
TestFieldWidgetMultiple::isApplicable | public static | function | Test is the widget is applicable to the field definition. | Overrides WidgetBase::isApplicable | ||
TestFieldWidgetMultiple::multipleValidate | public static | function | Element validation helper. | |||
TestFieldWidgetMultiple::settingsForm | public | function | Overrides WidgetBase::settingsForm | |||
TestFieldWidgetMultiple::settingsSummary | public | function | Overrides WidgetBase::settingsSummary | |||
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 | Overrides ContainerFactoryPluginInterface::create | 5 | ||
WidgetBase::deleteAjax | public static | function | Ajax refresh callback for the "Remove" button. | |||
WidgetBase::deleteSubmit | public static | function | Ajax submit callback for the "Remove" button. | |||
WidgetBase::extractFormValues | public | function | Overrides WidgetBaseInterface::extractFormValues | 3 | ||
WidgetBase::flagErrors | public | function | Overrides WidgetBaseInterface::flagErrors | 2 | ||
WidgetBase::form | public | function | 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 | 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::isDefaultValueWidget | protected | function | Returns whether the widget used for default value form. | |||
WidgetBase::massageFormValues | public | function | Overrides WidgetInterface::massageFormValues | 7 | ||
WidgetBase::setWidgetState | public static | function | Overrides WidgetBaseInterface::setWidgetState | |||
WidgetBase::singleElementObject | public | function | Overrides WidgetInterface::singleElementObject | 1 | ||
WidgetBase::__construct | public | function | Constructs a WidgetBase object. | Overrides PluginBase::__construct | 5 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.