class EntityReferenceDragDropWidget in Entity Reference Drag & Drop 8

Same name and namespace in other branches

2.x src/Plugin/Field/FieldWidget/EntityReferenceDragDropWidget.php \Drupal\entityreference_dragdrop\Plugin\Field\FieldWidget\EntityReferenceDragDropWidget

Plugin implementation of the 'entityreference_dragdrop' widget.

Plugin annotation


@FieldWidget(
  id = "entityreference_dragdrop",
  label = @Translation("Drag&Drop"),
  description = @Translation("A widget allowing use drag&drop to edit the field."),
  field_types = {
    "entity_reference"
  },
  multiple_values = TRUE
)

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\OptionsWidgetBase
    class \Drupal\entityreference_dragdrop\Plugin\Field\FieldWidget\EntityReferenceDragDropWidget implements ContainerFactoryPluginInterface

Expanded class hierarchy of EntityReferenceDragDropWidget

File

src/Plugin/Field/FieldWidget/EntityReferenceDragDropWidget.php, line 29

Namespace

Drupal\entityreference_dragdrop\Plugin\Field\FieldWidget

View source

class EntityReferenceDragDropWidget extends OptionsWidgetBase implements ContainerFactoryPluginInterface {
  const VIEW_MODE_TITLE = 'title';

  // Display only entity title.

  /**
   * @var \Drupal\Core\Entity\EntityTypeManager
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\Core\Entity\EntityDisplayRepository
   */
  protected $entityDisplayRepository;

  /**
   * EntityReferenceDragDropWidget constructor.
   *
   * @param string $plugin_id
   * @param mixed $plugin_definition
   * @param \Drupal\Core\Field\FieldDefinitionInterface $field_definition
   * @param array $settings
   * @param array $third_party_settings
   * @param \Drupal\Core\Entity\EntityTypeManager $entity_type_manager
   * @param \Drupal\Core\Entity\EntityDisplayRepository $entity_display_repository
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityTypeManager $entity_type_manager, EntityDisplayRepository $entity_display_repository) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->entityTypeManager = $entity_type_manager;
    $this->entityDisplayRepository = $entity_display_repository;
  }

  /**
   * {@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('entity_type.manager'), $container
      ->get('entity_display.repository'));
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'view_mode' => static::VIEW_MODE_TITLE,
      'available_entities_label' => 'Available entities',
      'selected_entities_label' => 'Selected entities',
      'display_filter' => 0,
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['view_mode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('View mode'),
      '#options' => $this
        ->viewModeOptions(),
      '#default_value' => $this
        ->getSetting('view_mode'),
    ];
    $element['available_entities_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Available entities label'),
      '#default_value' => $this
        ->getSetting('available_entities_label'),
      '#description' => $this
        ->t('Enter a label that will be displayed above block with available entities.'),
    ];
    $element['selected_entities_label'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('S-elected entities label'),
      '#default_value' => $this
        ->getSetting('selected_entities_label'),
      '#description' => $this
        ->t('Enter a label that will be displayed above block with selected entities.'),
    ];
    $element['display_filter'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Display item filter'),
      '#default_value' => $this
        ->getSetting('display_filter'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function settingsSummary() {
    $summary = [];
    $view_mode = $this
      ->viewModeOptions()[$this
      ->getSetting('view_mode')];
    $summary[] = $this
      ->t('View mode: @view_mode', [
      '@view_mode' => $view_mode,
    ]);
    $summary[] = $this
      ->t('Available entities label: @label', [
      '@label' => $this
        ->getSetting('available_entities_label'),
    ]);
    $summary[] = $this
      ->t('Selected entities label: @label', [
      '@label' => $this
        ->getSetting('selected_entities_label'),
    ]);
    $summary[] = $this
      ->t('Display filter: @filter', [
      '@filter' => $this
        ->getSetting('display_filter') ? $this
        ->t('Yes') : $this
        ->t('No'),
    ]);
    return $summary;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $field_name = $this->fieldDefinition
      ->getName();
    $entity_type = $items
      ->getEntity()
      ->getEntityTypeId();
    $bundle = $items
      ->getEntity()
      ->bundle();
    $entity_id = $items
      ->getEntity()
      ->id() ?: '0';
    $key = $entity_type . '_' . $bundle . '_' . $field_name . '_' . $entity_id;
    $cardinality = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getCardinality();
    $selected = $this
      ->getSelectedOptions($items);
    $available = $this
      ->getAvailableOptions($items);
    $element['label'] = [
      '#type' => 'item',
      '#title' => $element['#title'],
      '#required' => $element['#required'],
      '#value' => 'just some value so #required does not trigger validation error.',
    ];
    if ($cardinality != -1) {
      $element['message'] = [
        '#markup' => '<div class="entityreference-dragdrop-message" data-key="' . $key . '">' . $this
          ->formatPlural($cardinality, 'This field cannot hold more than 1 value.', 'This field cannot hold more than @count values.') . '</div>',
      ];
    }
    $element['available'] = $this
      ->availableOptionsToRenderableArray($available, $key);
    $element['selected'] = $this
      ->selectedOptionsToRenderableArray($selected, $key);
    $element['target_id'] = [
      '#type' => 'hidden',
      '#default_value' => implode(',', array_keys($selected)),
      '#attached' => [
        'library' => [
          'entityreference_dragdrop/init',
        ],
        'drupalSettings' => [
          'entityreference_dragdrop' => [
            $key => $this->fieldDefinition
              ->getFieldStorageDefinition()
              ->getCardinality(),
          ],
        ],
      ],
      '#attributes' => [
        'class' => [
          'entityreference-dragdrop-values',
        ],
        'data-key' => $key,
      ],
    ];
    if ($element['#description']) {
      $element['description'] = [
        '#type' => 'item',
        '#description' => $element['#description'],
      ];
    }
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function massageFormValues(array $values, array $form, FormStateInterface $form_state) {
    return empty($values['target_id']) ? [] : explode(',', $values['target_id']);
  }

  /**
   * {@inheritdoc}
   */
  protected function getSelectedOptions(FieldItemListInterface $items, $delta = 0) {

    // We need to check against a flat list of options.
    $flat_options = OptGroup::flattenOptions($this
      ->getOptions($items
      ->getEntity()));
    $selected_options = [];
    foreach ($items as $item) {
      $id = $item->{$this->column};

      // Keep the value if it actually is in the list of options (needs to be
      // checked against the flat list).
      if (isset($flat_options[$id])) {
        $selected_options[$id] = $flat_options[$id];
      }
    }
    return $selected_options;
  }

