You are here

Home » API reference » GraphQL 8.3 » TypePluginManager.php

class TypePluginManager in GraphQL 8.3

Hierarchy

Expanded class hierarchy of TypePluginManager

12 files declare their use of TypePluginManager
DateTimeIso8601.php in modules/graphql_core/src/Plugin/GraphQL/Scalars/TypedData/DateTimeIso8601.php
DurationIso8601.php in modules/graphql_core/src/Plugin/GraphQL/Scalars/TypedData/DurationIso8601.php
Email.php in modules/graphql_core/src/Plugin/GraphQL/Scalars/TypedData/Email.php
EnumPluginBase.php in src/Plugin/GraphQL/Enums/EnumPluginBase.php
FilterFormat.php in modules/graphql_core/src/Plugin/GraphQL/Scalars/TypedData/FilterFormat.php

... See full list

1 string reference to 'TypePluginManager'
graphql.services.yml in ./graphql.services.yml
graphql.services.yml
6 services use TypePluginManager
plugin.manager.graphql.enum in ./graphql.services.yml
Drupal\graphql\Plugin\TypePluginManager
plugin.manager.graphql.input in ./graphql.services.yml
Drupal\graphql\Plugin\TypePluginManager
plugin.manager.graphql.interface in ./graphql.services.yml
Drupal\graphql\Plugin\TypePluginManager
plugin.manager.graphql.scalar in ./graphql.services.yml
Drupal\graphql\Plugin\TypePluginManager
plugin.manager.graphql.type in ./graphql.services.yml
Drupal\graphql\Plugin\TypePluginManager

... See full list

File

src/Plugin/TypePluginManager.php, line 10

Namespace

Drupal\graphql\Plugin
View source 
class TypePluginManager extends DefaultPluginManager implements TypePluginManagerInterface {

  /**
   * Static cache of plugin instances.
   *
   * @var \Drupal\graphql\Plugin\TypePluginInterface[]
   */
  protected $instances;

  /**
   * TypePluginManager constructor.
   *
   * @param bool|string $pluginSubdirectory
   *   The plugin's subdirectory.
   * @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\Extension\ModuleHandlerInterface $moduleHandler
   *   The module handler.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cacheBackend
   *   The cache backend.
   * @param string|null $pluginInterface
   *   The interface each plugin should implement.
   * @param string $pluginAnnotationName
   *   The name of the annotation that contains the plugin definition.
   * @param string $pluginType
   *   The plugin type.
   * @param array $config
   *   The configuration service parameter.
   */
  public function __construct($pluginSubdirectory, \Traversable $namespaces, ModuleHandlerInterface $moduleHandler, CacheBackendInterface $cacheBackend, $pluginInterface, $pluginAnnotationName, $pluginType, array $config) {
    parent::__construct($pluginSubdirectory, $namespaces, $moduleHandler, $pluginInterface, $pluginAnnotationName);
    $this
      ->alterInfo("graphql_{$pluginType}");
    $this
      ->useCaches(empty($config['development']));
    $this
      ->setCacheBackend($cacheBackend, $pluginType, [
      'graphql',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getInstance(array $options) {
    if (!isset($this->instances[$options['id']])) {
      $this->instances[$options['id']] = $this
        ->createInstance($options['id']);
    }
    return $this->instances[$options['id']];
  }

  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    parent::clearCachedDefinitions();
    $this->instances = [];
  }

  /**
   * {@inheritdoc}
   */
  protected function setCachedDefinitions($definitions) {
    $this->definitions = $definitions;
    $this
      ->cacheSet($this->cacheKey, $definitions, $this
      ->getCacheMaxAge(), $this
      ->getCacheTags());
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    $definitions = $this
      ->getDefinitions();
    return array_reduce($definitions, function ($carry, $current) {
      if (!empty($current['schema_cache_tags'])) {
        return Cache::mergeTags($carry, $current['schema_cache_tags']);
      }
      return $carry;
    }, $this->cacheTags);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheMaxAge() {
    $definitions = $this
      ->getDefinitions();
    $age = Cache::PERMANENT;
    foreach ($definitions as $definition) {
      if (!isset($definition['schema_cache_max_age'])) {
        continue;
      }

      // Bail out early if the cache max age is 0.
      if (($age = Cache::mergeMaxAges($age, $definition['schema_cache_max_age'])) === 0) {
        return $age;
      }
    }
    return $age;
  }

}

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::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::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::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
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::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
TypePluginManager::$instances protected property Static cache of plugin instances.
TypePluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides DefaultPluginManager::clearCachedDefinitions
TypePluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides DefaultPluginManager::getCacheMaxAge
TypePluginManager::getCacheTags public function The cache tags associated with this object. Overrides DefaultPluginManager::getCacheTags
TypePluginManager::getInstance public function Gets a preconfigured instance of a plugin. Overrides PluginManagerBase::getInstance
TypePluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class. Overrides DefaultPluginManager::setCachedDefinitions
TypePluginManager::__construct public function TypePluginManager constructor. Overrides DefaultPluginManager::__construct
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.