You are here

Home » API reference » Entity Embed 8 » EntityEmbedDisplayManager.php

class EntityEmbedDisplayManager in Entity Embed 8

Provides an Entity Embed display plugin manager.

Hierarchy

Expanded class hierarchy of EntityEmbedDisplayManager

See also

\Drupal\entity_embed\Annotation\EntityEmbedDisplay

\Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayBase

\Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayInterface

Plugin API

3 files declare their use of EntityEmbedDisplayManager
Entity.php in src/Plugin/EmbedType/Entity.php
EntityEmbedBuilder.php in src/EntityEmbedBuilder.php
EntityEmbedDialog.php in src/Form/EntityEmbedDialog.php
1 string reference to 'EntityEmbedDisplayManager'
entity_embed.services.yml in ./entity_embed.services.yml
entity_embed.services.yml
1 service uses EntityEmbedDisplayManager
plugin.manager.entity_embed.display in ./entity_embed.services.yml
Drupal\entity_embed\EntityEmbedDisplay\EntityEmbedDisplayManager

File

src/EntityEmbedDisplay/EntityEmbedDisplayManager.php, line 20

Namespace

Drupal\entity_embed\EntityEmbedDisplay
View source 
class EntityEmbedDisplayManager extends DefaultPluginManager {

  /**
   * Constructs a new EntityEmbedDisplayManager.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/entity_embed/EntityEmbedDisplay', $namespaces, $module_handler, 'Drupal\\entity_embed\\EntityEmbedDisplay\\EntityEmbedDisplayInterface', 'Drupal\\entity_embed\\Annotation\\EntityEmbedDisplay');
    $this
      ->alterInfo('entity_embed_display_plugins');

    // @todo Move the cache tag to the derivers once https://www.drupal.org/node/3001284 lands.
    $this
      ->setCacheBackend($cache_backend, 'entity_embed_display_plugins', [
      'config:entity_view_mode_list',
    ]);
  }

  /**
   * 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 = []) {
    $definitions = $this
      ->getDefinitions();
    if (!empty($contexts['embed_button'])) {
      $button_plugins = $contexts['embed_button']
        ->getTypeSetting('display_plugins');
      if (!empty($button_plugins)) {
        $allowed_definitions = [];
        foreach ($button_plugins as $plugin_id) {
          if (!empty($definitions[$plugin_id])) {
            $allowed_definitions[$plugin_id] = $definitions[$plugin_id];
          }
        }
        $definitions = $allowed_definitions;
      }
    }
    $valid_ids = array_filter(array_keys($definitions), function ($id) use ($contexts) {
      try {
        $display = $this
          ->createInstance($id);
        foreach ($contexts as $name => $value) {
          $display
            ->setContextValue($name, $value);
        }

        // We lose cacheability metadata at this point. We should refactor to
        // avoid this. @see https://www.drupal.org/node/2593379#comment-11368447
        return $display
          ->access()
          ->isAllowed();
      } catch (PluginException $e) {
        return FALSE;
      }
    });
    $definitions_for_context = array_intersect_key($definitions, array_flip($valid_ids));
    $this->moduleHandler
      ->alter('entity_embed_display_plugins_for_context', $definitions_for_context, $contexts);
    return $definitions_for_context;
  }

  /**
   * Gets definition options for context.
   *
   * Provides a list of plugins that can be used for a certain context and
   * filters out plugins that should be hidden in the UI.
   *
   * @param array $context
   *   An array of context options; possible keys are 'entity', 'entity_type'
   *   and 'embed_button'.
   *
   * @return string[]
   *   An array of valid plugin labels, keyed by plugin ID.
   */
  public function getDefinitionOptionsForContext(array $context) {
    $values = [
      'entity' => TRUE,
      'entity_type' => TRUE,
      'embed_button' => TRUE,
    ];
    assert(empty(array_diff_key($context, $values)));
    $definitions = $this
      ->getDefinitionsForContexts($context);
    $definitions = $this
      ->filterExposedDefinitions($definitions);
    $options = array_map(function ($definition) {
      return (string) $definition['label'];
    }, $definitions);
    natsort($options);
    return $options;
  }

  /**
   * Gets definition options for entity.
   *
   * Provides a list of plugins that can be used for a certain entity and
   * filters out plugins that should be hidden in the UI.
   *
   * @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) {
    $definitions = $this
      ->getDefinitionsForContexts([
      'entity' => $entity,
      'entity_type' => $entity
        ->getEntityTypeId(),
    ]);
    $definitions = $this
      ->filterExposedDefinitions($definitions);
    return array_map(function ($definition) {
      return (string) $definition['label'];
    }, $definitions);
  }

  /**
   * Filters out plugins from definitions that should be hidden in the UI.
   *
   * @param array $definitions
   *   The array of plugin definitions.
   *
   * @return array
   *   Returns plugin definitions that should be displayed in the UI.
   */
  protected function filterExposedDefinitions(array $definitions) {
    return array_filter($definitions, function ($definition) {
      return empty($definition['no_ui']);
    });
  }

  /**
   * Gets definition options for entity type.
   *
   * Provides a list of plugins that can be used for a certain entity type and
   * filters out plugins that should be hidden in the UI.
   *
   * @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) {
    $definitions = $this
      ->getDefinitionsForContexts([
      'entity_type' => $entity_type,
    ]);
    $definitions = $this
      ->filterExposedDefinitions($definitions);
    return array_map(function ($definition) {
      return (string) $definition['label'];
    }, $definitions);
  }

  /**
   * {@inheritdoc}
   */
  public function createInstance($plugin_id, array $configuration = []) {
    $instance = parent::createInstance($plugin_id, $configuration);
    $definition = $instance
      ->getPluginDefinition();
    if (empty($definition['supports_image_alt_and_title'])) {
      return $instance;
    }
    else {

      // Use decorator pattern to add alt and title fields to dialog when
      // embedding media with image source.
      return new MediaImageDecorator($instance);
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 13
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
EntityEmbedDisplayManager::createInstance public function Creates a pre-configured instance of a plugin. Overrides PluginManagerBase::createInstance
EntityEmbedDisplayManager::filterExposedDefinitions protected function Filters out plugins from definitions that should be hidden in the UI.
EntityEmbedDisplayManager::getDefinitionOptionsForContext public function Gets definition options for context.
EntityEmbedDisplayManager::getDefinitionOptionsForEntity public function Gets definition options for entity.
EntityEmbedDisplayManager::getDefinitionOptionsForEntityType public function Gets definition options for entity type.
EntityEmbedDisplayManager::getDefinitionsForContexts public function Determines plugins whose constraints are satisfied by a set of contexts.
EntityEmbedDisplayManager::__construct public function Constructs a new EntityEmbedDisplayManager. Overrides DefaultPluginManager::__construct
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.