class UriLocator in Libraries API 8.3

Provides a locator utilizing a URI.

It makes the following assumptions:

• The library files can be accessed using a specified stream.
• The stream wrapper is local (i.e. it is a subclass of \Drupal\Core\StreamWrapper\LocalStream).
• The first component of the file URIs are the library IDs (i.e. file URIs are of the form: scheme://library-id/path/to/file/filename).

Plugin annotation

@Locator("uri");

Hierarchy

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

See also

\Drupal\libraries\ExternalLibrary\Local\LocatorInterface

File

src/Plugin/libraries/Locator/UriLocator.php, line 26

Namespace

Drupal\libraries\Plugin\libraries\Locator

class UriLocator implements LocatorInterface, ContainerFactoryPluginInterface {

  /**
   * The stream wrapper manager.
   *
   * @var \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface
   */
  protected $streamWrapperManager;

  /**
   * The URI to check.
   *
   * @var string
   */
  protected $uri;

  /**
   * Constructs a URI locator.
   *
   * @param \Drupal\Core\StreamWrapper\StreamWrapperManagerInterface $stream_wrapper_manager
   *   The stream wrapper manager.
   * @param string $uri
   *   The URI to check.
   */
  public function __construct(StreamWrapperManagerInterface $stream_wrapper_manager, $uri) {
    $this->streamWrapperManager = $stream_wrapper_manager;
    $this->uri = (string) $uri;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    if (!isset($configuration['uri'])) {
      throw new MissingPluginConfigurationException($plugin_id, $plugin_definition, $configuration, 'uri');
    }
    return new static($container
      ->get('stream_wrapper_manager'), $configuration['uri']);
  }

  /**
   * 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) {

    /** @var \Drupal\Core\StreamWrapper\LocalStream $stream_wrapper */
    $stream_wrapper = $this->streamWrapperManager
      ->getViaUri($this->uri);
    assert($stream_wrapper instanceof \Drupal\Core\StreamWrapper\LocalStream);

    // Calling LocalStream::getDirectoryPath() explicitly avoids the realpath()
    // usage in LocalStream::getLocalPath(), which breaks if Libraries API is
    // symbolically linked into the Drupal installation.
    list($scheme, $target) = explode('://', $this->uri, 2);
    $base_path = str_replace('//', '/', $stream_wrapper
      ->getDirectoryPath() . '/' . $target . '/' . $library
      ->getId());
    if (is_dir($base_path) && is_readable($base_path)) {
      $library
        ->setLocalPath($base_path);
      return;
    }
    $library
      ->setUninstalled();
  }

}

Members

Name	Modifiers	Type	Description	Overrides
UriLocator::$streamWrapperManager	protected	property	The stream wrapper manager.
UriLocator::$uri	protected	property	The URI to check.
UriLocator::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
UriLocator::locate	public	function	Locates a library. Overrides LocatorInterface::locate
UriLocator::__construct	public	function	Constructs a URI locator.