You are here

Home » API reference » Bootstrap Styles 1.0.x » StylesGroupManager.php

class StylesGroupManager in Bootstrap Styles 1.0.x

Provides an StylesGroup plugin manager.

Hierarchy

Expanded class hierarchy of StylesGroupManager

2 files declare their use of StylesGroupManager
SettingsForm.php in src/Form/SettingsForm.php
StylesFilterConfigForm.php in src/Form/StylesFilterConfigForm.php
1 string reference to 'StylesGroupManager'
bootstrap_styles.services.yml in ./bootstrap_styles.services.yml
bootstrap_styles.services.yml
1 service uses StylesGroupManager
plugin.manager.bootstrap_styles_group in ./bootstrap_styles.services.yml
Drupal\bootstrap_styles\StylesGroup\StylesGroupManager

File

src/StylesGroup/StylesGroupManager.php, line 15

Namespace

Drupal\bootstrap_styles\StylesGroup
View source 
class StylesGroupManager extends DefaultPluginManager {

  /**
   * The style plugin manager interface.
   *
   * @var \Drupal\bootstrap_styles\Style\StylePluginManagerInterface
   */
  protected $styleManager;

  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * Constructs a StylesGroupManager 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\bootstrap_styles\Style\StylePluginManagerInterface $style_manager
   *   The style plugin manager interface.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   Config factory service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, StylePluginManagerInterface $style_manager, ConfigFactoryInterface $config_factory) {
    parent::__construct('Plugin/BootstrapStyles/StylesGroup', $namespaces, $module_handler, 'Drupal\\bootstrap_styles\\StylesGroup\\StylesGroupPluginInterface', 'Drupal\\bootstrap_styles\\Annotation\\StylesGroup');
    $this
      ->alterInfo('bootstrap_styles_info');
    $this
      ->setCacheBackend($cache_backend, 'bootstrap_styles_groups');
    $this->styleManager = $style_manager;
    $this->configFactory = $config_factory;
  }

  /**
   * Returns an array of styles groups.
   *
   * @return array
   *   Returns a nested array of styles keyed by styles group.
   */
  public function getStylesGroups() {
    $groups = [];
    foreach ($this
      ->getDefinitions() as $group_id => $group_definition) {
      $groups[$group_id] = $group_definition;
      $groups[$group_id]['styles'] = $this
        ->getGroupStyles($group_id);
    }
    uasort($groups, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $groups;
  }

  /**
   * Returns an array of styles.
   *
   * @return array
   *   Returns a nested array of styles plugins.
   */
  public function getStyles() {
    $styles = [];
    foreach ($this
      ->getDefinitions() as $group_id => $group_definition) {
      $styles += $this
        ->getGroupStyles($group_id);
    }
    uasort($styles, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $styles;
  }

  /**
   * Returns an array of group styles plugins.
   *
   * @param string $group_id
   *   The styles group plugin id.
   *
   * @return array
   *   Returns an array of styles definitions of specific group.
   */
  public function getGroupStyles($group_id) {
    $styles = [];
    foreach ($this->styleManager
      ->getDefinitions() as $style_id => $style_definition) {
      if ($style_definition['group_id'] == $group_id) {
        $styles[$style_id] = $style_definition;
      }
    }
    uasort($styles, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $styles;
  }

  /**
   * Helper function returns array of allowed groups with its plugins.
   *
   * @param string $filter
   *   The filter config name.
   *
   * @return array
   *   The allowed groups with its plugins.
   */
  public function getAllowedPlugins(string $filter = NULL) {
    $allowed_plugins = [];
    if ($filter) {
      $config = $this->configFactory
        ->get($filter);
      if ($config
        ->get('plugins')) {
        $allowed_plugins = [];

        // Loop through groups.
        foreach ($config
          ->get('plugins') as $group_key => $group_plugins) {

          // Loop through group plugins.
          foreach ($group_plugins as $key => $plugin) {
            if ($plugin['enabled']) {
              $allowed_plugins[$group_key][] = $key;
            }
          }
        }
      }
    }
    return $allowed_plugins;
  }

  /**
   * Build the layout builder form styles elements.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $storage
   *   The plugins storage array.
   * @param string $filter
   *   The filter config name.
   *
   * @return array
   *   The form structure.
   */
  public function buildStylesFormElements(array &$form, FormStateInterface $form_state, array $storage, string $filter = NULL) {

    // Restrict styles.
    $allowed_plugins = $this
      ->getAllowedPlugins($filter);
    foreach ($this
      ->getStylesGroups() as $group_key => $style_group) {

      // Check groups restriction.
      if (!empty($allowed_plugins) && !array_key_exists($group_key, $allowed_plugins)) {
        continue;
      }

      // Styles Group.
      if (isset($style_group['styles'])) {
        $group_instance = $this
          ->createInstance($group_key);
        $form[$group_key] = [
          '#type' => 'details',
          '#title' => $group_instance
            ->getTitleWithIcon(),
          '#open' => FALSE,
          '#tree' => TRUE,
        ];
        $form[$group_key] += $group_instance
          ->buildStyleFormElements($form[$group_key], $form_state, $storage);
        foreach ($style_group['styles'] as $style_key => $style) {

          // Check plugins restriction.
          if (!empty($allowed_plugins) && count($allowed_plugins[$group_key]) > 0 && !in_array($style_key, $allowed_plugins[$group_key])) {
            continue;
          }
          $style_instance = $this->styleManager
            ->createInstance($style_key);
          $form[$group_key] += $style_instance
            ->buildStyleFormElements($form[$group_key], $form_state, $storage);
        }
      }
    }
    return $form;
  }

  /**
   * Save styles.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $tree
   *   An array of parents.
   * @param array $storage
   *   The plugins storage array.
   * @param string $filter
   *   The filter config name.
   *
   * @return array
   *   An array of plugins with its storage values.
   */
  public function submitStylesFormElements(array &$form, FormStateInterface $form_state, array $tree = [], array $storage = [], $filter = NULL) {
    $options = [];

    // Restrict styles.
    $allowed_plugins = $this
      ->getAllowedPlugins($filter);
    foreach ($this
      ->getStylesGroups() as $group_key => $style_group) {

      // Check groups restriction.
      if (!empty($allowed_plugins) && !array_key_exists($group_key, $allowed_plugins)) {
        continue;
      }

      // Styles Group.
      if ($form_state
        ->getValue(array_merge($tree, [
        $group_key,
      ]))) {
        $group_elements = $form_state
          ->getValue(array_merge($tree, [
          $group_key,
        ]));

        // Submit group form.
        $group_instance = $this
          ->createInstance($group_key);
        $options += $group_instance
          ->submitStyleFormElements($group_elements);

        // Styles Group.
        if (isset($style_group['styles'])) {
          foreach ($style_group['styles'] as $style_key => $style) {

            // Check plugins restriction.
            if (!empty($allowed_plugins) && count($allowed_plugins[$group_key]) > 0 && !in_array($style_key, $allowed_plugins[$group_key])) {
              continue;
            }

            // Submit style form.
            $style_instance = $this->styleManager
              ->createInstance($style_key);
            $options += $style_instance
              ->submitStyleFormElements($group_elements);
          }
        }
      }
    }
    return array_merge($storage, $options);
  }

  /**
   * Build the styles for a given build.
   *
   * @param array $build
   *   The build of element.
   * @param array $plugins_storage
   *   An array of plugins with its storage.
   * @param string $theme_wrapper
   *   The theme wrapper key.
   */
  public function buildStyles(array $build, array $plugins_storage, $theme_wrapper = NULL) {

    // Build group shared storage.
    foreach ($plugins_storage as $plugin_id => $storage) {
      if (in_array($plugin_id, array_keys($this
        ->getStylesGroups()))) {
        $group_instance = $this
          ->createInstance($plugin_id);
        $build = $group_instance
          ->build($build, $plugins_storage, $theme_wrapper);
      }
    }

    // Loop through plugins storage.
    foreach ($plugins_storage as $plugin_id => $storage) {
      if (in_array($plugin_id, array_keys($this
        ->getStyles()))) {
        $style_instance = $this->styleManager
          ->createInstance($plugin_id);
        $build = $style_instance
          ->build($build, $plugins_storage, $theme_wrapper);
      }
    }
    return $build;
  }

}

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 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 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
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 6
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
StylesGroupManager::$configFactory protected property The config factory.
StylesGroupManager::$styleManager protected property The style plugin manager interface.
StylesGroupManager::buildStyles public function Build the styles for a given build.
StylesGroupManager::buildStylesFormElements public function Build the layout builder form styles elements.
StylesGroupManager::getAllowedPlugins public function Helper function returns array of allowed groups with its plugins.
StylesGroupManager::getGroupStyles public function Returns an array of group styles plugins.
StylesGroupManager::getStyles public function Returns an array of styles.
StylesGroupManager::getStylesGroups public function Returns an array of styles groups.
StylesGroupManager::submitStylesFormElements public function Save styles.
StylesGroupManager::__construct public function Constructs a StylesGroupManager 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.