class FileDefinitionDiscovery in Libraries API 8.3

Provides a libraries definition discovery using PHP's native file functions.

It supports either a URI with a stream wrapper, an absolute file path or a file path relative to the Drupal root as a base URI.

By default YAML files are used.

Hierarchy

• class \Drupal\libraries\ExternalLibrary\Definition\FileDefinitionDiscoveryBase implements DefinitionDiscoveryInterface
  • class \Drupal\libraries\ExternalLibrary\Definition\FileDefinitionDiscovery implements DefinitionDiscoveryInterface

See also

\Drupal\libraries\StreamWrapper\LibraryDefinitionsStream

Related topics

External libraries

External libraries are not shipped as part of contributed modules for licensing and maintenance reasons. The Libraries API module aims to solve the problem of integrating with and loading external libraries as part of the Drupal request-response…

1 file declares its use of FileDefinitionDiscovery

libraries.install in ./libraries.install

Containsinstall, uninstall and update functions for Libraries API.

File

src/ExternalLibrary/Definition/FileDefinitionDiscovery.php, line 20

Namespace

Drupal\libraries\ExternalLibrary\Definition

class FileDefinitionDiscovery extends FileDefinitionDiscoveryBase implements DefinitionDiscoveryInterface {

  /**
   * {@inheritdoc}
   */
  public function hasDefinition($id) {
    return file_exists($this
      ->getFileUri($id));
  }

  /**
   * {@inheritdoc}
   */
  protected function getSerializedDefinition($id) {
    return file_get_contents($this
      ->getFileUri($id));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FileDefinitionDiscovery::getSerializedDefinition	protected	function	Gets the contents of the library file. Overrides FileDefinitionDiscoveryBase::getSerializedDefinition
FileDefinitionDiscovery::hasDefinition	public	function	Checks whether a library definition exists. Overrides DefinitionDiscoveryInterface::hasDefinition
FileDefinitionDiscoveryBase::$baseUri	protected	property	The base URI for the library files.
FileDefinitionDiscoveryBase::$serializer	protected	property	The serializer for the library definition files.
FileDefinitionDiscoveryBase::getDefinition	public	function	Gets a library definition by its ID. Overrides DefinitionDiscoveryInterface::getDefinition
FileDefinitionDiscoveryBase::getFileUri	protected	function	Returns the file URI of the library definition file for a given library ID.
FileDefinitionDiscoveryBase::__construct	public	function	Constructs a stream-based library definition discovery.	1