You are here

Home » API reference » Breadcrumb Manager 8 » BreadcrumbTitleResolverManager.php

class BreadcrumbTitleResolverManager in Breadcrumb Manager 8

Provides the Breadcrumb title resolver plugin manager.

Hierarchy

Expanded class hierarchy of BreadcrumbTitleResolverManager

2 files declare their use of BreadcrumbTitleResolverManager
BreadcrumbManagerBuilder.php in src/Breadcrumb/BreadcrumbManagerBuilder.php
BreadcrumbManagerConfigForm.php in src/Form/BreadcrumbManagerConfigForm.php
1 string reference to 'BreadcrumbTitleResolverManager'
breadcrumb_manager.services.yml in ./breadcrumb_manager.services.yml
breadcrumb_manager.services.yml
1 service uses BreadcrumbTitleResolverManager
plugin.manager.breadcrumb_title_resolver in ./breadcrumb_manager.services.yml
Drupal\breadcrumb_manager\Plugin\BreadcrumbTitleResolverManager

File

src/Plugin/BreadcrumbTitleResolverManager.php, line 14

Namespace

Drupal\breadcrumb_manager\Plugin
View source 
class BreadcrumbTitleResolverManager extends DefaultPluginManager {
  protected $config;

  /**
   * Constructs a new BreadcrumbTitleResolverManager 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 service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
    parent::__construct('Plugin/BreadcrumbTitleResolver', $namespaces, $module_handler, 'Drupal\\breadcrumb_manager\\Plugin\\BreadcrumbTitleResolverInterface', 'Drupal\\breadcrumb_manager\\Annotation\\BreadcrumbTitleResolver');
    $this->config = $config_factory
      ->get('breadcrumb_manager.config');
    $this
      ->alterInfo('breadcrumb_manager_breadcrumb_title_resolver_info');
    $this
      ->setCacheBackend($cache_backend, 'breadcrumb_manager_breadcrumb_title_resolver_plugins');
  }

  /**
   * Get instances.
   *
   * @return \Drupal\breadcrumb_manager\Plugin\BreadcrumbTitleResolverInterface[]
   *   An array of breadcrumb title resolvers.
   */
  public function getInstances() {
    $instances = [];
    foreach ($this
      ->getDefinitions() as $pluginId => $definition) {
      try {
        $instance = $this
          ->createInstance($pluginId);
        $instance
          ->setActive($definition['enabled']);
        $instances[] = $instance;
      } catch (PluginException $e) {
        \Drupal::messenger()
          ->addError($e
          ->getMessage());
      }
    }
    return $instances;
  }

  /**
   * {@inheritdoc}
   */
  public function getDefinitions() {
    $definitions = parent::getDefinitions();
    $resolvers = $this->config
      ->get('title_resolvers');
    foreach ($definitions as $id => $definition) {
      if (isset($resolvers[$id]['weight'])) {
        $definitions[$id]['weight'] = $resolvers[$id]['weight'];
      }
      if (isset($resolvers[$id]['enabled'])) {
        $definitions[$id]['enabled'] = $resolvers[$id]['enabled'];
      }
    }
    uasort($definitions, [
      $this,
      'sortByWeight',
    ]);
    return $definitions;
  }

  /**
   * Sort by weight.
   *
   * @param array $a
   *   The first plugin definition.
   * @param array $b
   *   The second plugin definition.
   *
   * @return int
   *   The sorting order.
   */
  public function sortByWeight(array $a, array $b) {
    if ($a['weight'] == $b['weight']) {
      return 0;
    }
    return $a['weight'] < $b['weight'] ? -1 : 1;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BreadcrumbTitleResolverManager::$config protected property
BreadcrumbTitleResolverManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DefaultPluginManager::getDefinitions
BreadcrumbTitleResolverManager::getInstances public function Get instances.
BreadcrumbTitleResolverManager::sortByWeight public function Sort by weight.
BreadcrumbTitleResolverManager::__construct public function Constructs a new BreadcrumbTitleResolverManager object. Overrides DefaultPluginManager::__construct
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::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
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.