Merge pull request drupal-media#9 from slashrsm/2318503

Define basic functions on interfaces

Author: slashrsm

src/Entity/EntityBrowser.php

@@ -9,6 +9,7 @@
 
 use Drupal\Core\Config\Entity\ConfigEntityBase;
 use Drupal\Core\Entity\EntityWithPluginBagsInterface;
+use Drupal\Core\Form\FormStateInterface;
 use Drupal\Core\Plugin\DefaultPluginBag;
 use Drupal\Core\Plugin\DefaultSinglePluginBag;
 use Drupal\entity_browser\EntityBrowserInterface;
@@ -251,4 +252,61 @@ public function getWidgetSelector() {
     return $this->widgetSelectorPluginBag()->get($this->widget_selector);
   }
 
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getSelectedEntities() {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function setSelectedEntities(array $entities) {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function addSelectedEntities(array $entities) {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function selectionCompleted() {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getFormId() {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildForm(array $form, FormStateInterface $form_state) {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function validateForm(array &$form, FormStateInterface $form_state) {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitForm(array &$form, FormStateInterface $form_state) {
+    // @TODO Implement it.
+  }
+
 }

src/EntityBrowserDisplayInterface.php

@@ -22,4 +22,25 @@ interface EntityBrowserDisplayInterface extends PluginInspectionInterface {
    */
   public function label();
 
+  /**
+   * Displays entity browser.
+   *
+   * This is the "entry point" for every non-entity browser code to interact
+   * with it. It will take care about displaying entity browser in one way or
+   * another.
+   *
+   * @return array
+   *   An array suitable for drupal_render().
+   */
+  public function displayEntityBrowser();
+
+  /**
+   * Indicates completed selection.
+   *
+   * Entity browser will call this function when selection is done. Display
+   * plugin is responsible for fetching selected entities and sending them to
+   * the initiating code.
+   */
+  public function selectionCompleted();
+
 }

src/EntityBrowserInterface.php

@@ -8,11 +8,12 @@
 namespace Drupal\entity_browser;
 
 use Drupal\Core\Config\Entity\ConfigEntityInterface;
+use Drupal\Core\Form\FormInterface;
 
 /**
  * Provides an interface defining an entity browser entity.
  */
-interface EntityBrowserInterface extends ConfigEntityInterface {
+interface EntityBrowserInterface extends ConfigEntityInterface, FormInterface {
 
   /**
    * Returns the entity browser name.
@@ -97,4 +98,36 @@ public function getSelectionDisplay();
    */
   public function getWidgetSelector();
 
+  /**
+   * Returns currently selected entities.
+   *
+   * @return array
+   *   Array of currently selected entities.
+   */
+  public function getSelectedEntities();
+
+  /**
+   * Sets currently selected entities.
+   *
+   * @param array $entities
+   *   Entities that are currently selected.
+   */
+  public function setSelectedEntities(array $entities);
+
+  /**
+   * Adds entities to currently selected entities.
+   *
+   * @param array $entities
+   *   Entities to be added to the list of currently selected entities.
+   */
+  public function addSelectedEntities(array $entities);
+
+  /**
+   * Indicates completed selection.
+   *
+   * Selection process is done and currently selected entities are sent to the
+   * initiating code.
+   */
+  public function selectionCompleted();
+
 }

src/EntityBrowserSelectionDisplayInterface.php

@@ -22,4 +22,12 @@ interface EntityBrowserSelectionDisplayInterface extends PluginInspectionInterfa
    */
   public function label();
 
+  /**
+   * Returns selection display form.
+   *
+   * @return array
+   *   Form structure.
+   */
+  public function getForm();
+
 }

src/EntityBrowserWidgetInterface.php

@@ -30,4 +30,12 @@ public function label();
    */
   public function getWeight();
 
+  /**
+   * Returns widget form.
+   *
+   * @return array
+   *   Form structure.
+   */
+  public function getForm();
+
 }

src/EntityBrowserWidgetSelectorInterface.php

@@ -22,4 +22,20 @@ interface EntityBrowserWidgetSelectorInterface extends PluginInspectionInterface
    */
   public function label();
 
+  /**
+   * Returns widget selector form.
+   *
+   * @return array
+   *   Form structure.
+   */
+  public function getForm();
+
+  /**
+   * Returns ID of the widget that is currently selected.
+   *
+   * @return string
+   *   ID of the currently selected widget.
+   */
+  public function getCurrentWidget();
+
 }

src/Plugin/EntityBrowser/Display/Standalone.php

@@ -33,4 +33,19 @@ class Standalone extends PluginBase implements EntityBrowserDisplayInterface {
   public function label() {
     return $this->label;
   }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function displayEntityBrowser() {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function selectionCompleted() {
+    // @TODO Implement it.
+  }
+
 }

src/Plugin/EntityBrowser/SelectionDisplay/NoDisplay.php

@@ -34,4 +34,11 @@ public function label() {
     $this->label;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getForm() {
+    // @TODO Implement it.
+  }
+
 }

src/Plugin/EntityBrowser/Widget/View.php

@@ -48,4 +48,11 @@ public function getWeight() {
     return $this->weight;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getForm() {
+    // @TODO Implement it.
+  }
+
 }

src/Plugin/EntityBrowser/WidgetSelector/Tabs.php

@@ -33,4 +33,19 @@ class Tabs extends PluginBase implements EntityBrowserWidgetSelectorInterface {
   public function label() {
     return $this->label;
   }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getForm() {
+    // @TODO Implement it.
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCurrentWidget() {
+    // @TODO Implement it.
+  }
+
 }