Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/StreamWrapper/TemporaryStream.php \Drupal\Core\StreamWrapper\TemporaryStream
- 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
- class \Drupal\Core\StreamWrapper\LocalStream implements StreamWrapperInterface
- class \Drupal\Core\StreamWrapper\TemporaryStream
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
File
- core/
lib/ Drupal/ Core/ StreamWrapper/ TemporaryStream.php, line 13
Namespace
Drupal\Core\StreamWrapperView 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 | Overrides |
---|---|---|---|---|
StreamWrapperInterface:: |
constant | A filter that matches all wrappers. | ||
LocalStream:: |
public | property | A generic resource handle. | |
LocalStream:: |
public | function |
Advisory file locking. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Close directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Closes stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Create a directory. Overrides PhpStreamWrapperInterface:: |
1 |
StreamWrapperInterface:: |
constant | Defines the stream wrapper bit flag for a hidden file. | ||
LocalStream:: |
public | function |
Delete a file. Overrides PhpStreamWrapperInterface:: |
1 |
StreamWrapperInterface:: |
constant | Exposed in the UI and potentially web accessible. | ||
LocalStream:: |
public | function |
Flushes the output. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Gets the name of the directory from a given path. Overrides StreamWrapperInterface:: |
|
TemporaryStream:: |
public | function |
Gets the path that the wrapper is responsible for. Overrides LocalStream:: |
|
StreamWrapperInterface:: |
constant | Hidden, readable and writable using local files. | ||
LocalStream:: |
protected | property | Instance URI (stream). | |
LocalStream:: |
public | function |
Open directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Opens file or URL. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Read entry from directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Read from stream. Overrides PhpStreamWrapperInterface:: |
|
StreamWrapperInterface:: |
constant | Refers to a local file system location. | ||
LocalStream:: |
public | function |
Removes a directory. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Renames a file or directory. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Retrieve information about a file resource. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve information about a file. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve the current position of a stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve the underlying stream resource. Overrides PhpStreamWrapperInterface:: |
|
TemporaryStream:: |
public | function |
Returns a web accessible URL for the resource. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Returns canonical, absolute path of the resource. Overrides StreamWrapperInterface:: |
1 |
LocalStream:: |
private | function | Returns file system service. | |
LocalStream:: |
protected | function | Returns the canonical absolute path of the URI, if possible. | 1 |
TemporaryStream:: |
public | function |
Returns the description of the stream wrapper for use in the UI. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
protected | function | Returns the local writable target of the resource within the stream. | |
TemporaryStream:: |
public | function |
Returns the name of the stream wrapper for use in the UI. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Returns the stream resource URI. Overrides StreamWrapperInterface:: |
|
TemporaryStream:: |
public static | function |
Returns the type of stream wrapper. Overrides LocalStream:: |
|
LocalStream:: |
public | function |
Rewind directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Seeks to specific location in a stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Sets metadata on the stream. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Sets the absolute stream resource URI. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
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:: |
|
LocalStream:: |
public | property | Stream context resource. | |
LocalStream:: |
public | function |
Tests for end-of-file on a file pointer. Overrides PhpStreamWrapperInterface:: |
|
StreamWrapperInterface:: |
constant | The default 'type' flag. | ||
LocalStream:: |
public | function |
Truncate stream. Overrides PhpStreamWrapperInterface:: |
1 |
StreamWrapperInterface:: |
constant | Visible and read-only. | ||
StreamWrapperInterface:: |
constant | Visible, readable and writable using local files. | ||
StreamWrapperInterface:: |
constant | Visible, readable and writable. | ||
StreamWrapperInterface:: |
constant | Wrapper is readable (almost always true). | ||
StreamWrapperInterface:: |
constant | Wrapper is writable. | ||
LocalStream:: |
public | function |
Write to stream. Overrides PhpStreamWrapperInterface:: |
1 |