class ExtraFieldDisplayManager in Extra Field 8

Same name and namespace in other branches

8.2 src/Plugin/ExtraFieldDisplayManager.php \Drupal\extra_field\Plugin\ExtraFieldDisplayManager

Manages Extra Field plugins.

@package Drupal\extra_field\Plugin

Hierarchy

class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
  - class \Drupal\extra_field\Plugin\ExtraFieldDisplayManager implements ExtraFieldDisplayManagerInterface

Expanded class hierarchy of ExtraFieldDisplayManager

1 string reference to 'ExtraFieldDisplayManager'

extra_field.services.yml in ./extra_field.services.yml: extra_field.services.yml

1 service uses ExtraFieldDisplayManager

plugin.manager.extra_field_display in ./extra_field.services.yml: Drupal\extra_field\Plugin\ExtraFieldDisplayManager

File

src/Plugin/ExtraFieldDisplayManager.php, line 17

Namespace

Drupal\extra_field\Plugin

View source

class ExtraFieldDisplayManager extends DefaultPluginManager implements ExtraFieldDisplayManagerInterface {

  /**
   * Caches bundles per entity type.
   *
   * @var array
   */
  protected $entityBundles;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructor for ExtraFieldDisplayManager objects.
   *
   * @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.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct('Plugin/ExtraField/Display', $namespaces, $module_handler, 'Drupal\\extra_field\\Plugin\\ExtraFieldDisplayInterface', 'Drupal\\extra_field\\Annotation\\ExtraFieldDisplay');
    $this
      ->alterInfo('extra_field_display_info');
    $this
      ->setCacheBackend($cache_backend, 'extra_field_display_plugins');
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public function fieldInfo() {
    $info = [];
    $definitions = $this
      ->getDefinitions();
    foreach ($definitions as $key => $definition) {
      $entityBundles = $this
        ->supportedEntityBundles($definition['bundles']);
      foreach ($entityBundles as $entityBundle) {
        $entityType = $entityBundle['entity'];
        $bundle = $entityBundle['bundle'];
        $fieldName = $this
          ->fieldName($key);
        $info[$entityType][$bundle]['display'][$fieldName] = [
          'label' => $definition['label'],
          'weight' => $definition['weight'],
          'visible' => $definition['visible'],
        ];
      }
    }
    return $info;
  }

  /**
   * {@inheritdoc}
   */
  public function entityView(array &$build, ContentEntityInterface $entity, EntityViewDisplayInterface $display, $viewMode) {
    $definitions = $this
      ->getDefinitions();
    $entityBundleKey = $this
      ->entityBundleKey($entity
      ->getEntityTypeId(), $entity
      ->bundle());
    foreach ($definitions as $pluginId => $definition) {
      if ($this
        ->matchEntityBundleKey($definition['bundles'], $entityBundleKey)) {
        $factory = $this
          ->getFactory();
        if ($display
          ->getComponent($this
          ->fieldName($pluginId))) {

          /** @var ExtraFieldDisplayInterface $plugin */
          $plugin = $factory
            ->createInstance($pluginId);
          $fieldName = $this
            ->fieldName($pluginId);
          $plugin
            ->setEntity($entity);
          $plugin
            ->setEntityViewDisplay($display);
          $plugin
            ->setViewMode($viewMode);
          $elements = $plugin
            ->view($entity);
          if (!empty($elements)) {
            $build[$fieldName] = $elements;
          }
        }
      }
    }
  }

  /**
   * Checks if the plugin bundle definition matches the entity bundle key.
   *
   * @param string[] $pluginBundles
   *   Defines which entity-bundle pair the plugin can be used for.
   *   Format: [entity type].[bundle] or [entity type].* .
   * @param string $entityBundleKey
   *   The entity-bundle string of a content entity.
   *   Format: [entity type].[bundle] .
   *
   * @return bool
   *   True of the plugin bundle definition matches the entity bundle key.
   */
  protected function matchEntityBundleKey(array $pluginBundles, $entityBundleKey) {
    $match = FALSE;
    foreach ($pluginBundles as $pluginBundle) {
      if (strpos($pluginBundle, '.*')) {
        $match = explode('.', $pluginBundle)[0] == explode('.', $entityBundleKey)[0];
      }
      else {
        $match = $pluginBundle == $entityBundleKey;
      }
      if ($match) {
        break;
      }
    }
    return $match;
  }

