You are here

Home » API reference » Editor Notes 8 » EditorNoteWidget.php

class EditorNoteWidget in Editor Notes 8

Editor note widget.

Plugin annotation


@FieldWidget(
  id = "editor_note_widget",
  label = @Translation("Editor Note"),
  module = "editor_note",
  field_types = {
    "editor_note_item"
  }
)

Hierarchy

Expanded class hierarchy of EditorNoteWidget

File

src/Plugin/Field/FieldWidget/EditorNoteWidget.php, line 27

Namespace

Drupal\editor_note\Plugin\Field\FieldWidget
View source 
class EditorNoteWidget extends WidgetBase implements ContainerFactoryPluginInterface {
  use StringTranslationTrait;

  /**
   * The editor note helper.
   *
   * @var \Drupal\editor_note\EditorNoteHelperService
   */
  protected $editorNoteHelper;

  /**
   * Constructs a CountryDefaultWidget object.
   *
   * @param string $plugin_id
   *   The plugin_id for the formatter.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   *   The definition of the field to which the formatter is associated.
   * @param array $settings
   *   The formatter settings.
   * @param array $third_party_settings
   *   Any third party settings settings.
   * @param \Drupal\editor_note\EditorNoteHelperService $editorNoteHelper
   *   Editor note helpers.
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EditorNoteHelperService $editorNoteHelper) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->editorNoteHelper = $editorNoteHelper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings'], $container
      ->get('editor_note.helper'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    $formats = filter_formats();
    $format = reset($formats);
    return [
      'formatted' => FALSE,
      'default_format' => $format
        ->id(),
      'limit' => 10,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element = parent::settingsForm($form, $form_state);

    // @todo: implement support for text formats.
    $element['formatted'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Formatted'),
      '#default_value' => $this
        ->getSetting('formatted'),
      '#weight' => -1,
      '#disabled' => TRUE,
    ];
    $options = [];
    foreach (filter_formats() as $format) {
      $options[$format
        ->id()] = $format
        ->label();
    }
    $field_name = $this->fieldDefinition
      ->getName();
    $element['default_format'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Default format'),
      '#options' => $options,
      '#default_value' => $this
        ->getSetting('default_format'),
      '#states' => [
        'visible' => [
          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][formatted]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $element['limit'] = [
      '#type' => 'number',
      '#title' => $this
        ->t('Display a specified number of items.'),
      '#description' => $this
        ->t('Display a specified number of items. Set 0 for no limit.'),
      '#default_value' => $this
        ->getSetting('limit'),
    ];

    //    Not fully implemented pagination flow.
    //    @see https://www.drupal.org/project/editor_note/issues/3087584
    //    $element['pager_enabled'] = [
    //      '#type' => 'checkbox',
    //      '#title' => t('Enable pagination'),
    //      '#default_value' => $this->getSetting('pager_enabled'),
    //      '#description' => t('Whether to display pagination if number of notes added is greater that can be displayed.'),
    //      '#states' => [
    //        'invisible' => [
    //          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][limit]"]' => ['value' => 0],
    //        ],
    //      ],
    //    ];
    //
    //    $element['pager_below'] = [
    //      '#type' => 'checkbox',
    //      '#title' => t('Pagination below notes table'),
    //      '#default_value' => $this->getSetting('pager_below'),
    //      '#description' => t('Displays pagination below the notes table, if unchecked pagination displays above the table.'),
    //      '#states' => [
    //        'visible' => [
    //          ':input[name="fields[' . $field_name . '][settings_edit_form][settings][pager_enabled]"]' => ['checked' => TRUE],
    //        ],
    //      ],
    //    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = parent::settingsSummary();
    $is_formatted = $this
      ->getSetting('formatted');
    $label = $is_formatted ? $this
      ->t('Yes') : $this
      ->t('No');
    $summary[] = $this
      ->t('Formatted: @formatted', [
      '@formatted' => $label,
    ]);
    if ($is_formatted) {
      $format = filter_formats()[$this
        ->getSetting('default_format')];
      $summary[] = $this
        ->t('Default format: @format', [
        '@format' => $format
          ->label(),
      ]);
    }
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $entity = $items
      ->getEntity();
    $wrapper_id = 'editor-notes-' . $delta;
    if (!$entity
      ->hasField('path')) {
      $access = $entity
        ->access('edit');
    }
    else {
      $access = $entity
        ->get('path')
        ->access('edit');
    }
    $element = [
      '#type' => 'details',
      '#title' => $this
        ->t('Editor Notes'),
      '#element_validate' => [
        [
          $this,
          'validate',
        ],
      ],
      '#access' => $access,
      '#attributes' => [
        'class' => [
          'editor-notes-form',
        ],
        'id' => $wrapper_id,
      ],
    ];
    $widget_settings = $this
      ->getSettings();
    $notes = $this->editorNoteHelper
      ->getNotesByEntityAndField($entity
      ->id(), $this->fieldDefinition
      ->getName(), $widget_settings);
    if (!empty($notes)) {
      $element['table'] = $this->editorNoteHelper
        ->generateTable($this->fieldDefinition, $notes, TRUE);
    }

    // Determine should it be formatted field or not.
    if ($this
      ->getSetting('formatted')) {
      $element['editor_notes'] = [
        '#type' => 'text_format',
        '#format' => $this
          ->getSetting('default_format'),
        '#default_value' => '',
      ];
    }
    else {
      $element['editor_notes'] = [
        '#type' => 'textarea',
        '#default_value' => '',
      ];
    }

    // Add "Add Note" button to only existed entities.
    if (!empty($entity) && !$entity
      ->isNew()) {
      $element['add_note'] = [
        '#type' => 'button',
        '#value' => $this
          ->t('Add Note'),
        '#attributes' => [
          'data-type' => 'ajax-submit-note',
        ],
        '#ajax' => [
          'callback' => [
            $this,
            'onNoteSubmit',
          ],
          'wrapper' => $wrapper_id,
        ],
      ];
    }
    return $element;
  }

  /**
   * Ajax callback for 'Add Note button'.
   *
   * @param array $form
   *   The form structure where widgets are being attached to. This might be a
   *   full form structure, or a sub-element of a larger form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   *
   * @return array
   *   Form element.
   */
  public function onNoteSubmit(array $form, FormStateInterface $form_state) {
    $button = $form_state
      ->getTriggeringElement();
    $element =& NestedArray::getValue($form, array_slice($button['#array_parents'], 0, -1));
    $host_entity = $form_state
      ->getFormObject()
      ->getEntity();
    $field_name = $button['#array_parents'][0];

    // @todo: implement support for text formats.
    $format = 'plain_text';

    // Get value depending  on formatted field or not.
    if ($this
      ->getSetting('formatted')) {
      $value = $element['editor_notes']['value']['#value'];
      $format = $element['editor_notes']['value']['#format'];
    }
    else {
      $value = $element['editor_notes']['#value'];
    }
    if (!empty(trim($value))) {

      // Save Editor Note entity.
      $this->editorNoteHelper
        ->createNote($host_entity, $field_name, $value, $format);
    }
    $notes = $this->editorNoteHelper
      ->getNotesByEntityAndField($host_entity
      ->id(), $field_name, $this
      ->getSettings());

    // Rebuild Editor Notes table.
    $table = $this->editorNoteHelper
      ->generateTable($this->fieldDefinition, $notes, TRUE);

    // Update some element values.
    $element['table'] = $table;
    $element['#open'] = TRUE;
    if ($this
      ->getSetting('formatted')) {
      $element['editor_notes']['value']['#value'] = '';
    }
    else {
      $element['editor_notes']['#value'] = '';
    }
    return $element;
  }

