You are here

Home » API reference » Layout Builder Restrictions 8.2 » LayoutBuilderRestrictionManager.php

class LayoutBuilderRestrictionManager in Layout Builder Restrictions 8.2

Provides the Layout builder restriction plugin plugin manager.

Hierarchy

Expanded class hierarchy of LayoutBuilderRestrictionManager

1 file declares its use of LayoutBuilderRestrictionManager
RestrictionPluginConfigForm.php in src/Form/RestrictionPluginConfigForm.php
1 string reference to 'LayoutBuilderRestrictionManager'
layout_builder_restrictions.services.yml in ./layout_builder_restrictions.services.yml
layout_builder_restrictions.services.yml
1 service uses LayoutBuilderRestrictionManager
plugin.manager.layout_builder_restriction in ./layout_builder_restrictions.services.yml
Drupal\layout_builder_restrictions\Plugin\LayoutBuilderRestrictionManager

File

src/Plugin/LayoutBuilderRestrictionManager.php, line 13

Namespace

Drupal\layout_builder_restrictions\Plugin
View source 
class LayoutBuilderRestrictionManager extends DefaultPluginManager {

  /**
   * The config factory.
   *
   * Subclasses should use the self::config() method, which may be overridden to
   * address specific needs when loading config, rather than this property
   * directly. See \Drupal\Core\Form\ConfigFormBase::config() for an example of
   * this.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a new LayoutBuilderRestrictionManager 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\Config\ConfigFactoryInterface $config_factory
   *   The config factory to load plugin configuration.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
    parent::__construct('Plugin/LayoutBuilderRestriction', $namespaces, $module_handler, 'Drupal\\layout_builder_restrictions\\Plugin\\LayoutBuilderRestrictionInterface', 'Drupal\\layout_builder_restrictions\\Annotation\\LayoutBuilderRestriction');
    $this->configFactory = $config_factory;
    $this
      ->alterInfo('layout_builder_restrictions_layout_builder_restriction_info');
    $this
      ->setCacheBackend($cache_backend, 'layout_builder_restriction_plugins');
  }

  /**
   * Helper function to get all restriction plugins.
   *
   * Will get configuration for all plugins, regardless of being enabled or not,
   * sorted by weight.
   * For *only* enabled plugins, use getSortedEnabledPlugins().
   *
   * @param bool $get_disabled
   *   Pass TRUE if the plugin data should also include plugins that
   *   are disabled.
   *
   * @return array
   *   Returns the plugin information, with 'weight' and 'enabled' information.
   *   The array is sorted by the configured weight.
   */
  public function getSortedPlugins(bool $get_disabled = FALSE) {
    $plugin_config = $this->configFactory
      ->get('layout_builder_restrictions.plugins')
      ->get('plugin_config');

    // Build a list of plugins, using saved weight & enabled status if defined.
    $plugin_list = [];
    foreach ($this
      ->getDefinitions() as $restriction_definition) {
      $id = $restriction_definition['id'];

      // Handle plugins that are in existing config.
      if ($plugin_config && !empty($plugin_config[$id])) {
        $config = $plugin_config[$id];
        if ($config['enabled'] == FALSE && $get_disabled) {
          $plugin_list[$id] = [
            'weight' => (int) $config['weight'],
            'enabled' => (bool) $config['enabled'],
            'title' => $restriction_definition['title'],
            'description' => $restriction_definition['description'],
          ];
        }
        elseif ($config['enabled'] == TRUE) {
          $plugin_list[$id] = [
            'weight' => (int) $config['weight'],
            'enabled' => (bool) $config['enabled'],
            'title' => $restriction_definition['title'],
            'description' => $restriction_definition['description'],
          ];
        }
      }
      else {

        // Plugin not in existing config, default to enabled & default weight.
        $plugin_list[$id] = [
          'weight' => 1,
          'enabled' => TRUE,
          'title' => $restriction_definition['title'],
          'description' => $restriction_definition['description'],
        ];
      }
    }

    // Sort the plugin list by weight.
    uasort($plugin_list, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $plugin_list;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
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() if additional processing of plugins is necessary or helpful for development purposes. 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
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, or FALSE if the plugins are in the top level of the namespace.
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 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
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 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 13
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
LayoutBuilderRestrictionManager::$configFactory protected property The config factory.
LayoutBuilderRestrictionManager::getSortedPlugins public function Helper function to get all restriction plugins.
LayoutBuilderRestrictionManager::__construct public function Constructs a new LayoutBuilderRestrictionManager object. 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 Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
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. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.