Backdrop stream wrapper base class for local files.

This class provides a complete stream wrapper implementation. URIs such as "public://example.txt" are expanded to a normal filesystem path such as "sites/example.com/files/example.txt" and then PHP filesystem functions are invoked.

BackdropLocalStreamWrapper implementations need to implement at least the getDirectoryPath() and getExternalUrl() methods.

Hierarchy

Expanded class hierarchy of BackdropLocalStreamWrapper

File

core/includes/stream_wrappers.inc, line 232
Backdrop stream wrapper interface.

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
BackdropLocalStreamWrapper::$context public property Stream context resource.
BackdropLocalStreamWrapper::$handle public property A generic resource handle.
BackdropLocalStreamWrapper::$uri protected property Instance URI (stream).
BackdropLocalStreamWrapper::chmod function Base implementation of chmod(). Overrides BackdropStreamWrapperInterface::chmod
BackdropLocalStreamWrapper::dirname public function Gets the name of the directory from a given path. Overrides BackdropStreamWrapperInterface::dirname
BackdropLocalStreamWrapper::dir_closedir public function Support for closedir(). Overrides StreamWrapperInterface::dir_closedir
BackdropLocalStreamWrapper::dir_opendir public function Support for opendir(). Overrides StreamWrapperInterface::dir_opendir
BackdropLocalStreamWrapper::dir_readdir public function Support for readdir(). Overrides StreamWrapperInterface::dir_readdir
BackdropLocalStreamWrapper::dir_rewinddir public function Support for rewinddir(). Overrides StreamWrapperInterface::dir_rewinddir
BackdropLocalStreamWrapper::getDirectoryPath abstract function Gets the path that the wrapper is responsible for. @TODO: Review this method name per http://drupal.org/node/701358
BackdropLocalStreamWrapper::getLocalPath protected function Returns the canonical absolute path of the URI, if possible.
BackdropLocalStreamWrapper::getMimeType static function Base implementation of getMimeType(). Overrides BackdropStreamWrapperInterface::getMimeType
BackdropLocalStreamWrapper::getTarget protected function Returns the local writable target of the resource within the stream.
BackdropLocalStreamWrapper::getUri function Base implementation of getUri(). Overrides BackdropStreamWrapperInterface::getUri
BackdropLocalStreamWrapper::mkdir public function Support for mkdir(). Overrides StreamWrapperInterface::mkdir
BackdropLocalStreamWrapper::realpath function Base implementation of realpath(). Overrides BackdropStreamWrapperInterface::realpath
BackdropLocalStreamWrapper::rename public function Support for rename(). Overrides StreamWrapperInterface::rename
BackdropLocalStreamWrapper::rmdir public function Support for rmdir(). Overrides StreamWrapperInterface::rmdir
BackdropLocalStreamWrapper::setUri function Base implementation of setUri(). Overrides BackdropStreamWrapperInterface::setUri
BackdropLocalStreamWrapper::stream_cast public function Retrieve the underlying stream resource.
BackdropLocalStreamWrapper::stream_close public function Support for fclose(). Overrides StreamWrapperInterface::stream_close
BackdropLocalStreamWrapper::stream_eof public function Support for feof(). Overrides StreamWrapperInterface::stream_eof
BackdropLocalStreamWrapper::stream_flush public function Support for fflush(). Overrides StreamWrapperInterface::stream_flush
BackdropLocalStreamWrapper::stream_lock public function Support for flock(). Overrides StreamWrapperInterface::stream_lock
BackdropLocalStreamWrapper::stream_metadata public function Sets metadata on the stream.
BackdropLocalStreamWrapper::stream_open public function Support for fopen(), file_get_contents(), file_put_contents() etc. Overrides StreamWrapperInterface::stream_open
BackdropLocalStreamWrapper::stream_read public function Support for fread(), file_get_contents() etc. Overrides StreamWrapperInterface::stream_read
BackdropLocalStreamWrapper::stream_seek public function Support for fseek(). Overrides StreamWrapperInterface::stream_seek
BackdropLocalStreamWrapper::stream_set_option public function Change stream options.
BackdropLocalStreamWrapper::stream_stat public function Support for fstat(). Overrides StreamWrapperInterface::stream_stat
BackdropLocalStreamWrapper::stream_tell public function Support for ftell(). Overrides StreamWrapperInterface::stream_tell
BackdropLocalStreamWrapper::stream_truncate public function Truncate stream.
BackdropLocalStreamWrapper::stream_write public function Support for fwrite(), file_put_contents() etc. Overrides StreamWrapperInterface::stream_write
BackdropLocalStreamWrapper::unlink public function Support for unlink(). Overrides StreamWrapperInterface::unlink
BackdropLocalStreamWrapper::url_stat public function Support for stat(). Overrides StreamWrapperInterface::url_stat
BackdropStreamWrapperInterface::getExternalUrl public function Returns a web accessible URL for the resource.