Defines a read-only Drupal stream wrapper base class for local files.
This class extends the complete stream wrapper implementation in LocalStream. URIs such as "public://example.txt" are expanded to a normal filesystem path such as "sites/default/files/example.txt" and then PHP filesystem functions are invoked.
Drupal\Core\StreamWrapper\LocalReadOnlyStream implementations need to implement at least the getDirectoryPath() and getExternalUrl() methods.
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements StreamWrapperInterface
- class \Drupal\Core\StreamWrapper\LocalReadOnlyStream
File
- core/lib/Drupal/Core/StreamWrapper/LocalReadOnlyStream.php, line 16
Namespace
Drupal\Core\StreamWrapper
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| 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 | Support for fopen(), file_get_contents(), file_put_contents() etc. 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 | Support for closedir(). Overrides PhpStreamWrapperInterface::dir_closedir |
| LocalStream::dir_opendir | public | function | Support for opendir(). Overrides PhpStreamWrapperInterface::dir_opendir |
| LocalStream::dir_readdir | public | function | Support for readdir(). Overrides PhpStreamWrapperInterface::dir_readdir |
| LocalStream::dir_rewinddir | public | function | Support for rewinddir(). Overrides PhpStreamWrapperInterface::dir_rewinddir |
| LocalStream::getDirectoryPath | abstract | function | Gets the path that the wrapper is responsible for. |
| 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::getUri | function | Returns the stream resource URI. Overrides StreamWrapperInterface::getUri | |
| LocalStream::realpath | function | Returns canonical, absolute path of the resource. Overrides StreamWrapperInterface::realpath | |
| LocalStream::setUri | 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 | Support for fclose(). Overrides PhpStreamWrapperInterface::stream_close |
| LocalStream::stream_eof | public | function | Support for feof(). Overrides PhpStreamWrapperInterface::stream_eof |
| LocalStream::stream_read | public | function | Support for fread(), file_get_contents() etc. 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 | Support for fstat(). Overrides PhpStreamWrapperInterface::stream_stat |
| LocalStream::stream_tell | public | function | Support for ftell(). Overrides PhpStreamWrapperInterface::stream_tell |
| LocalStream::url_stat | public | function | Support for stat(). Overrides PhpStreamWrapperInterface::url_stat |
| StreamWrapperInterface::ALL | constant | A filter that matches all wrappers. | |
| StreamWrapperInterface::getDescription | public | function | Returns the description of the stream wrapper for use in the UI. |
| StreamWrapperInterface::getExternalUrl | public | function | Returns a web accessible URL for the resource. |
| StreamWrapperInterface::getName | public | function | Returns the name of the stream wrapper for use in the UI. |
| 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 writeable using local files. | |
| StreamWrapperInterface::LOCAL_NORMAL | constant | Visible, readable and writeable using local files. | |
| StreamWrapperInterface::NORMAL | constant | This is the default 'type' falg. 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 writeable. | |
| StreamWrapperInterface::WRITE_VISIBLE | constant | Visible, readable and writeable. |
Please login to continue.