class DevelGeneratePluginManager

Same name in other branches
  1. 5.x devel_generate/src/DevelGeneratePluginManager.php \Drupal\devel_generate\DevelGeneratePluginManager

Plugin type manager for DevelGenerate plugins.

Hierarchy

Expanded class hierarchy of DevelGeneratePluginManager

2 files declare their use of DevelGeneratePluginManager
DevelGenerateCommands.php in devel_generate/src/Commands/DevelGenerateCommands.php
DevelGenerateManagerTest.php in devel_generate/tests/src/Unit/DevelGenerateManagerTest.php
1 string reference to 'DevelGeneratePluginManager'
devel_generate.services.yml in devel_generate/devel_generate.services.yml
devel_generate/devel_generate.services.yml
1 service uses DevelGeneratePluginManager
plugin.manager.develgenerate in devel_generate/devel_generate.services.yml
Drupal\devel_generate\DevelGeneratePluginManager

File

devel_generate/src/DevelGeneratePluginManager.php, line 12

Namespace

Drupal\devel_generate
View source
class DevelGeneratePluginManager extends DefaultPluginManager {
    
    /**
     * Constructs a DevelGeneratePluginManager 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/DevelGenerate', $namespaces, $module_handler, NULL, 'Drupal\\devel_generate\\Annotation\\DevelGenerate');
        $this->alterInfo('devel_generate_info');
        $this->setCacheBackend($cache_backend, 'devel_generate_plugins');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function findDefinitions() {
        $definitions = [];
        foreach (parent::findDefinitions() as $plugin_id => $plugin_definition) {
            $plugin_available = TRUE;
            foreach ($plugin_definition['dependencies'] as $module_name) {
                // If a plugin defines module dependencies and at least one module is
                // not installed don't make this plugin available.
                if (!$this->moduleHandler
                    ->moduleExists($module_name)) {
                    $plugin_available = FALSE;
                    break;
                }
            }
            if ($plugin_available) {
                $definitions[$plugin_id] = $plugin_definition;
            }
        }
        return $definitions;
    }

}

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(). 9
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::$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. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 6
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
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 13
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. 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
DevelGeneratePluginManager::findDefinitions protected function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
DevelGeneratePluginManager::__construct public function Constructs a DevelGeneratePluginManager object. Overrides DefaultPluginManager::__construct
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::getInstance public function 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
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.