Added an interface for EntityEmbedDisplayManager.

Author: davereid

src/EntityEmbedDisplay/EntityEmbedDisplayManager.php

@@ -19,7 +19,7 @@
  * @see \Drupal\entity_embed\Annotation\EntityEmbedDisplay
  * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface
  */
-class EntityEmbedDisplayManager extends DefaultPluginManager {
+class EntityEmbedDisplayManager extends DefaultPluginManager implements EntityEmbedDisplayManagerInterface {
 
   /**
    * Constructs a new class instance.
@@ -52,16 +52,7 @@ public function processDefinition(&$definition, $plugin_id) {
   }
 
   /**
-   * Determines plugins whose constraints are satisfied by a set of contexts.
-   *
-   * @param array $contexts
-   *   An array of contexts.
-   *
-   * @return array
-   *   An array of plugin definitions.
-   *
-   * @todo At some point convert this to use ContextAwarePluginManagerTrait
-   * @see https://drupal.org/node/2277981
+   * @{inheritdoc}
    */
   public function getDefinitionsForContexts(array $contexts = array()) {
     $definitions = $this->getDefinitions();
@@ -83,13 +74,7 @@ public function getDefinitionsForContexts(array $contexts = array()) {
   }
 
   /**
-   * Provides a list of plugins that can be used for a certain entity.
-   *
-   * @param \Drupal\Core\Entity\EntityInterface $entity
-   *   An entity object.
-   *
-   * @return array
-   *   An array of valid plugin labels, keyed by plugin ID.
+   * @{inheritdoc}
    */
   public function getDefinitionOptionsForEntity(EntityInterface $entity) {
     $definitions = $this->getDefinitionsForContexts(array('entity' => $entity));
@@ -99,13 +84,7 @@ public function getDefinitionOptionsForEntity(EntityInterface $entity) {
   }
 
   /**
-   * Provides a list of plugins that can be used for a certain entity type.
-   *
-   * @param string $entity_type
-   *   The entity type id.
-   *
-   * @return array
-   *   An array of valid plugin labels, keyed by plugin ID.
+   * @{inheritdoc}
    */
   public function getDefinitionOptionsForEntityType($entity_type) {
     $definitions = $this->getDefinitionsForContexts(array('entity_type' => $entity_type));

src/EntityEmbedDisplay/EntityEmbedDisplayManagerInterface.php

@@ -0,0 +1,64 @@
+<?php
+
+/**
+ * @file
+ * Contains \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface.
+ */
+
+namespace Drupal\entity_embed\EntityEmbedDisplay;
+
+use Drupal\Component\Plugin\PluginManagerInterface;
+use Drupal\Core\Entity\EntityInterface;
+
+/**
+ * Provides an Entity embed display plugin manager.
+ *
+ * @see \Drupal\entity_embed\Annotation\EntityEmbedDisplay
+ * @see \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface
+ */
+interface EntityEmbedDisplayManagerInterface extends PluginManagerInterface {
+
+  /**
+   * The default display plugin.
+   *
+   * @var string
+   */
+  const DEFAULT_PLUGIN_ID = 'entity_reference:entity_reference_entity_view';
+
+  /**
+   * Determines plugins whose constraints are satisfied by a set of contexts.
+   *
+   * @param array $contexts
+   *   An array of contexts.
+   *
+   * @return array
+   *   An array of plugin definitions.
+   *
+   * @todo At some point convert this to use ContextAwarePluginManagerTrait
+   * @see https://drupal.org/node/2277981
+   */
+  public function getDefinitionsForContexts(array $contexts = array());
+
+  /**
+   * Provides a list of plugins that can be used for a certain entity.
+   *
+   * @param \Drupal\Core\Entity\EntityInterface $entity
+   *   An entity object.
+   *
+   * @return array
+   *   An array of valid plugin labels, keyed by plugin ID.
+   */
+  public function getDefinitionOptionsForEntity(EntityInterface $entity);
+
+  /**
+   * Provides a list of plugins that can be used for a certain entity type.
+   *
+   * @param string $entity_type
+   *   The entity type id.
+   *
+   * @return array
+   *   An array of valid plugin labels, keyed by plugin ID.
+   */
+  public function getDefinitionOptionsForEntityType($entity_type);
+
+}

src/EntityHelperTrait.php

@@ -12,7 +12,7 @@
 use Drupal\Core\Entity\EntityStorageException;
 use Drupal\Core\Extension\ModuleHandlerInterface;
 use Drupal\Core\Render\RendererInterface;
-use Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager;
+use Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface;
 
 /**
  * Wrapper methods for entity loading and rendering.
@@ -41,7 +41,7 @@ trait EntityHelperTrait {
   /**
    * The display plugin manager.
    *
-   * @var \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager.
+   * @var \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface.
    */
   protected $displayPluginManager;
 
@@ -287,7 +287,7 @@ public function setModuleHandler(ModuleHandlerInterface $module_handler) {
   /**
    * Returns the display plugin manager.
    *
-   * @return \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager
+   * @return \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface
    *   The display plugin manager.
    */
   protected function displayPluginManager() {
@@ -300,12 +300,12 @@ protected function displayPluginManager() {
   /**
    * Sets the display plugin manager service.
    *
-   * @param \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager $display_plugin_manager
+   * @param \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface $display_plugin_manager
    *   The display plugin manager service.
    *
    * @return self
    */
-  public function setDisplayPluginManager(EntityEmbedDisplayManager $display_plugin_manager) {
+  public function setDisplayPluginManager(EntityEmbedDisplayManagerInterface $display_plugin_manager) {
     $this->displayPluginManager = $display_plugin_manager;
     return $this;
   }

src/Form/EntityEmbedDialog.php

@@ -17,7 +17,7 @@
 use Drupal\editor\Ajax\EditorDialogSave;
 use Drupal\editor\EditorInterface;
 use Drupal\embed\EmbedButtonInterface;
-use Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager;
+use Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface;
 use Drupal\entity_embed\EntityHelperTrait;
 use Drupal\Component\Serialization\Json;
 use Symfony\Component\DependencyInjection\ContainerInterface;
@@ -38,12 +38,12 @@ class EntityEmbedDialog extends FormBase {
   /**
    * Constructs a EntityEmbedDialog object.
    *
-   * @param \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager $plugin_manager
-   *   The Module Handler.
+   * @param \Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManagerInterface $plugin_manager
+   *   The display plugin manager.
    * @param \Drupal\Core\Form\FormBuilderInterface $form_builder
-   *   The Form Builder.
+   *   The form builder.
    */
-  public function __construct(EntityEmbedDisplayManager $plugin_manager, FormBuilderInterface $form_builder) {
+  public function __construct(EntityEmbedDisplayManagerInterface $plugin_manager, FormBuilderInterface $form_builder) {
     $this->setDisplayPluginManager($plugin_manager);
     $this->formBuilder = $form_builder;
   }