class TextareaWithSummaryWidget
Same name in other branches
- 9 core/modules/text/src/Plugin/Field/FieldWidget/TextareaWithSummaryWidget.php \Drupal\text\Plugin\Field\FieldWidget\TextareaWithSummaryWidget
- 10 core/modules/text/src/Plugin/Field/FieldWidget/TextareaWithSummaryWidget.php \Drupal\text\Plugin\Field\FieldWidget\TextareaWithSummaryWidget
- 11.x core/modules/text/src/Plugin/Field/FieldWidget/TextareaWithSummaryWidget.php \Drupal\text\Plugin\Field\FieldWidget\TextareaWithSummaryWidget
Plugin implementation of the 'text_textarea_with_summary' widget.
Plugin annotation
@FieldWidget(
id = "text_textarea_with_summary",
label = @Translation("Text area with a summary"),
field_types = {
"text_with_summary"
}
)
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\StringTextareaWidget extends \Drupal\Core\Field\WidgetBase
- class \Drupal\text\Plugin\Field\FieldWidget\TextareaWidget extends \Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget
- class \Drupal\text\Plugin\Field\FieldWidget\TextareaWithSummaryWidget extends \Drupal\text\Plugin\Field\FieldWidget\TextareaWidget
- class \Drupal\text\Plugin\Field\FieldWidget\TextareaWidget extends \Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget
- class \Drupal\Core\Field\Plugin\Field\FieldWidget\StringTextareaWidget 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 TextareaWithSummaryWidget
1 file declares its use of TextareaWithSummaryWidget
- text.post_update.php in core/
modules/ text/ text.post_update.php - Contains post update hooks for the text module.
File
-
core/
modules/ text/ src/ Plugin/ Field/ FieldWidget/ TextareaWithSummaryWidget.php, line 20
Namespace
Drupal\text\Plugin\Field\FieldWidgetView source
class TextareaWithSummaryWidget extends TextareaWidget {
/**
* {@inheritdoc}
*/
public static function defaultSettings() {
return [
'rows' => '9',
'summary_rows' => '3',
'placeholder' => '',
'show_summary' => FALSE,
] + parent::defaultSettings();
}
/**
* {@inheritdoc}
*/
public function settingsForm(array $form, FormStateInterface $form_state) {
$element = parent::settingsForm($form, $form_state);
$element['summary_rows'] = [
'#type' => 'number',
'#title' => t('Summary rows'),
'#default_value' => $this->getSetting('summary_rows'),
'#description' => $element['rows']['#description'],
'#required' => TRUE,
'#min' => 1,
];
$element['show_summary'] = [
'#type' => 'checkbox',
'#title' => t('Always show the summary field'),
'#default_value' => $this->getSetting('show_summary'),
];
return $element;
}
/**
* {@inheritdoc}
*/
public function settingsSummary() {
$summary = parent::settingsSummary();
$summary[] = t('Number of summary rows: @rows', [
'@rows' => $this->getSetting('summary_rows'),
]);
if ($this->getSetting('show_summary')) {
$summary[] = t('Summary field will always be visible');
}
return $summary;
}
/**
* {@inheritdoc}
*/
public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
$element = parent::formElement($items, $delta, $element, $form, $form_state);
$display_summary = $items[$delta]->summary || $this->getFieldSetting('display_summary');
$required = empty($form['#type']) && $this->getFieldSetting('required_summary');
$element['summary'] = [
'#type' => $display_summary ? 'textarea' : 'value',
'#default_value' => $items[$delta]->summary,
'#title' => t('Summary'),
'#rows' => $this->getSetting('summary_rows'),
'#description' => !$required ? $this->t('Leave blank to use trimmed value of full text as the summary.') : '',
'#attributes' => [
'class' => [
'js-text-summary',
'text-summary',
],
],
'#prefix' => '<div class="js-text-summary-wrapper text-summary-wrapper">',
'#suffix' => '</div>',
'#weight' => -10,
'#required' => $required,
];
if (!$this->getSetting('show_summary') && !$required) {
$element['summary']['#attached']['library'][] = 'text/drupal.text';
}
return $element;
}
/**
* {@inheritdoc}
*/
public function errorElement(array $element, ConstraintViolationInterface $violation, array $form, FormStateInterface $form_state) {
$element = parent::errorElement($element, $violation, $form, $form_state);
return $element === FALSE ? FALSE : $element[$violation->arrayPropertyPath[0]];
}
}
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. | ||
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 | |
TextareaWithSummaryWidget::defaultSettings | public static | function | Defines the default settings for this plugin. | Overrides StringTextareaWidget::defaultSettings | |
TextareaWithSummaryWidget::errorElement | public | function | Assigns a field-level validation error to the right widget sub-element. | Overrides TextareaWidget::errorElement | |
TextareaWithSummaryWidget::formElement | public | function | Returns the form for a single field widget. | Overrides TextareaWidget::formElement | |
TextareaWithSummaryWidget::settingsForm | public | function | Returns a form to configure settings for the widget. | Overrides TextareaWidget::settingsForm | |
TextareaWithSummaryWidget::settingsSummary | public | function | Returns a short summary for the current widget settings. | Overrides StringTextareaWidget::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 | Creates an instance of the plugin. | Overrides ContainerFactoryPluginInterface::create | 5 |
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.