You are here

Home » API reference » Extra Field 8.2 » ExtraFieldManagerBase.php

abstract class ExtraFieldManagerBase in Extra Field 8.2

Base class for Extra Field plugin managers.

@package Drupal\extra_field\Plugin

Hierarchy

Expanded class hierarchy of ExtraFieldManagerBase

File

src/Plugin/ExtraFieldManagerBase.php, line 12

Namespace

Drupal\extra_field\Plugin
View source 
abstract class ExtraFieldManagerBase extends DefaultPluginManager implements ExtraFieldManagerBaseInterface {

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

  /**
   * {@inheritdoc}
   */
  public abstract function fieldInfo();

  /**
   * Clear the service's local cache.
   *
   * TODO Add this to the interface in the 3.0.0 release.
   */
  public function clearCache() {
    $this->entityBundles = [];
  }

  /**
   * 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, '.') === FALSE) {
        continue;
      }
      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
        ->getEntityBundleType($entityType);
      if ($bundleType) {
        $bundles = $this
          ->getEntityBundles($bundleType);
      }
      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}";
  }

  /**
   * Returns the name of the entity type which provides bundles.
   *
   * @param string $entityType
   *   The entity type to get the data of.
   *
   * @return string|null
   *   The entity type or null if the entity does not provide bundles.
   */
  protected function getEntityBundleType($entityType) {
    return $this
      ->getEntityTypeManager()
      ->getDefinition($entityType)
      ->getBundleEntityType();
  }

  /**
   * Returns all bundles of an entity type.
   *
   * @param string $entityType
   *   The entity type to get the data of.
   *
   * @return array
   *   Array of bundle names.
   */
  protected function getEntityBundles($entityType) {
    return $this
      ->getEntityTypeManager()
      ->getStorage($entityType)
      ->getQuery()
      ->execute();
  }

  /**
   * Returns the entity type manager.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity type manager service.
   */
  protected abstract function getEntityTypeManager();

}

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
DefaultPluginManager::__construct public function Creates the discovery object. 47
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
ExtraFieldManagerBase::$entityBundles protected property Caches bundles per entity type.
ExtraFieldManagerBase::allEntityBundles protected function Returns the bundles that are defined for an entity type.
ExtraFieldManagerBase::clearCache public function Clear the service's local cache.
ExtraFieldManagerBase::entityBundleKey protected function Creates a key string with entity type and bundle.
ExtraFieldManagerBase::fieldInfo abstract public function Exposes the ExtraField plugins to hook_entity_extra_field_info(). Overrides ExtraFieldManagerBaseInterface::fieldInfo 2
ExtraFieldManagerBase::fieldName protected function Build the field name string.
ExtraFieldManagerBase::getEntityBundles protected function Returns all bundles of an entity type.
ExtraFieldManagerBase::getEntityBundleType protected function Returns the name of the entity type which provides bundles.
ExtraFieldManagerBase::getEntityTypeManager abstract protected function Returns the entity type manager. 2
ExtraFieldManagerBase::matchEntityBundleKey protected function Checks if the plugin bundle definition matches the entity bundle key.
ExtraFieldManagerBase::supportedEntityBundles protected function Returns entity-bundle combinations this plugin supports.
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.