class DummyStreamWrapper in Drupal 10

Helper class for testing the stream wrapper registry.

Dummy stream wrapper implementation (dummy://).

Hierarchy

• class \Drupal\Core\StreamWrapper\LocalStream implements StreamWrapperInterface
  • class \Drupal\file_test\StreamWrapper\DummyStreamWrapper

1 file declares its use of DummyStreamWrapper

ImageStyleCustomStreamWrappersTest.php in core/modules/image/tests/src/Kernel/ImageStyleCustomStreamWrappersTest.php

1 string reference to 'DummyStreamWrapper'

file_test.services.yml in core/modules/file/tests/file_test/file_test.services.yml

core/modules/file/tests/file_test/file_test.services.yml

1 service uses DummyStreamWrapper

stream_wrapper.dummy in core/modules/file/tests/file_test/file_test.services.yml

Drupal\file_test\StreamWrapper\DummyStreamWrapper

File

core/modules/file/tests/file_test/src/StreamWrapper/DummyStreamWrapper.php, line 12

Namespace

Drupal\file_test\StreamWrapper

class DummyStreamWrapper extends LocalStream {

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return t('Dummy files');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return t('Dummy wrapper for testing.');
  }
  public function getDirectoryPath() {
    return \Drupal::getContainer()
      ->getParameter('site.path') . '/files';
  }

  /**
   * Override getInternalUri().
   *
   * Return a dummy path for testing.
   */
  public function getInternalUri() {
    return '/dummy/example.txt';
  }

  /**
   * Override getExternalUrl().
   *
   * Return the HTML URI of a public file.
   */
  public function getExternalUrl() {
    return '/dummy/example.txt';
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DummyStreamWrapper::getDescription	public	function	Returns the description of the stream wrapper for use in the UI. Overrides StreamWrapperInterface::getDescription
DummyStreamWrapper::getDirectoryPath	public	function	Gets the path that the wrapper is responsible for. Overrides LocalStream::getDirectoryPath
DummyStreamWrapper::getExternalUrl	public	function	Override getExternalUrl(). Overrides StreamWrapperInterface::getExternalUrl
DummyStreamWrapper::getInternalUri	public	function	Override getInternalUri().
DummyStreamWrapper::getName	public	function	Returns the name of the stream wrapper for use in the UI. Overrides StreamWrapperInterface::getName
LocalStream::$context	public	property	Stream context resource.
LocalStream::$handle	public	property	A generic resource handle.
LocalStream::$uri	protected	property	Instance URI (stream).
LocalStream::dirname	public	function
LocalStream::dir_closedir	public	function
LocalStream::dir_opendir	public	function
LocalStream::dir_readdir	public	function
LocalStream::dir_rewinddir	public	function
LocalStream::getFileSystem	private	function	Returns file system service.
LocalStream::getLocalPath	protected	function	Returns the canonical absolute path of the URI, if possible.
LocalStream::getTarget	protected	function	Returns the local writable target of the resource within the stream.
LocalStream::getType	public static	function
LocalStream::getUri	public	function
LocalStream::mkdir	public	function
LocalStream::realpath	public	function		1
LocalStream::rename	public	function
LocalStream::rmdir	public	function
LocalStream::setUri	public	function
LocalStream::stream_cast	public	function
LocalStream::stream_close	public	function
LocalStream::stream_eof	public	function
LocalStream::stream_flush	public	function
LocalStream::stream_lock	public	function
LocalStream::stream_metadata	public	function
LocalStream::stream_open	public	function
LocalStream::stream_read	public	function
LocalStream::stream_seek	public	function
LocalStream::stream_set_option	public	function	Since Windows systems do not allow it and it is not needed for most use cases anyway, this method is not supported on local files and will trigger an error and return false. If needed, custom subclasses can provide OS-specific implementations for…
LocalStream::stream_stat	public	function
LocalStream::stream_tell	public	function
LocalStream::stream_truncate	public	function
LocalStream::stream_write	public	function
LocalStream::unlink	public	function
LocalStream::url_stat	public	function
StreamWrapperInterface::ALL		constant	A filter that matches all wrappers.
StreamWrapperInterface::HIDDEN		constant	Defines the stream wrapper bit flag for a hidden file.
StreamWrapperInterface::LOCAL		constant	Refers to a local file system location.
StreamWrapperInterface::LOCAL_HIDDEN		constant	Hidden, readable and writable using local files.
StreamWrapperInterface::LOCAL_NORMAL		constant	Visible, readable and writable using local files.
StreamWrapperInterface::NORMAL		constant	This is the default 'type' flag. This does not include StreamWrapperInterface::LOCAL, because PHP grants a greater trust level to local files (for example, they can be used in an "include" statement, regardless of the…
StreamWrapperInterface::READ		constant	Wrapper is readable (almost always true).
StreamWrapperInterface::READ_VISIBLE		constant	Visible and read-only.
StreamWrapperInterface::VISIBLE		constant	Exposed in the UI and potentially web accessible.
StreamWrapperInterface::WRITE		constant	Wrapper is writable.
StreamWrapperInterface::WRITE_VISIBLE		constant	Visible, readable and writable.