class ModuleStream

Defines the read-only module:// stream wrapper for module files.

Only enabled modules are supported.

Example usage:

module:
//my_module/css/component.css

Points to the component.css file in the module my_module's css directory.

Hierarchy

• class \Drupal\Core\StreamWrapper\LocalStream implements \Drupal\Core\StreamWrapper\StreamWrapperInterface
  • class \Drupal\Core\StreamWrapper\LocalReadOnlyStream extends \Drupal\Core\StreamWrapper\LocalStream
    • class \Drupal\Core\StreamWrapper\ExtensionStreamBase extends \Drupal\Core\StreamWrapper\LocalReadOnlyStream
      • class \Drupal\Core\StreamWrapper\ModuleStream extends \Drupal\Core\StreamWrapper\ExtensionStreamBase

Expanded class hierarchy of ModuleStream

File

core/lib/Drupal/Core/StreamWrapper/ModuleStream.php, line 21

Namespace

final class ModuleStream extends ExtensionStreamBase {
  
  /**
   * {@inheritdoc}
   */
  public function getName() : TranslatableMarkup {
    return new TranslatableMarkup('Module files');
  }
  
  /**
   * {@inheritdoc}
   */
  public function getDescription() : TranslatableMarkup {
    return new TranslatableMarkup("Local files stored under a module's directory.");
  }
  
  /**
   * {@inheritdoc}
   */
  protected function getExtension(string $extension_name) : Extension {
    return \Drupal::moduleHandler()->getModule($extension_name);
  }

}

Members