EntityReferenceViewsOptionsSelectWidget.php in Entity Reference Views Select 8

Namespace

Drupal\entity_reference_views_select\Plugin\Field\FieldWidget

File

src/Plugin/Field/FieldWidget/EntityReferenceViewsOptionsSelectWidget.php

<?php

namespace Drupal\entity_reference_views_select\Plugin\Field\FieldWidget;

use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Field\FieldDefinitionInterface;
use Drupal\Core\Field\Plugin\Field\FieldWidget\OptionsWidgetBase;
use Drupal\Component\Utility\Html;
use Drupal\Core\Field\FieldItemListInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Render\RendererInterface;
use Drupal\views\ViewExecutableFactory;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;

/**
 * Plugin implementation of the 'erviews_options_select' widget.
 *
 * @FieldWidget(
 *   id = "erviews_options_select",
 *   label = @Translation("Entity Reference Views Select list"),
 *   field_types = {
 *     "entity_reference",
 *   },
 *   multiple_values = TRUE
 * )
 */
class EntityReferenceViewsOptionsSelectWidget extends OptionsWidgetBase implements ContainerFactoryPluginInterface {

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

  /**
   * The exec factory.
   *
   * @var \Drupal\views\ViewExecutableFactory
   */
  protected $viewFactory;

  /**
   * The loader.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $viewLoader;

  /**
   * {@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')
      ->getStorage('view'), $container
      ->get('views.executable'), $container
      ->get('renderer'));
  }

  /**
   * {@inheritdoc}
   */
  public function __construct($plugin_id, $plugin_definition, FieldDefinitionInterface $field_definition, array $settings, array $third_party_settings, EntityStorageInterface $view_loader, ViewExecutableFactory $view_factory, RendererInterface $renderer) {
    parent::__construct($plugin_id, $plugin_definition, $field_definition, $settings, $third_party_settings);
    $this->viewLoader = $view_loader;
    $this->viewFactory = $view_factory;
    $this->renderer = $renderer;
  }

  /**
   * {@inheritdoc}
   */
  public static function defaultSettings() {
    return [
      'empty_value' => '- None -',
    ] + parent::defaultSettings();
  }

  /**
   * {@inheritdoc}
   */
  public function settingsForm(array $form, FormStateInterface $form_state) {
    $element['empty_value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Empty Value'),
      '#default_value' => $this
        ->getSetting('empty_value'),
      '#description' => $this
        ->t('Text that will be shown in the no selection field. Defaults to "- None -".'),
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  public function formElement(FieldItemListInterface $items, $delta, array $element, array &$form, FormStateInterface $form_state) {
    $element = parent::formElement($items, $delta, $element, $form, $form_state);
    $options = $this
      ->getOptions($items
      ->getEntity());
    $selected = $this
      ->getSelectedOptions($items, $delta);
    if ($this
      ->getFieldSettings()['handler'] == 'views') {
      $view = $this->viewFactory
        ->get($this->viewLoader
        ->load($this
        ->getFieldSettings()['handler_settings']['view']['view_name']));
      $view
        ->setArguments($this
        ->getFieldSettings()['handler_settings']['view']['arguments']);
      $view
        ->execute($this
        ->getFieldSettings()['handler_settings']['view']['display_name']);
      $filter_options = [];
      foreach ($view->result as $row) {
        $row_output = $view->style_plugin->view->rowPlugin
          ->render($row);
        $filter_options[$row->_entity
          ->id()] = $this->renderer
          ->render($row_output);
      }
      $options = $filter_options;

      // Add an empty option if the widget needs one.
      if ($empty_label = $this
        ->getEmptyLabel()) {
        $options = [
          '_none' => $empty_label,
        ] + $options;
      }
    }
    $element += [
      '#type' => 'select',
      '#options' => $options,
      '#default_value' => $selected,
      // Do not display a 'multiple' select box if there is only one option.
      '#multiple' => $this->multiple && count($this->options) > 1,
    ];
    return $element;
  }

  /**
   * {@inheritdoc}
   */
  protected function sanitizeLabel(&$label) {

    // Select form inputs allow unencoded HTML entities, but no HTML tags.
    $label = Html::decodeEntities(strip_tags($label));
  }

  /**
   * {@inheritdoc}
   */
  protected function supportsGroups() {
    return TRUE;
  }

  /**
   * {@inheritdoc}
   */
  protected function getEmptyLabel() {
    if ($this->multiple) {

      // Multiple select: add a 'none' option for non-required fields.
      if (!$this->required) {
        return $this
          ->getSetting('empty_value') ?? $this
          ->t('- None -');
      }
    }
    else {

      // Single select: add a 'none' option for non-required fields,
      // and a 'select a value' option for required fields that do not come
      // with a value selected.
      if (!$this->required) {
        return $this
          ->getSetting('empty_value') ?? $this
          ->t('- None -');
      }
      if (!$this->has_value) {
        return $this
          ->getSetting('empty_value') ?? $this
          ->t('- Select a value -');
      }
    }
  }

}

Classes

Name	Description
EntityReferenceViewsOptionsSelectWidget	Plugin implementation of the 'erviews_options_select' widget.