class ResourcePluginManager
Same name in other branches
- 9 core/modules/rest/src/Plugin/Type/ResourcePluginManager.php \Drupal\rest\Plugin\Type\ResourcePluginManager
- 10 core/modules/rest/src/Plugin/Type/ResourcePluginManager.php \Drupal\rest\Plugin\Type\ResourcePluginManager
- 11.x core/modules/rest/src/Plugin/Type/ResourcePluginManager.php \Drupal\rest\Plugin\Type\ResourcePluginManager
Manages discovery and instantiation of resource plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
- class \Drupal\rest\Plugin\Type\ResourcePluginManager extends \Drupal\Core\Plugin\DefaultPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
Expanded class hierarchy of ResourcePluginManager
See also
\Drupal\rest\Annotation\RestResource
\Drupal\rest\Plugin\ResourceBase
\Drupal\rest\Plugin\ResourceInterface
2 files declare their use of ResourcePluginManager
- ResourceRoutes.php in core/
modules/ rest/ src/ Routing/ ResourceRoutes.php - RestPermissions.php in core/
modules/ rest/ src/ RestPermissions.php
1 string reference to 'ResourcePluginManager'
- rest.services.yml in core/
modules/ rest/ rest.services.yml - core/modules/rest/rest.services.yml
1 service uses ResourcePluginManager
- plugin.manager.rest in core/
modules/ rest/ rest.services.yml - Drupal\rest\Plugin\Type\ResourcePluginManager
File
-
core/
modules/ rest/ src/ Plugin/ Type/ ResourcePluginManager.php, line 17
Namespace
Drupal\rest\Plugin\TypeView source
class ResourcePluginManager extends DefaultPluginManager {
/**
* Constructs a new \Drupal\rest\Plugin\Type\ResourcePluginManager object.
*
* @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/rest/resource', $namespaces, $module_handler, 'Drupal\\rest\\Plugin\\ResourceInterface', 'Drupal\\rest\\Annotation\\RestResource');
$this->setCacheBackend($cache_backend, 'rest_plugins');
$this->alterInfo('rest_resource');
}
/**
* {@inheritdoc}
*
* @deprecated in Drupal 8.2.0.
* Use Drupal\rest\Plugin\Type\ResourcePluginManager::createInstance()
* instead.
*
* @see https://www.drupal.org/node/2874934
*/
public function getInstance(array $options) {
if (isset($options['id'])) {
return $this->createInstance($options['id']);
}
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | 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 | ||||
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 | 12 | |||
PluginManagerBase::handlePluginNotFound | protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 | ||
ResourcePluginManager::getInstance | Deprecated | public | function | Overrides PluginManagerBase::getInstance | ||
ResourcePluginManager::__construct | public | function | Constructs a new \Drupal\rest\Plugin\Type\ResourcePluginManager object. | 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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.