class StringTextareaWithCounterWidget in Textfield Counter 8

Plugin implementation of the 'string_textarea_with_counter' widget.

Plugin annotation


@FieldWidget(
  id = "string_textarea_with_counter",
  label = @Translation("Textarea (multiple rows) with counter"),
  field_types = {
    "string_long"
  }
)

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\StringTextareaWidget
    class \Drupal\textfield_counter\Plugin\Field\FieldWidget\StringTextareaWithCounterWidget uses TextFieldCounterWidgetTrait

Expanded class hierarchy of StringTextareaWithCounterWidget

File

src/Plugin/Field/FieldWidget/StringTextareaWithCounterWidget.php, line 20

Namespace

Drupal\textfield_counter\Plugin\Field\FieldWidget

View source

class StringTextareaWithCounterWidget extends StringTextareaWidget {
  use TextFieldCounterWidgetTrait;

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'maxlength' => 0,
      'counter_position' => 'after',
      'js_prevent_submit' => TRUE,
      'count_html_characters' => TRUE,
      'textcount_status_message' => self::getDefaultTextCountStatusMessage(),
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $form = parent::settingsForm($form, $form_state);
    $this
      ->addMaxlengthSettingsFormElement($form);
    $this
      ->addCounterPositionSettingsFormElement($form);
    $this
      ->addJsPreventSubmitSettingsFormElement($form);
    $this
      ->addCountHtmlSettingsFormElement($form);
    $this
      ->addTextCountStatusMessageSettingsFormElement($form);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $this
      ->addMaxlengthSummary($summary);
    $this
      ->addPositionSummary($summary);
    $this
      ->addJsSubmitPreventSummary($summary);
    $this
      ->addCountHtmlSummary($summary);
    $this
      ->addTextCountStatusMessageSummary($summary);
    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);
    if ($maxlength = $this
      ->getSetting('maxlength')) {
      $entity = $items
        ->getEntity();
      $field_defintion = $items
        ->getFieldDefinition();
      $this
        ->fieldFormElement($element['value'], $entity, $field_defintion, $delta);
      $count_html_characters = $this
        ->getSetting('count_html_characters');
      if (isset($element['value'])) {
        $element['value']['#textfield-maxlength'] = $maxlength;
        $element['value']['#textfield-count-html'] = $count_html_characters;
      }
      $element['#textfield-maxlength'] = $maxlength;
      $element['#textfield-count-html'] = $count_html_characters;
      $classes = class_uses($this);
      if (count($classes)) {
        $element['#element_validate'][] = [
          array_pop($classes),
          'validateFieldFormElement',
        ];
      }
    }
    return $element;
  }

}

Members

Name	Modifiers	Type	Description	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.
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
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.
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
StringTextareaWithCounterWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides StringTextareaWidget::defaultSettings
StringTextareaWithCounterWidget::formElement	public	function	Returns the form for a single field widget. Overrides StringTextareaWidget::formElement
StringTextareaWithCounterWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides StringTextareaWidget::settingsForm
StringTextareaWithCounterWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides StringTextareaWidget::settingsSummary
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.
TextFieldCounterWidgetTrait::addCounterPositionSettingsFormElement	public	function	Adds a form element to set the position of the text counter.
TextFieldCounterWidgetTrait::addCountHtmlSettingsFormElement	public	function	Adds a form element to determine whether HTML characters should be counted.
TextFieldCounterWidgetTrait::addCountHtmlSummary	public	function	Adds the summary of the count_html_characters setting.
TextFieldCounterWidgetTrait::addJsPreventSubmitSettingsFormElement	public	function	Adds a form element to toggle JS prevention of form submission on error.
TextFieldCounterWidgetTrait::addJsSubmitPreventSummary	public	function	Adds the summary of the js_prevent_submit setting.
TextFieldCounterWidgetTrait::addMaxlengthSettingsFormElement	public	function	Adds a form element to set the maximum number of characters allowed.
TextFieldCounterWidgetTrait::addMaxlengthSummary	public	function	Adds the summary of the maximum number of allowed characters.
TextFieldCounterWidgetTrait::addPositionSummary	public	function	Adds the summary of the position of the textfield counter.
TextFieldCounterWidgetTrait::addTextCountStatusMessageSettingsFormElement	public	function	Adds a form element to set the status message to be shown to users.
TextFieldCounterWidgetTrait::addTextCountStatusMessageSummary	public	function	Adds the summary of the count_html_characters setting.
TextFieldCounterWidgetTrait::fieldFormElement	public	function	Sets up the form element with the textfield counter.
TextFieldCounterWidgetTrait::getDefaultTextCountStatusMessage	public static	function	Get the default value for the textcount_status_message widget setting.
TextFieldCounterWidgetTrait::getLengthOfSubmittedValue	protected static	function	Get the length of the submitted text value.
TextFieldCounterWidgetTrait::translateValue	private	function	A unified translation function to translate values provided by this module.
TextFieldCounterWidgetTrait::validateFieldFormElement	public static	function	Validates the field for the maximum number of characters.
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::errorElement	public	function	Assigns a field-level validation error to the right widget sub-element. Overrides WidgetInterface::errorElement	8
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. Overrides PluginBase::__construct	5

You are here

class StringTextareaWithCounterWidget in Textfield Counter 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation