DefaultPluginManager.php 9.8 KB
Newer Older
1 2 3 4 5
<?php

namespace Drupal\Core\Plugin;

use Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface;
6 7
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Cache\UseCacheBackendTrait;
8
use Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait;
9
use Drupal\Core\Plugin\Discovery\ContainerDerivativeDiscoveryDecorator;
10 11 12
use Drupal\Component\Plugin\PluginManagerBase;
use Drupal\Component\Plugin\PluginManagerInterface;
use Drupal\Component\Utility\NestedArray;
13
use Drupal\Core\Cache\Cache;
14 15 16 17 18 19
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\Discovery\AnnotatedClassDiscovery;
use Drupal\Core\Plugin\Factory\ContainerFactory;

/**
 * Base class for plugin managers.
20 21
 *
 * @ingroup plugin_api
22 23 24
 */
class DefaultPluginManager extends PluginManagerBase implements PluginManagerInterface, CachedDiscoveryInterface {

25
  use DiscoveryCachedTrait;
26
  use UseCacheBackendTrait;
27 28

  /**
29
   * The cache key.
30 31 32 33 34
   *
   * @var string
   */
  protected $cacheKey;

35 36 37 38 39
  /**
   * An array of cache tags to use for the cached definitions.
   *
   * @var array
   */
40
  protected $cacheTags = [];
41

42 43 44 45 46 47 48 49
  /**
   * Name of the alter hook if one should be invoked.
   *
   * @var string
   */
  protected $alterHook;

  /**
50 51
   * The subdirectory within a namespace to look for plugins, or FALSE if the
   * plugins are in the top level of the namespace.
52
   *
53
   * @var string|bool
54 55 56 57 58 59 60 61 62 63
   */
  protected $subdir;

  /**
   * The module handler to invoke the alter hook.
   *
   * @var \Drupal\Core\Extension\ModuleHandlerInterface
   */
  protected $moduleHandler;

64 65 66 67 68 69 70
  /**
   * A set of defaults to be referenced by $this->processDefinition() if
   * additional processing of plugins is necessary or helpful for development
   * purposes.
   *
   * @var array
   */
71
  protected $defaults = [];
72

73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94
  /**
   * The name of the annotation that contains the plugin definition.
   *
   * @var string
   */
  protected $pluginDefinitionAnnotationName;

  /**
   * The interface each plugin should implement.
   *
   * @var string|null
   */
  protected $pluginInterface;

  /**
   * An object that implements \Traversable which contains the root paths
   * keyed by the corresponding namespace to look for plugin implementations.
   *
   * @var \Traversable
   */
  protected $namespaces;

95 96 97 98 99 100 101 102
  /**
   * Additional namespaces the annotation discovery mechanism should scan for
   * annotation definitions.
   *
   * @var string[]
   */
  protected $additionalAnnotationNamespaces = [];

103 104 105
  /**
   * Creates the discovery object.
   *
106 107
   * @param string|bool $subdir
   *   The plugin's subdirectory, for example Plugin/views/filter.
108 109
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
110
   *   keyed by the corresponding namespace to look for plugin implementations.
111 112
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
113 114
   * @param string|null $plugin_interface
   *   (optional) The interface each plugin should implement.
115 116 117
   * @param string $plugin_definition_annotation_name
   *   (optional) The name of the annotation that contains the plugin definition.
   *   Defaults to 'Drupal\Component\Annotation\Plugin'.
118 119
   * @param string[] $additional_annotation_namespaces
   *   (optional) Additional namespaces to scan for annotation definitions.
120
   */
121
  public function __construct($subdir, \Traversable $namespaces, ModuleHandlerInterface $module_handler, $plugin_interface = NULL, $plugin_definition_annotation_name = 'Drupal\Component\Annotation\Plugin', array $additional_annotation_namespaces = []) {
122
    $this->subdir = $subdir;
123 124 125
    $this->namespaces = $namespaces;
    $this->pluginDefinitionAnnotationName = $plugin_definition_annotation_name;
    $this->pluginInterface = $plugin_interface;
126
    $this->moduleHandler = $module_handler;
127
    $this->additionalAnnotationNamespaces = $additional_annotation_namespaces;
128 129 130 131 132 133 134 135 136 137
  }

  /**
   * Initialize the cache backend.
   *
   * Plugin definitions are cached using the provided cache backend. The
   * interface language is added as a suffix to the cache key.
   *
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
138
   * @param string $cache_key
139 140
   *   Cache key prefix to use, the language code will be appended
   *   automatically.
141
   * @param array $cache_tags
142 143 144 145 146 147 148
   *   (optional) When providing a list of cache tags, the cached plugin
   *   definitions are tagged with the provided cache tags. These cache tags can
   *   then be used to clear the corresponding cached plugin definitions. Note
   *   that this should be used with care! For clearing all cached plugin
   *   definitions of a plugin manager, call that plugin manager's
   *   clearCachedDefinitions() method. Only use cache tags when cached plugin
   *   definitions should be cleared along with other, related cache entries.
149
   */
150
  public function setCacheBackend(CacheBackendInterface $cache_backend, $cache_key, array $cache_tags = array()) {
151
    assert('\Drupal\Component\Assertion\Inspector::assertAllStrings($cache_tags)', 'Cache Tags must be strings.');
152
    $this->cacheBackend = $cache_backend;
153
    $this->cacheKey = $cache_key;
154
    $this->cacheTags = $cache_tags;
155 156 157 158 159 160
  }

