You are here

Home » API reference » Social Media Links Block and Field 8.2 » SocialMediaLinksIconsetManager.php

class SocialMediaLinksIconsetManager in Social Media Links Block and Field 8.2

Manager class for the iconset plugins.

Hierarchy

Expanded class hierarchy of SocialMediaLinksIconsetManager

1 file declares its use of SocialMediaLinksIconsetManager
SocialMediaLinksBlock.php in src/Plugin/Block/SocialMediaLinksBlock.php
1 string reference to 'SocialMediaLinksIconsetManager'
social_media_links.services.yml in ./social_media_links.services.yml
social_media_links.services.yml
1 service uses SocialMediaLinksIconsetManager
plugin.manager.social_media_links.iconset in ./social_media_links.services.yml
Drupal\social_media_links\SocialMediaLinksIconsetManager

File

src/SocialMediaLinksIconsetManager.php, line 12

Namespace

Drupal\social_media_links
View source 
class SocialMediaLinksIconsetManager extends DefaultPluginManager {

  /**
   * Constructs an SocialMediaLinksPlatformManager 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/SocialMediaLinks/Iconset', $namespaces, $module_handler, 'Drupal\\social_media_links\\IconsetInterface', 'Drupal\\social_media_links\\Annotation\\Iconset');
    $this
      ->alterInfo('social_media_links_iconset_info');
    $this
      ->setCacheBackend($cache_backend, 'social_media_links_iconsets');
  }

  /**
   * Get all iconset plugins.
   *
   * @return array
   *   The iconset plugins.
   */
  public function getIconsets() {
    $plugins = $this
      ->getDefinitions();
    foreach ($plugins as $plugin_id => $plugin) {
      $instance = $this
        ->createInstance($plugin_id);
      if ($instance instanceof IconsetInterface) {

        // Attach the class instance to the plugin definitions.
        $plugins[$plugin_id]['instance'] = $instance;
      }
      else {
        $plugins[$plugin_id] = [];
      }
    }
    return $plugins;
  }

  /**
   * Return a array with the available styles for each (available) iconset.
   *
   * @return array
   *   The array with the styles.
   */
  public function getStyles() {
    $options = [];
    foreach ($this
      ->getIconsets() as $iconset_id => $iconset) {

      // Only display options for iconsets that are installed and available.
      if ($iconset['instance']
        ->getPath()) {
        $styles = $iconset['instance']
          ->getStyle();
        foreach ($styles as $key => $style) {
          $options[$iconset_id][$iconset_id . ':' . $key] = $style;
        }
      }
      else {
        $options[$iconset_id] = [];
      }
    }
    return $options;
  }

}

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
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
SocialMediaLinksIconsetManager::getIconsets public function Get all iconset plugins.
SocialMediaLinksIconsetManager::getStyles public function Return a array with the available styles for each (available) iconset.
SocialMediaLinksIconsetManager::__construct public function Constructs an SocialMediaLinksPlatformManager 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. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.