You are here

Home » API reference » Ajax loader 8 » ThrobberManager.php

class ThrobberManager in Ajax loader 8

Gathers the throbber plugins.

Hierarchy

Expanded class hierarchy of ThrobberManager

1 string reference to 'ThrobberManager'
ajax_loader.services.yml in ./ajax_loader.services.yml
ajax_loader.services.yml
1 service uses ThrobberManager
ajax_loader.throbber_manager in ./ajax_loader.services.yml
Drupal\ajax_loader\ThrobberManager

File

src/ThrobberManager.php, line 16

Namespace

Drupal\ajax_loader
View source 
class ThrobberManager extends DefaultPluginManager implements ThrobberManagerInterface, MapperInterface {
  protected $adminContext;
  protected $request;
  protected $configFactory;

  /**
   * {@inheritdoc}
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, AdminContext $admin_context, RequestStack $request_stack, ConfigFactoryInterface $config_factory) {
    parent::__construct('Plugin/ajax_loader', $namespaces, $module_handler, 'Drupal\\ajax_loader\\ThrobberPluginInterface', 'Drupal\\ajax_loader\\Annotation\\Throbber');
    $this->adminContext = $admin_context;
    $this->configFactory = $config_factory;
    $this->request = $request_stack
      ->getCurrentRequest();
  }

  /**
   * {@inheritdoc}
   */
  public function getThrobberOptionList() {
    $options = [];
    foreach ($this
      ->getDefinitions() as $definition) {
      $options[$definition['id']] = $definition['label'];
    }
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function loadThrobberInstance($plugin_id) {
    return $this
      ->createInstance($plugin_id);
  }

  /**
   * {@inheritdoc}
   */
  public function loadAllThrobberInstances() {
    $throbbers = [];
    foreach ($this
      ->getDefinitions() as $definition) {
      array_push($throbbers, $this
        ->createInstance($definition['id']));
    }
    return $throbbers;
  }

  /**
   * Function to check if Route is Applicable.
   *
   * @{inheritdoc}
   * @codingStandardsIgnoreStart
   */
  public function RouteIsApplicable() {

    // @codingStandardsIgnoreEnd
    $is_applicable = FALSE;
    $settings = $this->configFactory
      ->get('ajax_loader.settings');
    $is_admin_route = $this->adminContext
      ->isAdminRoute();
    $current_route_name = $this->request->attributes
      ->get('_route');
    if (!$is_admin_route) {

      // Always applicable.
      $is_applicable = TRUE;
    }
    elseif ($settings
      ->get('show_admin_paths') && $current_route_name != 'ajax_loader.settings') {
      $is_applicable = TRUE;
    }
    return $is_applicable;
  }

}

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
ThrobberManager::$adminContext protected property
ThrobberManager::$configFactory protected property
ThrobberManager::$request protected property
ThrobberManager::getThrobberOptionList public function Get an options list suitable for form elements for throbber selection. Overrides ThrobberManagerInterface::getThrobberOptionList
ThrobberManager::loadAllThrobberInstances public function Loads all available throbbers. Overrides ThrobberManagerInterface::loadAllThrobberInstances
ThrobberManager::loadThrobberInstance public function Loads an instance of a plugin by given plugin id. Overrides ThrobberManagerInterface::loadThrobberInstance
ThrobberManager::RouteIsApplicable public function Function to check if Route is Applicable. Overrides ThrobberManagerInterface::RouteIsApplicable
ThrobberManager::__construct public function Creates the discovery 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.