  /**
   * Initializes the alter hook.
   *
   * @param string $alter_hook
161 162
   *   Name of the alter hook; for example, to invoke
   *   hook_mymodule_data_alter() pass in "mymodule_data".
163
   */
164
  protected function alterInfo($alter_hook) {
165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    $this->alterHook = $alter_hook;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {
    $definitions = $this->getCachedDefinitions();
    if (!isset($definitions)) {
      $definitions = $this->findDefinitions();
      $this->setCachedDefinitions($definitions);
    }
    return $definitions;
  }

  /**
   * {@inheritdoc}
   */
  public function clearCachedDefinitions() {
    if ($this->cacheBackend) {
185 186
      if ($this->cacheTags) {
        // Use the cache tags to clear the cache.
187
        Cache::invalidateTags($this->cacheTags);
188
      }
189 190 191
      else {
        $this->cacheBackend->delete($this->cacheKey);
      }
192 193 194 195 196 197 198
    }
    $this->definitions = NULL;
  }

  /**
   * Returns the cached plugin definitions of the decorated discovery class.
   *
199
   * @return array|null
200 201 202 203 204 205
   *   On success this will return an array of plugin definitions. On failure
   *   this should return NULL, indicating to other methods that this has not
   *   yet been defined. Success with no values should return as an empty array
   *   and would actually be returned by the getDefinitions() method.
   */
  protected function getCachedDefinitions() {
206
    if (!isset($this->definitions) && $cache = $this->cacheGet($this->cacheKey)) {
207 208 209 210 211 212 213 214 215 216 217 218
      $this->definitions = $cache->data;
    }
    return $this->definitions;
  }

  /**
   * Sets a cache of plugin definitions for the decorated discovery class.
   *
   * @param array $definitions
   *   List of definitions to store in cache.
   */
  protected function setCachedDefinitions($definitions) {
219
    $this->cacheSet($this->cacheKey, $definitions, Cache::PERMANENT, $this->cacheTags);
220 221 222
    $this->definitions = $definitions;
  }

223 224 225 226 227 228 229 230 231 232
  /**
   * {@inheritdoc}
   */
  public function useCaches($use_caches = FALSE) {
    $this->useCaches = $use_caches;
    if (!$use_caches) {
      $this->definitions = NULL;
    }
  }

233 234 235 236 237 238 239 240 241 242 243 244 245
  /**
   * Performs extra processing on plugin definitions.
   *
   * By default we add defaults for the type to the definition. If a type has
   * additional processing logic they can do that by replacing or extending the
   * method.
   */
  public function processDefinition(&$definition, $plugin_id) {
    if (!empty($this->defaults) && is_array($this->defaults)) {
      $definition = NestedArray::mergeDeep($this->defaults, $definition);
    }
  }

246 247 248 249 250
  /**
   * {@inheritdoc}
   */
  protected function getDiscovery() {
    if (!$this->discovery) {
251
      $discovery = new AnnotatedClassDiscovery($this->subdir, $this->namespaces, $this->pluginDefinitionAnnotationName, $this->additionalAnnotationNamespaces);
252 253 254 255 256 257 258 259 260 261 262 263 264 265 266
      $this->discovery = new ContainerDerivativeDiscoveryDecorator($discovery);
    }
    return $this->discovery;
  }

  /**
   * {@inheritdoc}
   */
  protected function getFactory() {
    if (!$this->factory) {
      $this->factory = new ContainerFactory($this, $this->pluginInterface);
    }
    return $this->factory;
  }

267 268 269 270 271 272 273
  /**
   * Finds plugin definitions.
   *
   * @return array
   *   List of definitions to store in cache.
   */
  protected function findDefinitions() {
274
    $definitions = $this->getDiscovery()->getDefinitions();
275 276 277
    foreach ($definitions as $plugin_id => &$definition) {
      $this->processDefinition($definition, $plugin_id);
    }
278
    $this->alterDefinitions($definitions);
279 280 281
    // If this plugin was provided by a module that does not exist, remove the
    // plugin definition.
    foreach ($definitions as $plugin_id => $plugin_definition) {
282 283 284 285 286
      // If the plugin definition is an object, attempt to convert it to an
      // array, if that is not possible, skip further processing.
      if (is_object($plugin_definition) && !($plugin_definition = (array) $plugin_definition)) {
        continue;
      }
287
      if (isset($plugin_definition['provider']) && !in_array($plugin_definition['provider'], array('core', 'component')) && !$this->providerExists($plugin_definition['provider'])) {
288 289 290
        unset($definitions[$plugin_id]);
      }
    }
291 292 293
    return $definitions;
  }

294 295 296 297
  /**
   * Invokes the hook to alter the definitions if the alter hook is set.
   *
   * @param $definitions
298
   *   The discovered plugin definitions.
299 300 301 302 303 304 305
   */
  protected function alterDefinitions(&$definitions) {
    if ($this->alterHook) {
      $this->moduleHandler->alter($this->alterHook, $definitions);
    }
  }

306 307 308
  /**
   * Determines if the provider of a definition exists.
   *
309
   * @return bool
310 311 312 313 314 315
   *   TRUE if provider exists, FALSE otherwise.
   */
  protected function providerExists($provider) {
    return $this->moduleHandler->moduleExists($provider);
  }

316
}