function SandwichPluginManager::__construct
Same name in other branches
- 3.x modules/plugin_type_example/src/SandwichPluginManager.php \Drupal\plugin_type_example\SandwichPluginManager::__construct()
- 8.x-1.x plugin_type_example/src/SandwichPluginManager.php \Drupal\plugin_type_example\SandwichPluginManager::__construct()
Creates the discovery object.
Parameters
\Traversable $namespaces: An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
\Drupal\Core\Cache\CacheBackendInterface $cache_backend: Cache backend instance to use.
\Drupal\Core\Extension\ModuleHandlerInterface $module_handler: The module handler to invoke the alter hook with.
Overrides DefaultPluginManager::__construct
File
-
modules/
plugin_type_example/ src/ SandwichPluginManager.php, line 38
Class
- SandwichPluginManager
- A plugin manager for sandwich plugins.
Namespace
Drupal\plugin_type_exampleCode
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 namespace 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. 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 is that caching for
// our plugin definition is taken care of by this call.
$this->setCacheBackend($cache_backend, 'sandwich_info', [
'sandwich_info',
]);
}