class DummyReadOnlyStreamWrapper
Same name in other branches
- 8.9.x core/modules/file/tests/file_test/src/StreamWrapper/DummyReadOnlyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper
- 10 core/modules/file/tests/file_test/src/StreamWrapper/DummyReadOnlyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper
- 11.x core/modules/file/tests/file_test/src/StreamWrapper/DummyReadOnlyStreamWrapper.php \Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper
Helper class for testing the stream wrapper registry.
Dummy stream wrapper implementation (dummy-readonly://).
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements \Drupal\Core\StreamWrapper\StreamWrapperInterface
- class \Drupal\Core\StreamWrapper\LocalReadOnlyStream extends \Drupal\Core\StreamWrapper\LocalStream
- class \Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper extends \Drupal\Core\StreamWrapper\LocalReadOnlyStream
- class \Drupal\Core\StreamWrapper\LocalReadOnlyStream extends \Drupal\Core\StreamWrapper\LocalStream
Expanded class hierarchy of DummyReadOnlyStreamWrapper
2 files declare their use of DummyReadOnlyStreamWrapper
- ImageStyleCustomStreamWrappersTest.php in core/
modules/ image/ tests/ src/ Kernel/ ImageStyleCustomStreamWrappersTest.php - ReadOnlyStreamWrapperTest.php in core/
tests/ Drupal/ KernelTests/ Core/ File/ ReadOnlyStreamWrapperTest.php
1 string reference to 'DummyReadOnlyStreamWrapper'
- 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 DummyReadOnlyStreamWrapper
- stream_wrapper.dummy_readonly in core/
modules/ file/ tests/ file_test/ file_test.services.yml - Drupal\file_test\StreamWrapper\DummyReadOnlyStreamWrapper
File
-
core/
modules/ file/ tests/ file_test/ src/ StreamWrapper/ DummyReadOnlyStreamWrapper.php, line 12
Namespace
Drupal\file_test\StreamWrapperView source
class DummyReadOnlyStreamWrapper extends LocalReadOnlyStream {
/**
* {@inheritdoc}
*/
public function getName() {
return t('Dummy files (readonly)');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return t('Dummy wrapper for simpletest (readonly).');
}
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 |
---|---|---|---|---|---|
DummyReadOnlyStreamWrapper::getDescription | public | function | Returns the description of the stream wrapper for use in the UI. | Overrides StreamWrapperInterface::getDescription | |
DummyReadOnlyStreamWrapper::getDirectoryPath | public | function | Gets the path that the wrapper is responsible for. | Overrides LocalStream::getDirectoryPath | |
DummyReadOnlyStreamWrapper::getExternalUrl | public | function | Override getExternalUrl(). | Overrides StreamWrapperInterface::getExternalUrl | |
DummyReadOnlyStreamWrapper::getInternalUri | public | function | Override getInternalUri(). | ||
DummyReadOnlyStreamWrapper::getName | public | function | Returns the name of the stream wrapper for use in the UI. | Overrides StreamWrapperInterface::getName | |
LocalReadOnlyStream::getType | public static | function | Returns the type of stream wrapper. | Overrides LocalStream::getType | |
LocalReadOnlyStream::mkdir | public | function | Support for mkdir(). | Overrides LocalStream::mkdir | |
LocalReadOnlyStream::rename | public | function | Support for rename(). | Overrides LocalStream::rename | |
LocalReadOnlyStream::rmdir | public | function | Support for rmdir(). | Overrides LocalStream::rmdir | |
LocalReadOnlyStream::stream_flush | public | function | Support for fflush(). | Overrides LocalStream::stream_flush | |
LocalReadOnlyStream::stream_lock | public | function | Support for flock(). | Overrides LocalStream::stream_lock | |
LocalReadOnlyStream::stream_metadata | public | function | Does not change meta data as this is a read-only stream wrapper. | Overrides LocalStream::stream_metadata | |
LocalReadOnlyStream::stream_open | public | function | Opens file or URL. | Overrides LocalStream::stream_open | |
LocalReadOnlyStream::stream_truncate | public | function | Truncate stream. | Overrides LocalStream::stream_truncate | |
LocalReadOnlyStream::stream_write | public | function | Support for fwrite(), file_put_contents() etc. | Overrides LocalStream::stream_write | |
LocalReadOnlyStream::unlink | public | function | Support for unlink(). | Overrides LocalStream::unlink | |
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::getUri | public | function | Returns the stream resource URI. | Overrides StreamWrapperInterface::getUri | |
LocalStream::realpath | public | function | Returns canonical, absolute path of the resource. | Overrides StreamWrapperInterface::realpath | 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_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::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.