  /**
   * Gets a list of available entities for the field.
   *
   * @param \Drupal\Core\Field\FieldItemListInterface $items
   * @return array
   */
  protected function getAvailableOptions(FieldItemListInterface $items) {

    // We need to check against a flat list of options.
    $flat_options = OptGroup::flattenOptions($this
      ->getOptions($items
      ->getEntity()));
    $selected_options = $this
      ->getSelectedOptions($items);
    $available_options = [];
    foreach ($flat_options as $id => $option) {
      if (!in_array($option, $selected_options)) {
        $available_options[$id] = $option;
      }
    }
    return $available_options;
  }

  /**
   * Converts list of options to renderable array.
   *
   * @param array $options
   * @param $key
   * @param $list_title
   * @param array $classes
   * @param array $wrapper_classes
   * @return array
   */
  protected function optionsToRenderableArray(array $options, $key, $list_title, array $classes = [], array $wrapper_classes = []) {

    // view mode is of the form 'node.full_content'
    $view_mode_name = $this
      ->getSetting('view_mode');
    $view_mode_name = explode('.', $view_mode_name);
    $view_mode = end($view_mode_name);
    $target_type_id = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    $items = [];
    $entities = [];
    if ($view_mode !== static::VIEW_MODE_TITLE) {
      $entities = $this->entityTypeManager
        ->getStorage($target_type_id)
        ->loadMultiple(array_keys($options));
    }
    foreach ($options as $id => $entity_title) {
      $item = [
        '#wrapper_attributes' => [
          'data-key' => $key,
          'data-id' => $id,
          'data-label' => $entity_title,
        ],
      ];
      if ($view_mode !== static::VIEW_MODE_TITLE) {
        $item += $this->entityTypeManager
          ->getViewBuilder($target_type_id)
          ->view($entities[$id], $view_mode);
      }
      else {
        $item += [
          '#markup' => $options[$id],
        ];
      }
      $items[] = $item;
    }
    return [
      '#theme' => 'entityreference_dragdrop_options_list',
      '#items' => $items,
      '#title' => $list_title,
      '#display_filter' => $this
        ->getSetting('display_filter'),
      '#attributes' => [
        'data-key' => $key,
        'class' => array_merge([
          'entityreference-dragdrop',
        ], $classes),
      ],
      '#wrapper_attributes' => [
        'class' => array_merge([
          'entityreference-dragdrop-container',
        ], $wrapper_classes),
      ],
    ];
  }

