class GlobalLocator in Libraries API 8.3

Provides a locator based on global configuration.

Plugin annotation

@Locator("global");

Hierarchy

• class \Drupal\libraries\Plugin\libraries\Locator\GlobalLocator implements ContainerFactoryPluginInterface, LocatorInterface

See also

\Drupal\libraries\ExternalLibrary\Local\LocatorInterface

File

src/Plugin/libraries/Locator/GlobalLocator.php, line 19

Namespace

Drupal\libraries\Plugin\libraries\Locator

class GlobalLocator implements LocatorInterface, ContainerFactoryPluginInterface {

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

  /**
   * The locator factory.
   *
   * @var \Drupal\Component\Plugin\Factory\FactoryInterface
   */
  protected $locatorFactory;

  /**
   * Constructs a global locator.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The Drupal config factory service.
   * @param \Drupal\Component\Plugin\Factory\FactoryInterface $locator_factory
   *   The locator factory.
   */
  public function __construct(ConfigFactoryInterface $config_factory, FactoryInterface $locator_factory) {
    $this->configFactory = $config_factory;
    $this->locatorFactory = $locator_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($container
      ->get('config.factory'), $container
      ->get('plugin.manager.libraries.locator'));
  }

  /**
   * Locates a library.
   *
   * @param \Drupal\libraries\ExternalLibrary\Local\LocalLibraryInterface $library
   *   The library to locate.
   *
   * @see \Drupal\libraries\ExternalLibrary\Local\LocatorInterface::locate()
   */
  public function locate(LocalLibraryInterface $library) {
    foreach ($this->configFactory
      ->get('libraries.settings')
      ->get('global_locators') as $locator) {
      $this->locatorFactory
        ->createInstance($locator['id'], $locator['configuration'])
        ->locate($library);
      if ($library
        ->isInstalled()) {
        return;
      }
    }
    $library
      ->setUninstalled();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GlobalLocator::$configFactory	protected	property	The Drupal config factory service.
GlobalLocator::$locatorFactory	protected	property	The locator factory.
GlobalLocator::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
GlobalLocator::locate	public	function	Locates a library. Overrides LocatorInterface::locate
GlobalLocator::__construct	public	function	Constructs a global locator.