class HelpSectionManager

Same name in this branch
  1. 9 core/modules/help_topics/src/HelpSectionManager.php \Drupal\help_topics\HelpSectionManager
Same name and namespace in other branches
  1. 8.9.x core/modules/help_topics/src/HelpSectionManager.php \Drupal\help_topics\HelpSectionManager
  2. 8.9.x core/modules/help/src/HelpSectionManager.php \Drupal\help\HelpSectionManager
  3. 10 core/modules/help_topics/src/HelpSectionManager.php \Drupal\help_topics\HelpSectionManager
  4. 10 core/modules/help/src/HelpSectionManager.php \Drupal\help\HelpSectionManager
  5. 11.x core/modules/help_topics/src/HelpSectionManager.php \Drupal\help_topics\HelpSectionManager
  6. 11.x core/modules/help/src/HelpSectionManager.php \Drupal\help\HelpSectionManager

Manages help page section plugins.

Hierarchy

Expanded class hierarchy of HelpSectionManager

See also

\Drupal\help\HelpSectionPluginInterface

\Drupal\help\Plugin\HelpSection\HelpSectionPluginBase

\Drupal\help\Annotation\HelpSection

hook_help_section_info_alter()

3 files declare their use of HelpSectionManager
HelpController.php in core/modules/help/src/Controller/HelpController.php
HelpSearch.php in core/modules/help_topics/src/Plugin/Search/HelpSearch.php
HelpSectionManager.php in core/modules/help_topics/src/HelpSectionManager.php
1 string reference to 'HelpSectionManager'
help.services.yml in core/modules/help/help.services.yml
core/modules/help/help.services.yml
1 service uses HelpSectionManager
plugin.manager.help_section in core/modules/help/help.services.yml
Drupal\help\HelpSectionManager

File

core/modules/help/src/HelpSectionManager.php, line 17

Namespace

Drupal\help
View on git.drupalcode.org
View source 
class HelpSectionManager extends DefaultPluginManager {
    
    /**
     * Constructs a new HelpSectionManager.
     *
     * @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 for the alter hook.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
        parent::__construct('Plugin/HelpSection', $namespaces, $module_handler, 'Drupal\\help\\HelpSectionPluginInterface', 'Drupal\\help\\Annotation\\HelpSection');
        $this->alterInfo('help_section_info');
        $this->setCacheBackend($cache_backend, 'help_section_plugins');
    }

}

Members

Title 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::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 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
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
HelpSectionManager::__construct public function Constructs a new HelpSectionManager. Overrides DefaultPluginManager::__construct
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.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.