class SandwichPluginManager

Same name in other branches
  1. 3.x modules/plugin_type_example/src/SandwichPluginManager.php \Drupal\plugin_type_example\SandwichPluginManager

A plugin manager for sandwich plugins.

The SandwichPluginManager class extends the DefaultPluginManager to provide a way to manage sandwich plugins. A plugin manager defines a new plugin type and how instances of any plugin of that type will be discovered, instantiated and more.

Using the DefaultPluginManager as a starting point sets up our sandwich plugin type to use annotated discovery.

The plugin manager is also declared as a service in plugin_type_example.services.yml so that it can be easily accessed and used anytime we need to work with sandwich plugins.

Hierarchy

Expanded class hierarchy of SandwichPluginManager

1 file declares its use of SandwichPluginManager
PluginTypeExampleController.php in modules/plugin_type_example/src/Controller/PluginTypeExampleController.php
1 string reference to 'SandwichPluginManager'
plugin_type_example.services.yml in modules/plugin_type_example/plugin_type_example.services.yml
modules/plugin_type_example/plugin_type_example.services.yml
1 service uses SandwichPluginManager
plugin.manager.sandwich in modules/plugin_type_example/plugin_type_example.services.yml
Drupal\plugin_type_example\SandwichPluginManager

File

modules/plugin_type_example/src/SandwichPluginManager.php, line 25

Namespace

Drupal\plugin_type_example
View source
class SandwichPluginManager extends DefaultPluginManager {
    
    /**
     * Creates the discovery 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) {
        // We replace the $subdir parameter with our own value.
        // This tells the plugin manager to look for Sandwich plugins in the
        // 'src/Plugin/Sandwich' subdirectory of any enabled modules. This also
        // serves to define the PSR-4 subnamespace in which sandwich plugins will
        // live. Modules can put a plugin class in their own namespace such as
        // Drupal\{module_name}\Plugin\Sandwich\MySandwichPlugin.
        $subdir = 'Plugin/Sandwich';
        // The name of the interface that plugins should adhere to. Drupal will
        // enforce this as a requirement. If a plugin does not implement this
        // interface, Drupal will throw an error.
        $plugin_interface = SandwichInterface::class;
        // The name of the annotation class that contains the plugin definition.
        $plugin_definition_annotation_name = Sandwich::class;
        parent::__construct($subdir, $namespaces, $module_handler, $plugin_interface, $plugin_definition_annotation_name);
        // This allows the plugin definitions to be altered by an alter hook. The
        // parameter defines the name of the hook, thus: hook_sandwich_info_alter().
        // In this example, we implement this hook to change the plugin definitions:
        // see plugin_type_example_sandwich_info_alter().
        $this->alterInfo('sandwich_info');
        // This sets the caching method for our plugin definitions. Plugin
        // definitions are discovered by examining the $subdir defined above, for
        // any classes with an $plugin_definition_annotation_name. The annotations
        // are read, and then the resulting data is cached using the provided cache
        // backend. For our Sandwich plugin type, we've specified the @cache.default
        // service be used in the plugin_type_example.services.yml file. The second
        // argument is a cache key prefix. Out of the box Drupal with the default
        // cache backend setup will store our plugin definition in the cache_default
        // table using the sandwich_info key. All that is implementation details
        // however, all we care about it that caching for our plugin definition is
        // taken care of by this call.
        $this->setCacheBackend($cache_backend, 'sandwich_info', [
            'sandwich_info',
        ]);
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional annotation namespaces.
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(). 12
DefaultPluginManager::$moduleExtensionList protected property The module extension list.
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object of root paths that are traversable.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginDefinitionAttributeName protected property The name of the attribute 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.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 5
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 11
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
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 16
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 14
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 5
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 15
PluginManagerBase::getFallbackPluginId protected function Gets a fallback id for a missing plugin. 6
PluginManagerBase::getInstance public function 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
SandwichPluginManager::__construct public function Creates the discovery 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.
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.