/Drupal 8

interface StreamWrapperInterface

Defines a Drupal stream wrapper extension.

Provides a Drupal interface and classes to implement PHP stream wrappers for public, private, and temporary files. Extends the StreamWrapperInterface with methods expected by Drupal stream wrapper classes.

A stream wrapper is an abstraction of a file system that allows Drupal to use the same set of methods to access both local files and remote resources.

Note that PHP 5.2 fopen() only supports URIs of the form "scheme://target" despite the fact that according to RFC 3986 a URI's scheme component delimiter is in general just ":", not "://". Because of this PHP limitation and for consistency Drupal will only accept URIs of form "scheme://target".


See also




core/lib/Drupal/Core/StreamWrapper/StreamWrapperInterface.php, line 23




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::mkdir public function
PhpStreamWrapperInterface::rename public function
PhpStreamWrapperInterface::rmdir 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_flush public function
PhpStreamWrapperInterface::stream_lock public function
PhpStreamWrapperInterface::stream_metadata public function Sets metadata on the stream.
PhpStreamWrapperInterface::stream_open 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::stream_truncate public function Truncate stream.
PhpStreamWrapperInterface::stream_write public function
PhpStreamWrapperInterface::unlink public function
PhpStreamWrapperInterface::url_stat public function
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::getUri public function Returns the stream resource URI.
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::setUri public function Sets the absolute stream resource URI.
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.

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.