Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php \Drupal\Core\StreamWrapper\TemporaryStream
  2. 9 core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php \Drupal\Core\StreamWrapper\TemporaryStream

Defines a Drupal temporary (temporary://) stream wrapper class.

Provides support for storing temporarily accessible files with the Drupal file interface.

Hierarchy

Expanded class hierarchy of TemporaryStream

1 string reference to 'TemporaryStream'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses TemporaryStream
stream_wrapper.temporary in core/core.services.yml
Drupal\Core\StreamWrapper\TemporaryStream

File

core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php, line 13

Namespace

Drupal\Core\StreamWrapper
View source 
class TemporaryStream extends LocalStream {

  /**
   * {@inheritdoc}
   */
  public static function getType() {
    return StreamWrapperInterface::LOCAL_HIDDEN;
  }

  /**
   * {@inheritdoc}
   */
  public function getName() {
    return t('Temporary files');
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return t('Temporary local files for upload and previews.');
  }

  /**
   * {@inheritdoc}
   */
  public function getDirectoryPath() {
    return \Drupal::service('file_system')
      ->getTempDirectory();
  }

  /**
   * {@inheritdoc}
   */
  public function getExternalUrl() {
    $path = str_replace('\\', '/', $this
      ->getTarget());
    return Url::fromRoute('system.temporary', [], [
      'absolute' => TRUE,
      'query' => [
        'file' => $path,
      ],
    ])
      ->toString();
  }

}

Members

Name Modifiers Type Description Overridessort ascending
LocalStream::realpath public function Returns canonical, absolute path of the resource. Overrides StreamWrapperInterface::realpath 1
LocalStream::getLocalPath protected function Returns the canonical absolute path of the URI, if possible. 1
LocalStream::stream_open public function Opens file or URL. Overrides PhpStreamWrapperInterface::stream_open 1
LocalStream::stream_lock public function Advisory file locking. Overrides PhpStreamWrapperInterface::stream_lock 1
LocalStream::stream_write public function Write to stream. Overrides PhpStreamWrapperInterface::stream_write 1
LocalStream::stream_flush public function Flushes the output. Overrides PhpStreamWrapperInterface::stream_flush 1
LocalStream::stream_metadata public function Sets metadata on the stream. Overrides PhpStreamWrapperInterface::stream_metadata 1
LocalStream::stream_truncate public function Truncate stream. Overrides PhpStreamWrapperInterface::stream_truncate 1
LocalStream::unlink public function Delete a file. Overrides PhpStreamWrapperInterface::unlink 1
LocalStream::rename public function Renames a file or directory. Overrides PhpStreamWrapperInterface::rename 1
LocalStream::mkdir public function Create a directory. Overrides PhpStreamWrapperInterface::mkdir 1
LocalStream::rmdir public function Removes a directory. Overrides PhpStreamWrapperInterface::rmdir 1
TemporaryStream::getType public static function Returns the type of stream wrapper. Overrides LocalStream::getType
TemporaryStream::getName public function Returns the name of the stream wrapper for use in the UI. Overrides StreamWrapperInterface::getName
TemporaryStream::getDescription public function Returns the description of the stream wrapper for use in the UI. Overrides StreamWrapperInterface::getDescription
TemporaryStream::getDirectoryPath public function Gets the path that the wrapper is responsible for. Overrides LocalStream::getDirectoryPath
TemporaryStream::getExternalUrl public function Returns a web accessible URL for the resource. Overrides StreamWrapperInterface::getExternalUrl
LocalStream::setUri public function Sets the absolute stream resource URI. Overrides StreamWrapperInterface::setUri
LocalStream::getUri public function Returns the stream resource URI. Overrides StreamWrapperInterface::getUri
LocalStream::getTarget protected function Returns the local writable target of the resource within the stream.
LocalStream::stream_read public function Read from stream. Overrides PhpStreamWrapperInterface::stream_read
LocalStream::stream_eof public function Tests for end-of-file on a file pointer. Overrides PhpStreamWrapperInterface::stream_eof
LocalStream::stream_seek public function Seeks to specific location in a stream. Overrides PhpStreamWrapperInterface::stream_seek
LocalStream::stream_tell public function Retrieve the current position of a stream. Overrides PhpStreamWrapperInterface::stream_tell
LocalStream::stream_stat public function Retrieve information about a file resource. Overrides PhpStreamWrapperInterface::stream_stat
LocalStream::stream_close public function Closes stream. Overrides PhpStreamWrapperInterface::stream_close
LocalStream::stream_cast public function Retrieve the underlying stream resource. Overrides PhpStreamWrapperInterface::stream_cast
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::dirname public function Gets the name of the directory from a given path. Overrides StreamWrapperInterface::dirname
LocalStream::url_stat public function Retrieve information about a file. Overrides PhpStreamWrapperInterface::url_stat
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::dir_closedir public function Close directory handle. Overrides PhpStreamWrapperInterface::dir_closedir
LocalStream::getFileSystem private function Returns file system service.
LocalStream::$context public property Stream context resource.
LocalStream::$handle public property A generic resource handle.
LocalStream::$uri protected property Instance URI (stream).
StreamWrapperInterface::ALL constant A filter that matches all wrappers.
StreamWrapperInterface::LOCAL constant Refers to a local file system location.
StreamWrapperInterface::READ constant Wrapper is readable (almost always true).
StreamWrapperInterface::WRITE constant Wrapper is writable.
StreamWrapperInterface::VISIBLE constant Exposed in the UI and potentially web accessible.
StreamWrapperInterface::HIDDEN constant Defines the stream wrapper bit flag for a hidden file.
StreamWrapperInterface::LOCAL_HIDDEN constant Hidden, readable and writable using local files.
StreamWrapperInterface::WRITE_VISIBLE constant Visible, readable and writable.
StreamWrapperInterface::READ_VISIBLE constant Visible and read-only.
StreamWrapperInterface::NORMAL constant The default 'type' flag.
StreamWrapperInterface::LOCAL_NORMAL constant Visible, readable and writable using local files.