class SectionStorageManager

Same name in other branches
  1. 9 core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php \Drupal\layout_builder\SectionStorage\SectionStorageManager
  2. 8.9.x core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php \Drupal\layout_builder\SectionStorage\SectionStorageManager
  3. 10 core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php \Drupal\layout_builder\SectionStorage\SectionStorageManager

Provides the Section Storage type plugin manager.

Note that while this class extends \Drupal\Core\Plugin\DefaultPluginManager and includes many additional public methods, only some of them are available via \Drupal\layout_builder\SectionStorage\SectionStorageManagerInterface. While internally depending on the parent class is necessary, external code should only use the methods available on that interface.

Hierarchy

Expanded class hierarchy of SectionStorageManager

1 file declares its use of SectionStorageManager
SectionStorageManagerTest.php in core/modules/layout_builder/tests/src/Unit/SectionStorageManagerTest.php
1 string reference to 'SectionStorageManager'
layout_builder.services.yml in core/modules/layout_builder/layout_builder.services.yml
core/modules/layout_builder/layout_builder.services.yml
1 service uses SectionStorageManager
plugin.manager.layout_builder.section_storage in core/modules/layout_builder/layout_builder.services.yml
Drupal\layout_builder\SectionStorage\SectionStorageManager

File

core/modules/layout_builder/src/SectionStorage/SectionStorageManager.php, line 23

Namespace

Drupal\layout_builder\SectionStorage
View source
class SectionStorageManager extends DefaultPluginManager implements SectionStorageManagerInterface {
    
    /**
     * The context handler.
     *
     * @var \Drupal\Core\Plugin\Context\ContextHandlerInterface
     */
    protected $contextHandler;
    
    /**
     * Constructs a new SectionStorageManager 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.
     * @param \Drupal\Core\Plugin\Context\ContextHandlerInterface $context_handler
     *   The context handler.
     */
    public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ContextHandlerInterface $context_handler) {
        parent::__construct('Plugin/SectionStorage', $namespaces, $module_handler, SectionStorageInterface::class, SectionStorage::class, '\\Drupal\\layout_builder\\Annotation\\SectionStorage');
        $this->contextHandler = $context_handler;
        $this->alterInfo('layout_builder_section_storage');
        $this->setCacheBackend($cache_backend, 'layout_builder_section_storage_plugins');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function findDefinitions() {
        $definitions = parent::findDefinitions();
        // Sort the definitions by their weight while preserving the original order
        // for those with matching weights.
        $weights = array_map(function (SectionStorageDefinition $definition) {
            return $definition->getWeight();
        }, $definitions);
        $ids = array_keys($definitions);
        array_multisort($weights, $ids, $definitions);
        return $definitions;
    }
    
    /**
     * {@inheritdoc}
     */
    public function load($type, array $contexts = []) {
        $plugin = $this->loadEmpty($type);
        try {
            $this->contextHandler
                ->applyContextMapping($plugin, $contexts);
        } catch (ContextException) {
            return NULL;
        }
        return $plugin;
    }
    
    /**
     * {@inheritdoc}
     */
    public function findByContext(array $contexts, RefinableCacheableDependencyInterface $cacheability) {
        $storage_types = array_keys($this->contextHandler
            ->filterPluginDefinitionsByContexts($contexts, $this->getDefinitions()));
        // Add the manager as a cacheable dependency in order to vary by changes to
        // the plugin definitions.
        $cacheability->addCacheableDependency($this);
        foreach ($storage_types as $type) {
            $plugin = $this->load($type, $contexts);
            if ($plugin && $plugin->isApplicable($cacheability)) {
                return $plugin;
            }
        }
        return NULL;
    }
    
    /**
     * {@inheritdoc}
     */
    public function loadEmpty($type) {
        return $this->createInstance($type);
    }

}

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::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 17
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 15
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 6
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
SectionStorageManager::$contextHandler protected property The context handler.
SectionStorageManager::findByContext public function
SectionStorageManager::findDefinitions protected function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
SectionStorageManager::load public function
SectionStorageManager::loadEmpty public function
SectionStorageManager::__construct public function Constructs a new SectionStorageManager 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.

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