ThrobberManager.php in Ajax loader 8

Namespace

Drupal\ajax_loader

File

src/ThrobberManager.php

<?php

namespace Drupal\ajax_loader;

use Drupal\Component\Plugin\Mapper\MapperInterface;
use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\Core\Plugin\DefaultPluginManager;
use Drupal\Core\Routing\AdminContext;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Gathers the throbber plugins.
 */
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;
  }

}

Classes

Name	Description
ThrobberManager	Gathers the throbber plugins.