abstract class LibraryTypeBase in Libraries API 8.3

Provides a base class for library types.

Hierarchy

• class \Drupal\libraries\ExternalLibrary\Type\LibraryTypeBase implements ContainerFactoryPluginInterface, LibraryCreationListenerInterface, LibraryTypeInterface uses IdAccessorTrait

3 files declare their use of LibraryTypeBase

AssetLibraryType.php in src/Plugin/libraries/Type/AssetLibraryType.php

MultipleAssetLibraryType.php in src/Plugin/libraries/Type/MultipleAssetLibraryType.php

PhpFileLibraryType.php in src/Plugin/libraries/Type/PhpFileLibraryType.php

File

src/ExternalLibrary/Type/LibraryTypeBase.php, line 16

Namespace

Drupal\libraries\ExternalLibrary\Type

abstract class LibraryTypeBase implements LibraryTypeInterface, LibraryCreationListenerInterface, ContainerFactoryPluginInterface {
  use IdAccessorTrait;

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

  /**
   * The version detector factory.
   *
   * @var \Drupal\Component\Plugin\Factory\FactoryInterface
   */
  protected $detectorFactory;

  /**
   * Constructs the asset library type.
   *
   * @param string $plugin_id
   *   The plugin ID taken from the class annotation.
   * @param \Drupal\Component\Plugin\Factory\FactoryInterface $locator_factory
   *   The locator factory.
   * @param \Drupal\Component\Plugin\Factory\FactoryInterface $detector_factory
   *   The version detector factory.
   */
  public function __construct($plugin_id, FactoryInterface $locator_factory, FactoryInterface $detector_factory) {
    $this->id = $plugin_id;
    $this->locatorFactory = $locator_factory;
    $this->detectorFactory = $detector_factory;
  }

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

  /**
   * {@inheritdoc}
   */
  public function onLibraryCreate(LibraryInterface $library) {
    if ($library instanceof LocalLibraryInterface) {
      $library
        ->getLocator($this->locatorFactory)
        ->locate($library);

      // Fallback on global locators.
      // @todo Consider if global locators should be checked as a fallback or as
      // the primary locator source.
      if (!$library
        ->isInstalled()) {
        $this->locatorFactory
          ->createInstance('global')
          ->locate($library);
      }

      // Also fetch version information.
      if ($library instanceof VersionedLibraryInterface) {

        // @todo Consider if this should be wrapped in some conditional logic
        // or exception handling so that version detection errors do not
        // prevent a library from being loaded.
        $library
          ->getVersionDetector($this->detectorFactory)
          ->detectVersion($library);
      }
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
IdAccessorTrait::$id	protected	property	The ID.
IdAccessorTrait::getId	public	function	Returns the ID.
LibraryTypeBase::$detectorFactory	protected	property	The version detector factory.
LibraryTypeBase::$locatorFactory	protected	property	The locator factory.
LibraryTypeBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
LibraryTypeBase::onLibraryCreate	public	function	Reacts to the instantiation of a library. Overrides LibraryCreationListenerInterface::onLibraryCreate
LibraryTypeBase::__construct	public	function	Constructs the asset library type.	1
LibraryTypeInterface::getLibraryClass	public	function	Returns the class used for libraries of this type.	3