class EntityReferenceHierarchyAutocomplete in Entity Reference Hierarchy 8.2
Same name and namespace in other branches
- 3.x src/Plugin/Field/FieldWidget/EntityReferenceHierarchyAutocomplete.php \Drupal\entity_hierarchy\Plugin\Field\FieldWidget\EntityReferenceHierarchyAutocomplete
Widget that uses autocomplete.
Plugin annotation
@FieldWidget(
id = "entity_reference_hierarchy_autocomplete",
label = @Translation("Autocomplete"),
description = @Translation("An autocomplete text field with associated data."),
field_types = {
"entity_reference_hierarchy"
}
)
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget
- class \Drupal\entity_hierarchy\Plugin\Field\FieldWidget\EntityReferenceHierarchyAutocomplete
- class \Drupal\Core\Field\Plugin\Field\FieldWidget\EntityReferenceAutocompleteWidget
- class \Drupal\Core\Field\WidgetBase implements WidgetInterface, ContainerFactoryPluginInterface uses AllowedTagsXssTrait
- class \Drupal\Core\Field\PluginSettingsBase implements DependentPluginInterface, PluginSettingsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of EntityReferenceHierarchyAutocomplete
2 files declare their use of EntityReferenceHierarchyAutocomplete
- ForwardRevisionNodeValidationTest.php in tests/
src/ Functional/ ForwardRevisionNodeValidationTest.php - HideWeightFieldFunctionalTest.php in tests/
src/ Functional/ HideWeightFieldFunctionalTest.php
File
- src/
Plugin/ Field/ FieldWidget/ EntityReferenceHierarchyAutocomplete.php, line 22
Namespace
Drupal\entity_hierarchy\Plugin\Field\FieldWidgetView source
class EntityReferenceHierarchyAutocomplete extends EntityReferenceAutocompleteWidget {
const HIDE_WEIGHT = 'hide_weight';
/**
* {@inheritdoc}
*/
public function errorElement(array $element, ConstraintViolationInterface $error, array $form, FormStateInterface $form_state) {
if (isset($element[0]['target_id'])) {
return $element[0]['target_id'];
}
if (isset($element['target_id'])) {
return $element['target_id'];
}
return FALSE;
}
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return parent::defaultSettings() + [
self::HIDE_WEIGHT => FALSE,
];
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
return parent::settingsForm($form, $form_state) + [
'hide_weight' => [
'#type' => 'checkbox',
'#title' => $this
->t('Hide weight field'),
'#description' => $this
->t('Hide the weight field and use the default value instead'),
'#default_value' => $this
->getSetting(self::HIDE_WEIGHT),
],
];
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
if ($this
->getSetting(self::HIDE_WEIGHT)) {
$summary[] = $this
->t('Weight field is hidden');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$widget = [
'#attributes' => [
'class' => [
'form--inline',
'clearfix',
],
],
'#theme_wrappers' => [
'container',
],
];
$widget['target_id'] = parent::formElement($items, $delta, $element, $form, $form_state);
if ($this
->getSetting(self::HIDE_WEIGHT)) {
$widget['weight'] = [
'#type' => 'value',
'#value' => isset($items[$delta]->weight) ? $items[$delta]->weight : 0,
];
}
else {
$widget['weight'] = [
'#type' => 'number',
'#size' => '4',
'#default_value' => isset($items[$delta]) ? $items[$delta]->weight : 1,
'#weight' => 10,
];
if ($this->fieldDefinition
->getFieldStorageDefinition()
->isMultiple()) {
$widget['weight']['#placeholder'] = $this->fieldDefinition
->getSetting('weight_label');
}
else {
$widget['weight']['#title'] = $this->fieldDefinition
->getSetting('weight_label');
}
}
return $widget;
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AllowedTagsXssTrait:: |
public | function | Returns a list of tags allowed by AllowedTagsXssTrait::fieldFilterXss(). | |
AllowedTagsXssTrait:: |
public | function | Returns a human-readable list of allowed tags for display in help texts. | |
AllowedTagsXssTrait:: |
public | function | Filters an HTML string to prevent XSS vulnerabilities. | |
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
EntityReferenceAutocompleteWidget:: |
protected | function | Returns the name of the bundle which will be used for autocreated entities. | |
EntityReferenceAutocompleteWidget:: |
protected | function | Returns the options for the match operator. | |
EntityReferenceAutocompleteWidget:: |
protected | function | Returns the value of a setting for the entity reference selection handler. | |
EntityReferenceAutocompleteWidget:: |
public | function |
Massages the form values into the format expected for field values. Overrides WidgetBase:: |
1 |
EntityReferenceHierarchyAutocomplete:: |
public static | function |
Defines the default settings for this plugin. Overrides EntityReferenceAutocompleteWidget:: |
|
EntityReferenceHierarchyAutocomplete:: |
public | function |
Assigns a field-level validation error to the right widget sub-element. Overrides EntityReferenceAutocompleteWidget:: |
|
EntityReferenceHierarchyAutocomplete:: |
public | function |
Returns the form for a single field widget. Overrides EntityReferenceAutocompleteWidget:: |
|
EntityReferenceHierarchyAutocomplete:: |
constant | |||
EntityReferenceHierarchyAutocomplete:: |
public | function |
Returns a form to configure settings for the widget. Overrides EntityReferenceAutocompleteWidget:: |
|
EntityReferenceHierarchyAutocomplete:: |
public | function |
Returns a short summary for the current widget settings. Overrides EntityReferenceAutocompleteWidget:: |
|
MessengerTrait:: |
protected | property | The messenger. | 29 |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
3 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
PluginSettingsBase:: |
protected | property | Whether default settings have been merged into the current $settings. | |
PluginSettingsBase:: |
protected | property | The plugin settings injected by third party modules. | |
PluginSettingsBase:: |
public | function |
Calculates dependencies for the configured plugin. Overrides DependentPluginInterface:: |
6 |
PluginSettingsBase:: |
public | function |
Returns the value of a setting, or its default value if absent. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Returns the array of settings, including defaults for missing settings. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
protected | function | Merges default settings values into $settings. | |
PluginSettingsBase:: |
public | function |
Informs the plugin that some configuration it depends on will be deleted. Overrides PluginSettingsInterface:: |
3 |
PluginSettingsBase:: |
public | function |
Sets the value of a setting for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the settings for the plugin. Overrides PluginSettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
PluginSettingsBase:: |
public | function |
Unsets a third-party setting. Overrides ThirdPartySettingsInterface:: |
|
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
WidgetBase:: |
protected | property | The field definition. | |
WidgetBase:: |
protected | property |
The widget settings. Overrides PluginSettingsBase:: |
|
WidgetBase:: |
public static | function | Ajax callback for the "Add another item" button. | |
WidgetBase:: |
public static | function | Submission handler for the "Add another item" button. | |
WidgetBase:: |
public static | function | After-build handler for field elements in a form. | |
WidgetBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
5 |
WidgetBase:: |
public | function |
Extracts field values from submitted form values. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Reports field-level validation errors against actual form elements. Overrides WidgetBaseInterface:: |
2 |
WidgetBase:: |
public | function |
Creates a form element for a field. Overrides WidgetBaseInterface:: |
3 |
WidgetBase:: |
protected | function | Special handling to create form elements for multiple values. | 1 |
WidgetBase:: |
protected | function | Generates the form element for a single copy of the widget. | |
WidgetBase:: |
protected | function | Returns the value of a field setting. | |
WidgetBase:: |
protected | function | Returns the array of field settings. | |
WidgetBase:: |
protected | function | Returns the filtered field description. | |
WidgetBase:: |
public static | function |
Retrieves processing information about the widget from $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
protected static | function | Returns the location of processing information within $form_state. | |
WidgetBase:: |
protected | function | Returns whether the widget handles multiple values. | |
WidgetBase:: |
public static | function |
Returns if the widget can be used for the provided field. Overrides WidgetInterface:: |
4 |
WidgetBase:: |
protected | function | Returns whether the widget used for default value form. | |
WidgetBase:: |
public static | function |
Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface:: |
|
WidgetBase:: |
public | function |
Constructs a WidgetBase object. Overrides PluginBase:: |
5 |