abstract class ReadOnlyStream

Defines a read-only Drupal stream wrapper base class.

This class provides a minimal-read only stream wrapper implementation. Specifically, it only implements the writing classes and read classes where we need to restrict 'write-capable' arguments.

Drupal\Core\StreamWrapper\ReadOnlyStream implementations need to implement all the read-related classes.

Hierarchy

• class \Drupal\Core\StreamWrapper\ReadOnlyStream implements StreamWrapperInterface

File

core/lib/Drupal/Core/StreamWrapper/ReadOnlyStream.php, line 15

Namespace

Drupal\Core\StreamWrapper

Members

Name	Modifiers	Type	Description
PhpStreamWrapperInterface::dir_closedir	public	function
PhpStreamWrapperInterface::dir_opendir	public	function
PhpStreamWrapperInterface::dir_readdir	public	function
PhpStreamWrapperInterface::dir_rewinddir	public	function
PhpStreamWrapperInterface::stream_cast	public	function	Retrieve the underlying stream resource.
PhpStreamWrapperInterface::stream_close	public	function	Closes stream.
PhpStreamWrapperInterface::stream_eof	public	function
PhpStreamWrapperInterface::stream_read	public	function
PhpStreamWrapperInterface::stream_seek	public	function	Seeks to specific location in a stream.
PhpStreamWrapperInterface::stream_set_option	public	function	Change stream options.
PhpStreamWrapperInterface::stream_stat	public	function
PhpStreamWrapperInterface::stream_tell	public	function
PhpStreamWrapperInterface::url_stat	public	function
ReadOnlyStream::$context	public	property	Stream context resource.
ReadOnlyStream::$handle	public	property	A generic resource handle.
ReadOnlyStream::$uri	protected	property	Instance URI (stream).
ReadOnlyStream::getUri		function	Returns the stream resource URI. Overrides StreamWrapperInterface::getUri
ReadOnlyStream::mkdir	public	function	Support for mkdir(). Overrides PhpStreamWrapperInterface::mkdir
ReadOnlyStream::rename	public	function	Support for rename(). Overrides PhpStreamWrapperInterface::rename
ReadOnlyStream::rmdir	public	function	Support for rmdir(). Overrides PhpStreamWrapperInterface::rmdir
ReadOnlyStream::setUri		function	Sets the absolute stream resource URI. Overrides StreamWrapperInterface::setUri
ReadOnlyStream::stream_flush	public	function	Support for fflush(). Overrides PhpStreamWrapperInterface::stream_flush
ReadOnlyStream::stream_lock	public	function	Support for flock(). Overrides PhpStreamWrapperInterface::stream_lock
ReadOnlyStream::stream_metadata	public	function	Does not change meta data as this is a read-only stream wrapper. Overrides PhpStreamWrapperInterface::stream_metadata
ReadOnlyStream::stream_open	public	function	Support for fopen(), file_get_contents(), etc. Overrides PhpStreamWrapperInterface::stream_open
ReadOnlyStream::stream_truncate	public	function	Truncate stream. Overrides PhpStreamWrapperInterface::stream_truncate
ReadOnlyStream::stream_write	public	function	Support for fwrite(), file_put_contents() etc. Overrides PhpStreamWrapperInterface::stream_write
ReadOnlyStream::unlink	public	function	Support for unlink(). Overrides PhpStreamWrapperInterface::unlink
StreamWrapperInterface::ALL		constant	A filter that matches all wrappers.
StreamWrapperInterface::dirname	public	function	Gets the name of the directory from a given path.
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::getType	public static	function	Returns the type of stream wrapper.
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::realpath	public	function	Returns canonical, absolute path of the resource.
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.