WebformEntityOptionsTrait.php in Webform 6.x

Namespace

Drupal\webform\Plugin\WebformElement

File

src/Plugin/WebformElement/WebformEntityOptionsTrait.php

<?php

namespace Drupal\webform\Plugin\WebformElement;

use Drupal\webform\WebformSubmissionInterface;

/**
 * Provides an 'entity_reference' with options trait.
 */
trait WebformEntityOptionsTrait {

  /**
   * {@inheritdoc}
   */
  protected function defineDefaultProperties() {
    $properties = parent::defineDefaultProperties() + [
      // Entity reference settings.
      'target_type' => '',
      'selection_handler' => '',
      'selection_settings' => [],
    ];
    unset($properties['options'], $properties['options_description_display']);
    switch ($this
      ->getPluginId()) {
      case 'webform_entity_checkboxes':

        // Remove 'None of the above' options.
        unset($properties['options_none'], $properties['options_none_value'], $properties['options_none_text']);
        break;
      case 'webform_entity_radios':

        // Remove format multiple items.
        unset($properties['format_items'], $properties['format_items_html'], $properties['format_items_text']);
        break;
    }
    return $properties;
  }

  /****************************************************************************/

  /**
   * {@inheritdoc}
   */
  public function prepare(array &$element, WebformSubmissionInterface $webform_submission = NULL) {
    $this
      ->setOptions($element, [
      'webform_submission' => $webform_submission,
    ]);
    parent::prepare($element, $webform_submission);
  }

  /**
   * {@inheritdoc}
   */
  protected function getElementSelectorInputsOptions(array $element) {
    $this
      ->setOptions($element);
    return parent::getElementSelectorInputsOptions($element);
  }

  /**
   * {@inheritdoc}
   */
  public function getElementSelectorSourceValues(array $element) {
    $this
      ->setOptions($element);
    return parent::getElementSelectorSourceValues($element);
  }

  /**
   * {@inheritdoc}
   */
  public function getExportDefaultOptions() {
    return [
      'entity_reference_items' => [
        'id',
        'title',
        'url',
      ],
      'options_single_format' => 'compact',
      'options_multiple_format' => 'compact',
      'options_item_format' => 'label',
    ];
  }

}

Traits

Name	Description
WebformEntityOptionsTrait	Provides an 'entity_reference' with options trait.