class TextareaWithSummaryWidget

Plugin implementation of the 'text_textarea_with_summary' widget.

Plugin annotation


@Plugin(
  id = "text_textarea_with_summary",
  module = "text",
  label = @Translation("Text area with a summary"),
  field_types = {
    "text_with_summary"
  },
  settings = {
    "rows" = "9",
    "summary_rows" = "3",
    "placeholder" = ""
  }
)

Hierarchy

Expanded class hierarchy of TextareaWithSummaryWidget

File

drupal/core/modules/text/lib/Drupal/text/Plugin/field/widget/TextareaWithSummaryWidget.php, line 30
Definition of Drupal\text\Plugin\field\widget\TextareaWithSummaryWidget.

Namespace

Drupal\text\Plugin\field\widget
View source
class TextareaWithSummaryWidget extends TextareaWidget {

  /**
   * Overrides TextareaWidget::formElement().
   */
  function formElement(array $items, $delta, array $element, $langcode, array &$form, array &$form_state) {
    $element = parent::formElement($items, $delta, $element, $langcode, $form, $form_state);
    $display_summary = !empty($items[$delta]['summary']) || $this->instance['settings']['display_summary'];
    $element['summary'] = array(
      '#type' => $display_summary ? 'textarea' : 'value',
      '#default_value' => isset($items[$delta]['summary']) ? $items[$delta]['summary'] : NULL,
      '#title' => t('Summary'),
      '#rows' => $this
        ->getSetting('summary_rows'),
      '#description' => t('Leave blank to use trimmed value of full text as the summary.'),
      '#attached' => array(
        'library' => array(
          array(
            'text',
            'drupal.text',
          ),
        ),
      ),
      '#attributes' => array(
        'class' => array(
          'text-summary',
        ),
      ),
      '#prefix' => '<div class="text-summary-wrapper">',
      '#suffix' => '</div>',
      '#weight' => -10,
    );
    return $element;
  }

  /**
   * Overrides TextareaWidget::errorElement().
   */
  public function errorElement(array $element, array $error, array $form, array &$form_state) {
    switch ($error['error']) {
      case 'text_summary_max_length':
        $error_element = $element['summary'];
        break;
      default:
        $error_element = $element;
        break;
    }
    return $error_element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::getPluginDefinition public function Returns the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginSettingsBase::$defaultSettingsMerged protected property Whether default settings have been merged into the current $settings.
PluginSettingsBase::getDefaultSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getDefaultSettings(). Overrides PluginSettingsInterface::getDefaultSettings
PluginSettingsBase::getSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSetting(). Overrides PluginSettingsInterface::getSetting
PluginSettingsBase::getSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::getSettings(). Overrides PluginSettingsInterface::getSettings
PluginSettingsBase::mergeDefaults protected function Merges default settings values into $settings.
PluginSettingsBase::setSetting public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSetting(). Overrides PluginSettingsInterface::setSetting
PluginSettingsBase::setSettings public function Implements Drupal\field\Plugin\PluginSettingsInterface::setSettings(). Overrides PluginSettingsInterface::setSettings
TextareaWidget::settingsForm public function Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::settingsForm(). Overrides WidgetBase::settingsForm
TextareaWithSummaryWidget::errorElement public function Overrides TextareaWidget::errorElement(). Overrides WidgetBase::errorElement
TextareaWithSummaryWidget::formElement function Overrides TextareaWidget::formElement(). Overrides TextareaWidget::formElement
WidgetBase::$field protected property The field definition.
WidgetBase::$instance protected property The field instance definition.
WidgetBase::$settings protected property The widget settings. Overrides PluginSettingsBase::$settings
WidgetBase::extractFormValues public function Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::extractFormValues(). Overrides WidgetBaseInterface::extractFormValues
WidgetBase::flagErrors public function Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::flagErrors(). Overrides WidgetBaseInterface::flagErrors
WidgetBase::form public function Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::form(). Overrides WidgetBaseInterface::form
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::massageFormValues public function Implements Drupal\field\Plugin\Type\Widget\WidgetInterface::massageFormValues() Overrides WidgetInterface::massageFormValues 2
WidgetBase::sortItems protected function Sorts submitted field values according to drag-n-drop reordering.
WidgetBase::__construct public function Constructs a WidgetBase object. Overrides PluginBase::__construct 3