  /**
   * Returns entity-bundle combinations this plugin supports.
   *
   * If a wildcard bundle is set, all bundles of the entity will be included.
   *
   * @param string[] $entityBundleKeys
   *   Array of entity-bundle strings that define the bundles for which the
   *   plugin can be used. Format: [entity].[bundle]
   *   '*' can be used as bundle wildcard.
   *
   * @return array
   *   Array of entity and bundle names. Keyed by the [entity].[bundle] key.
   */
  protected function supportedEntityBundles(array $entityBundleKeys) {
    $result = [];
    foreach ($entityBundleKeys as $entityBundleKey) {
      if (strpos($entityBundleKey, '.')) {
        list($entityType, $bundle) = explode('.', $entityBundleKey);
        if ($bundle == '*') {
          foreach ($this
            ->allEntityBundles($entityType) as $bundle) {
            $key = $this
              ->entityBundleKey($entityType, $bundle);
            $result[$key] = [
              'entity' => $entityType,
              'bundle' => $bundle,
            ];
          }
        }
        else {
          $result[$entityBundleKey] = [
            'entity' => $entityType,
            'bundle' => $bundle,
          ];
        }
      }
    }
    return $result;
  }

  /**
   * Returns the bundles that are defined for an entity type.
   *
   * @param string $entityType
   *   The entity type to get the bundles for.
   *
   * @return string[]
   *   Array of bundle names.
   */
  protected function allEntityBundles($entityType) {
    if (!isset($this->entityBundles[$entityType])) {
      $bundleType = $this->entityTypeManager
        ->getDefinition($entityType)
        ->getBundleEntityType();
      if ($bundleType) {
        $bundles = $this->entityTypeManager
          ->getStorage($bundleType)
          ->getQuery()
          ->execute();
      }
      else {
        $bundles = [
          $entityType => $entityType,
        ];
      }
      $this->entityBundles[$entityType] = $bundles;
    }
    return $this->entityBundles[$entityType];
  }

  /**
   * Build the field name string.
   *
   * @param string $pluginId
   *   The machine name of the Extra Field plugin.
   *
   * @return string
   *   Field name.
   */
  protected function fieldName($pluginId) {
    return 'extra_field_' . $pluginId;
  }

  /**
   * Creates a key string with entity type and bundle.
   *
   * @param string $entityType
   *   The entity type.
   * @param string $bundle
   *   The bundle.
   *
   * @return string
   *   Formatted string.
   */
  protected function entityBundleKey($entityType, $bundle) {
    return "{$entityType}.{$bundle}";
  }

}

Members

Name	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
ExtraFieldDisplayManager::$entityBundles	protected	property	Caches bundles per entity type.
ExtraFieldDisplayManager::$entityTypeManager	protected	property	The entity type manager.
ExtraFieldDisplayManager::allEntityBundles	protected	function	Returns the bundles that are defined for an entity type.
ExtraFieldDisplayManager::entityBundleKey	protected	function	Creates a key string with entity type and bundle.
ExtraFieldDisplayManager::entityView	public	function	Appends the renderable data from ExtraField plugins to hook_entity_view(). Overrides ExtraFieldDisplayManagerInterface::entityView
ExtraFieldDisplayManager::fieldInfo	public	function	Exposes the ExtraFieldDisplay plugins to hook_entity_extra_field_info(). Overrides ExtraFieldDisplayManagerInterface::fieldInfo
ExtraFieldDisplayManager::fieldName	protected	function	Build the field name string.
ExtraFieldDisplayManager::matchEntityBundleKey	protected	function	Checks if the plugin bundle definition matches the entity bundle key.
ExtraFieldDisplayManager::supportedEntityBundles	protected	function	Returns entity-bundle combinations this plugin supports.
ExtraFieldDisplayManager::__construct	public	function	Constructor for ExtraFieldDisplayManager objects. 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::createInstance	public	function	Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance	12
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.

You are here

class ExtraFieldDisplayManager in Extra Field 8

Hierarchy

File

Namespace

Members

API Navigation