You are here

Home » API reference » Typed Data API enhancements 8 » TextareaWidget.php

class TextareaWidget in Typed Data API enhancements 8

Plugin implementation of the 'textarea' widget.

Plugin annotation


@TypedDataFormWidget(
  id = "textarea",
  label = @Translation("Textarea"),
  description = @Translation("A multi-line text input widget."),
)

Hierarchy

Expanded class hierarchy of TextareaWidget

File

src/Plugin/TypedDataFormWidget/TextareaWidget.php, line 27

Namespace

Drupal\typed_data\Plugin\TypedDataFormWidget
View source 
class TextareaWidget extends FormWidgetBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return parent::defaultConfiguration() + [
      'label' => NULL,
      'description' => NULL,
      'placeholder' => NULL,
      'rows' => 5,
      'cols' => 60,
      'resizable' => 'both',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function isApplicable(DataDefinitionInterface $definition) {
    if (is_subclass_of($definition
      ->getClass(), StringInterface::class)) {
      $result = TRUE;

      // Never use textarea for editing dates, durations, e-mail or URIs.
      $classes = [
        DateTimeInterface::class,
        DurationInterface::class,
        Email::class,
        UriInterface::class,
      ];
      foreach ($classes as $class) {
        $result = $result && !is_subclass_of($definition
          ->getClass(), $class) && $definition
          ->getClass() != $class;
      }
      return $result;
    }
    else {
      return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function form(TypedDataInterface $data, SubformStateInterface $form_state) {
    $form = SubformState::getNewSubForm();
    $form['value'] = [
      '#type' => 'textarea',
      '#title' => $this->configuration['label'] ?: $data
        ->getDataDefinition()
        ->getLabel(),
      '#description' => $this->configuration['description'] ?: $data
        ->getDataDefinition()
        ->getDescription(),
      '#default_value' => $data
        ->getValue(),
      '#placeholder' => $this->configuration['placeholder'],
      '#rows' => $this->configuration['rows'],
      '#cols' => $this->configuration['cols'],
      '#resizable' => $this->configuration['resizable'],
      '#required' => $data
        ->getDataDefinition()
        ->isRequired(),
      '#disabled' => $data
        ->getDataDefinition()
        ->isReadOnly(),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function extractFormValues(TypedDataInterface $data, SubformStateInterface $form_state) {

    // Ensure empty values correctly end up as NULL value.
    $value = $form_state
      ->getValue('value');
    if ($value === '') {
      $value = NULL;
    }
    $data
      ->setValue($value);
  }

  /**
   * {@inheritdoc}
   */
  public function flagViolations(TypedDataInterface $data, ConstraintViolationListInterface $violations, SubformStateInterface $formState) {
    foreach ($violations as $violation) {

      /** @var ConstraintViolationInterface $violation */
      $formState
        ->setErrorByName('value', $violation
        ->getMessage());
    }
  }

  /**
   * {@inheritdoc}
   */
  public function getConfigurationDefinitions(DataDefinitionInterface $definition) {
    return [
      'label' => DataDefinition::create('string')
        ->setLabel($this
        ->t('Label')),
      'description' => DataDefinition::create('string')
        ->setLabel($this
        ->t('Description')),
      'placeholder' => DataDefinition::create('string')
        ->setLabel($this
        ->t('Placeholder value')),
      'rows' => DataDefinition::create('integer')
        ->setLabel($this
        ->t('Number of rows in the text box')),
      'cols' => DataDefinition::create('integer')
        ->setLabel($this
        ->t('Number of columns in the text box')),
      'resizable' => DataDefinition::create('string')
        ->setLabel($this
        ->t('Controls whether the text area is resizable'))
        ->setDescription($this
        ->t('Allowed values are "none", "vertical", "horizontal", or "both".')),
    ];
  }

}

Members

Namesort descending Modifiers Type Description 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 1
DependencySerializationTrait::__wakeup public function 2
FormWidgetBase::$typedDataManager protected property The typed data plugin manager.
FormWidgetBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FormWidgetBase::createDefaultDateTime public function Create a default DrupalDateTime object.
FormWidgetBase::getConfiguration public function Gets this plugin's configuration. Overrides ConfigurableInterface::getConfiguration
FormWidgetBase::setConfiguration public function Sets the configuration for this plugin instance. Overrides ConfigurableInterface::setConfiguration
FormWidgetBase::__construct public function Constructs a FormWidgetBase object. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
TextareaWidget::defaultConfiguration public function Gets default configuration for this plugin. Overrides FormWidgetBase::defaultConfiguration
TextareaWidget::extractFormValues public function Extracts the data value from submitted form values. Overrides FormWidgetInterface::extractFormValues
TextareaWidget::flagViolations public function Reports validation errors against actual form elements. Overrides FormWidgetInterface::flagViolations
TextareaWidget::form public function Creates the widget's form elements for editing the given data. Overrides FormWidgetInterface::form
TextareaWidget::getConfigurationDefinitions public function Defines the supported configuration settings. Overrides FormWidgetInterface::getConfigurationDefinitions
TextareaWidget::isApplicable public function Returns if the widget can be used for the provided data. Overrides FormWidgetInterface::isApplicable