Version 1
[yaffs-website] / web / modules / contrib / entity_browser / src / SelectionDisplayBase.php
diff --git a/web/modules/contrib/entity_browser/src/SelectionDisplayBase.php b/web/modules/contrib/entity_browser/src/SelectionDisplayBase.php
new file mode 100644 (file)
index 0000000..5df54d8
--- /dev/null
@@ -0,0 +1,158 @@
+<?php
+
+namespace Drupal\entity_browser;
+
+use Drupal\Component\Utility\NestedArray;
+use Drupal\Core\Config\ConfigException;
+use Drupal\Core\Plugin\PluginBase;
+use Drupal\Core\Entity\EntityTypeManagerInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
+use Drupal\entity_browser\Events\Events;
+use Drupal\entity_browser\Events\SelectionDoneEvent;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Component\EventDispatcher\EventDispatcherInterface;
+
+/**
+ * Base implementation for selection display plugins.
+ */
+abstract class SelectionDisplayBase extends PluginBase implements SelectionDisplayInterface, ContainerFactoryPluginInterface {
+
+  use PluginConfigurationFormTrait;
+
+  /**
+   * Plugin label.
+   *
+   * @var string
+   */
+  protected $label;
+
+  /**
+   * Event dispatcher service.
+   *
+   * @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
+   */
+  protected $eventDispatcher;
+
+  /**
+   * Entity manager service.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
+   */
+  protected $entityTypeManager;
+
+  /**
+   * Constructs widget plugin.
+   *
+   * @param array $configuration
+   *   A configuration array containing information about the plugin instance.
+   * @param string $plugin_id
+   *   The plugin_id for the plugin instance.
+   * @param mixed $plugin_definition
+   *   The plugin implementation definition.
+   * @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
+   *   Event dispatcher service.
+   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
+   *   The entity manager type service.
+   */
+  public function __construct(array $configuration, $plugin_id, $plugin_definition, EventDispatcherInterface $event_dispatcher, EntityTypeManagerInterface $entity_type_manager) {
+    parent::__construct($configuration, $plugin_id, $plugin_definition);
+    $this->eventDispatcher = $event_dispatcher;
+    $this->entityTypeManager = $entity_type_manager;
+    $this->setConfiguration($configuration);
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
+    return new static(
+      $configuration,
+      $plugin_id,
+      $plugin_definition,
+      $container->get('event_dispatcher'),
+      $container->get('entity_type.manager')
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getConfiguration() {
+    return array_diff_key(
+      $this->configuration,
+      ['entity_browser_id' => 0]
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setConfiguration(array $configuration) {
+    $this->configuration = NestedArray::mergeDeep(
+      $this->defaultConfiguration(),
+      $configuration
+    );
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function calculateDependencies() {
+    return [];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function label() {
+    $this->label;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validate(array &$form, FormStateInterface $form_state) {}
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submit(array &$form, FormStateInterface $form_state) {}
+
+  /**
+   * {@inheritdoc}
+   */
+  public function checkPreselectionSupport() {
+    if (!$this->getPluginDefinition()['acceptPreselection']) {
+      throw new ConfigException('Used entity browser selection display does not support preselection.');
+    }
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function supportsJsCommands() {
+    return $this->getPluginDefinition()['js_commands'];
+  }
+
+  /**
+   * Marks selection as done - sets value in form state and dispatches event.
+   */
+  protected function selectionDone(FormStateInterface $form_state) {
+    $form_state->set(['entity_browser', 'selection_completed'], TRUE);
+    $this->eventDispatcher->dispatch(
+      Events::DONE,
+      new SelectionDoneEvent(
+        $this->configuration['entity_browser_id'],
+        $form_state->get(['entity_browser', 'instance_uuid'])
+      ));
+  }
+
+}