  /**
   * Validate the editor note field.
   *
   * @param array $element
   *   Element array.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form State object.
   */
  public function validate(array $element, FormStateInterface $form_state) {
    if ($this
      ->getSetting('formatted')) {
      $value = $element['editor_notes']['value']['#value'];
    }
    else {
      $value = $element['editor_notes']['#value'];
    }
    $value = trim($value);
    $triggering_control = $form_state
      ->getTriggeringElement();
    if ($triggering_control['#attributes']['data-type'] == 'ajax-submit-note') {
      if (empty($value)) {
        $form_state
          ->setError($element, $this
          ->t('Update note field is required.'));
      }
      else {
        $form_state
          ->clearErrors();
      }
    }
    $form_state
      ->setValueForElement($element, [
      'value' => $value,
    ]);
  }

}

Members

Namesort descending 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
EditorNoteWidget::$editorNoteHelper protected property The editor note helper.
EditorNoteWidget::create public static function Creates an instance of the plugin. Overrides WidgetBase::create
EditorNoteWidget::defaultSettings public static function Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EditorNoteWidget::formElement public function Returns the form for a single field widget. Overrides WidgetInterface::formElement
EditorNoteWidget::onNoteSubmit public function Ajax callback for 'Add Note button'.
EditorNoteWidget::settingsForm public function Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
EditorNoteWidget::settingsSummary public function Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
EditorNoteWidget::validate public function Validate the editor note field.
EditorNoteWidget::__construct public function Constructs a CountryDefaultWidget object. Overrides WidgetBase::__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.
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
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.
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::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