  /**
   * Converts list of selected options to renderable array.
   *
   * @param array $options
   * @param $key
   * @return array
   */
  protected function selectedOptionsToRenderableArray(array $options, $key) {
    return $this
      ->optionsToRenderableArray($options, $key, $this
      ->getSetting('selected_entities_label'), [
      'entityreference-dragdrop-selected',
    ], [
      'entityreference-dragdrop-container-selected',
    ]);
  }

  /**
   * Converts list of available options to renderable array.
   *
   * @param array $options
   * @param $key
   * @return array
   */
  protected function availableOptionsToRenderableArray(array $options, $key) {
    return $this
      ->optionsToRenderableArray($options, $key, $this
      ->getSetting('available_entities_label'), [
      'entityreference-dragdrop-available',
    ], [
      'entityreference-dragdrop-container-available',
    ]);
  }

  /**
   * Gets view mode options.
   *
   * @return array
   */
  protected function viewModeOptions() {
    $target_type_id = $this->fieldDefinition
      ->getFieldStorageDefinition()
      ->getSetting('target_type');
    $view_modes = $this->entityDisplayRepository
      ->getViewModes($target_type_id);
    $options = [
      static::VIEW_MODE_TITLE => $this
        ->t('Title'),
    ];
    foreach ($view_modes as $view_mode) {
      $options[$view_mode['id']] = $view_mode['label'];
    }
    return $options;
  }

}

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
EntityReferenceDragDropWidget::$entityDisplayRepository	protected	property
EntityReferenceDragDropWidget::$entityTypeManager	protected	property
EntityReferenceDragDropWidget::availableOptionsToRenderableArray	protected	function	Converts list of available options to renderable array.
EntityReferenceDragDropWidget::create	public static	function	Creates an instance of the plugin. Overrides WidgetBase::create
EntityReferenceDragDropWidget::defaultSettings	public static	function	Defines the default settings for this plugin. Overrides PluginSettingsBase::defaultSettings
EntityReferenceDragDropWidget::formElement	public	function	Returns the form for a single field widget. Overrides OptionsWidgetBase::formElement
EntityReferenceDragDropWidget::getAvailableOptions	protected	function	Gets a list of available entities for the field.
EntityReferenceDragDropWidget::getSelectedOptions	protected	function	Determines selected options from the incoming field values. Overrides OptionsWidgetBase::getSelectedOptions
EntityReferenceDragDropWidget::massageFormValues	public	function	Massages the form values into the format expected for field values. Overrides WidgetBase::massageFormValues
EntityReferenceDragDropWidget::optionsToRenderableArray	protected	function	Converts list of options to renderable array.
EntityReferenceDragDropWidget::selectedOptionsToRenderableArray	protected	function	Converts list of selected options to renderable array.
EntityReferenceDragDropWidget::settingsForm	public	function	Returns a form to configure settings for the widget. Overrides WidgetBase::settingsForm
EntityReferenceDragDropWidget::settingsSummary	public	function	Returns a short summary for the current widget settings. Overrides WidgetBase::settingsSummary
EntityReferenceDragDropWidget::viewModeOptions	protected	function	Gets view mode options.
EntityReferenceDragDropWidget::VIEW_MODE_TITLE		constant
EntityReferenceDragDropWidget::__construct	public	function	EntityReferenceDragDropWidget constructor. Overrides OptionsWidgetBase::__construct
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
OptionsWidgetBase::$column	protected	property	Abstract over the actual field columns, to allow different field types to reuse those widgets.
OptionsWidgetBase::getEmptyLabel	protected	function	Returns the empty option label to add to the list of options, if any.	2
OptionsWidgetBase::getOptions	protected	function	Returns the array of options for the widget.
OptionsWidgetBase::sanitizeLabel	protected	function	Sanitizes a string label to display as an option.	1
OptionsWidgetBase::supportsGroups	protected	function	Indicates whether the widgets support optgroups.	1
OptionsWidgetBase::validateElement	public static	function	Form validation handler for widget elements.	1
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::setWidgetState	public static	function	Stores processing information about the widget in $form_state. Overrides WidgetBaseInterface::setWidgetState

You are here

class EntityReferenceDragDropWidget in Entity Reference Drag & Drop 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation