class DummyStreamWrapper
Same name in other branches
- 9 core/modules/file/tests/file_test/src/StreamWrapper/DummyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyStreamWrapper
- 8.9.x core/modules/file/tests/file_test/src/StreamWrapper/DummyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyStreamWrapper
- 10 core/modules/file/tests/file_test/src/StreamWrapper/DummyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyStreamWrapper
Helper class for testing the stream wrapper registry.
Dummy stream wrapper implementation (dummy://).
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements \Drupal\Core\StreamWrapper\StreamWrapperInterface
- class \Drupal\file_test\StreamWrapper\DummyStreamWrapper extends \Drupal\Core\StreamWrapper\LocalStream
Expanded class hierarchy of 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 14
Namespace
Drupal\file_test\StreamWrapperView source
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
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | 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 | Gets the name of the directory from a given path. | Overrides StreamWrapperInterface::dirname | |
LocalStream::dir_closedir | public | function | Close directory handle. | Overrides PhpStreamWrapperInterface::dir_closedir | |
LocalStream::dir_opendir | public | function | Open directory handle. | Overrides PhpStreamWrapperInterface::dir_opendir | |
LocalStream::dir_readdir | public | function | Read entry from directory handle. | Overrides PhpStreamWrapperInterface::dir_readdir | |
LocalStream::dir_rewinddir | public | function | Rewind directory handle. | Overrides PhpStreamWrapperInterface::dir_rewinddir | |
LocalStream::getFileSystem | private | function | Returns file system service. | ||
LocalStream::getLocalPath | protected | function | Returns the canonical absolute path of the URI, if possible. | 1 | |
LocalStream::getTarget | protected | function | Returns the local writable target of the resource within the stream. | ||
LocalStream::getType | public static | function | Returns the type of stream wrapper. | Overrides StreamWrapperInterface::getType | 5 |
LocalStream::getUri | public | function | Returns the stream resource URI. | Overrides StreamWrapperInterface::getUri | |
LocalStream::mkdir | public | function | Create a directory. | Overrides PhpStreamWrapperInterface::mkdir | 1 |
LocalStream::realpath | public | function | Returns canonical, absolute path of the resource. | Overrides StreamWrapperInterface::realpath | 1 |
LocalStream::rename | public | function | Renames a file or directory. | Overrides PhpStreamWrapperInterface::rename | 1 |
LocalStream::rmdir | public | function | Removes a directory. | Overrides PhpStreamWrapperInterface::rmdir | 1 |
LocalStream::setUri | public | function | Sets the absolute stream resource URI. | Overrides StreamWrapperInterface::setUri | |
LocalStream::stream_cast | public | function | Retrieve the underlying stream resource. | Overrides PhpStreamWrapperInterface::stream_cast | |
LocalStream::stream_close | public | function | Closes stream. | Overrides PhpStreamWrapperInterface::stream_close | |
LocalStream::stream_eof | public | function | Tests for end-of-file on a file pointer. | Overrides PhpStreamWrapperInterface::stream_eof | |
LocalStream::stream_flush | public | function | Flushes the output. | Overrides PhpStreamWrapperInterface::stream_flush | 1 |
LocalStream::stream_lock | public | function | Advisory file locking. | Overrides PhpStreamWrapperInterface::stream_lock | 1 |
LocalStream::stream_metadata | public | function | Sets metadata on the stream. | Overrides PhpStreamWrapperInterface::stream_metadata | 1 |
LocalStream::stream_open | public | function | Opens file or URL. | Overrides PhpStreamWrapperInterface::stream_open | 1 |
LocalStream::stream_read | public | function | Read from stream. | Overrides PhpStreamWrapperInterface::stream_read | |
LocalStream::stream_seek | public | function | Seeks to specific location in a stream. | Overrides PhpStreamWrapperInterface::stream_seek | |
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… |
Overrides PhpStreamWrapperInterface::stream_set_option | |
LocalStream::stream_stat | public | function | Retrieve information about a file resource. | Overrides PhpStreamWrapperInterface::stream_stat | |
LocalStream::stream_tell | public | function | Retrieve the current position of a stream. | Overrides PhpStreamWrapperInterface::stream_tell | |
LocalStream::stream_truncate | public | function | Truncate stream. | Overrides PhpStreamWrapperInterface::stream_truncate | 1 |
LocalStream::stream_write | public | function | Write to stream. | Overrides PhpStreamWrapperInterface::stream_write | 1 |
LocalStream::unlink | public | function | Delete a file. | Overrides PhpStreamWrapperInterface::unlink | 1 |
LocalStream::url_stat | public | function | Retrieve information about a file. | Overrides PhpStreamWrapperInterface::url_stat | |
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 | The default 'type' flag. | |||
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. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.