Version 1

[yaffs-website] / web / modules / contrib / entity_browser / src / SelectionDisplayInterface.php

diff --git a/web/modules/contrib/entity_browser/src/SelectionDisplayInterface.php b/web/modules/contrib/entity_browser/src/SelectionDisplayInterface.php
new file mode 100644 (file)
index 0000000..84e1564
--- /dev/null
+++ b/web/modules/contrib/entity_browser/src/SelectionDisplayInterface.php
@@ -0,0 +1,80 @@
+<?php
+
+namespace Drupal\entity_browser;
+
+use Drupal\Component\Plugin\ConfigurablePluginInterface;
+use Drupal\Component\Plugin\PluginInspectionInterface;
+use Drupal\Core\Form\FormStateInterface;
+use Drupal\Core\Plugin\PluginFormInterface;
+
+/**
+ * Defines the interface for entity browser selection displays.
+ *
+ * This plugin type is responsible for displaying the currently selected
+ * entities in an entity browser and delivering them upstream. The selections
+ * are displayed in a form which delivers the selected entities on submit.
+ */
+interface SelectionDisplayInterface extends PluginInspectionInterface, ConfigurablePluginInterface, PluginFormInterface {
+
+  /**
+   * Returns the selection display label.
+   *
+   * @return string
+   *   The selection display label.
+   */
+  public function label();
+
+  /**
+   * Returns selection display form.
+   *
+   * @param array $original_form
+   *   Entire form built up to this point. Form elements for selection display
+   *   should generally not be added directly to it but returned from function
+   *   as a separated unit.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   Form state object.
+   *
+   * @return array
+   *   Form structure.
+   */
+  public function getForm(array &$original_form, FormStateInterface $form_state);
+
+  /**
+   * Validates form.
+   *
+   * @param array $form
+   *   Form.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   Form state object.
+   */
+  public function validate(array &$form, FormStateInterface $form_state);
+
+  /**
+   * Submits form.
+   *
+   * @param array $form
+   *   Form.
+   * @param \Drupal\Core\Form\FormStateInterface $form_state
+   *   Form state object.
+   */
+  public function submit(array &$form, FormStateInterface $form_state);
+
+  /**
+   * Check does selection display support preselection.
+   *
+   * If preselection is not allowed by entity browser selection display, then
+   * exception will be thrown.
+   *
+   * @throws \Drupal\Core\Config\ConfigException
+   */
+  public function checkPreselectionSupport();
+
+  /**
+   * Returns true if selection display supports selection over javascript.
+   *
+   * @return bool
+   *   True if javascript add/remove events are supported.
+   */
+  public function supportsJsCommands();
+
+}