View.php in Entity Browser 8

Namespace

Drupal\entity_browser\Plugin\EntityBrowser\SelectionDisplay

File

src/Plugin/EntityBrowser/SelectionDisplay/View.php

<?php

namespace Drupal\entity_browser\Plugin\EntityBrowser\SelectionDisplay;

use Drupal\Core\Entity\EntityInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\entity_browser\SelectionDisplayBase;
use Drupal\views\Views;
use Drupal\views\Entity\View as ViewEntity;

/**
 * Displays current selection in a View.
 *
 * @EntityBrowserSelectionDisplay(
 *   id = "view",
 *   label = @Translation("View selection display"),
 *   description = @Translation("Use a pre-configured view as selection area."),
 *   acceptPreselection = TRUE,
 *   provider = "views",
 *   js_commands = FALSE
 * )
 */
class View extends SelectionDisplayBase {

  /**
   * {@inheritdoc}
   */
  public function defaultConfiguration() {
    return [
      'view' => NULL,
      'view_display' => NULL,
    ] + parent::defaultConfiguration();
  }

  /**
   * {@inheritdoc}
   */
  public function getForm(array &$original_form, FormStateInterface $form_state) {
    $form = [];

    // TODO - do we need better error handling for view and view_display
    // (in case either of those is nonexistent
    // or display not of correct type)?
    $storage =& $form_state
      ->getStorage();
    if (empty($storage['selection_display_view']) || $form_state
      ->isRebuilding()) {
      $storage['selection_display_view'] = $this->entityTypeManager
        ->getStorage('view')
        ->load($this->configuration['view'])
        ->getExecutable();
    }

    // TODO - if there are entities that are selected multiple times this
    // displays them only once. Reason for that is how SQL and Views work and
    // we probably can't do much about it.
    $selected_entities = $form_state
      ->get([
      'entity_browser',
      'selected_entities',
    ]);
    if (!empty($selected_entities)) {
      $ids = array_map(function (EntityInterface $item) {
        return $item
          ->id();
      }, $selected_entities);
      $storage['selection_display_view']
        ->setArguments([
        implode(',', $ids),
      ]);
    }
    $form['view'] = $storage['selection_display_view']
      ->executeDisplay($this->configuration['view_display']);
    $form['use_selected'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Use selection'),
      '#name' => 'use_selected',
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submit(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getTriggeringElement()['#name'] == 'use_selected') {
      $this
        ->selectionDone($form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
    $options = [];

    // Get all views displays.
    $views = Views::getAllViews();
    foreach ($views as $view_id => $view) {
      foreach ($view
        ->get('display') as $display_id => $display) {
        $options[$view_id . '.' . $display_id] = $this
          ->t('@view : @display', [
          '@view' => $view
            ->label(),
          '@display' => $display['display_title'],
        ]);
      }
    }
    $form['view'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('View : View display'),
      '#default_value' => $this->configuration['view'] . '.' . $this->configuration['view_display'],
      '#options' => $options,
      '#required' => TRUE,
      '#description' => $this
        ->t('View display to use for displaying currently selected items. Do note that to get something useful out of this display, its first contextual filter should be a filter on the primary identifier field of your entity type (e.g., Node ID, Media ID).'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
    $values = $form_state
      ->getValues();
    if (!empty($values['view'])) {
      list($view_id, $display_id) = explode('.', $values['view']);
      $this->configuration['view'] = $view_id;
      $this->configuration['view_display'] = $display_id;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    $dependencies = [];
    if ($this->configuration['view']) {
      $view = ViewEntity::load($this->configuration['view']);
      $dependencies[$view
        ->getConfigDependencyKey()] = [
        $view
          ->getConfigDependencyName(),
      ];
    }
    return $dependencies;
  }

}

Classes

Name	Description
View	Displays current selection in a View.