Same name and namespace in other branches
- 8.9.x core/lib/Drupal/Core/StreamWrapper/PrivateStream.php \Drupal\Core\StreamWrapper\PrivateStream
- 9 core/lib/Drupal/Core/StreamWrapper/PrivateStream.php \Drupal\Core\StreamWrapper\PrivateStream
Drupal private (private://) stream wrapper class.
Provides support for storing privately accessible files with the Drupal file interface.
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements StreamWrapperInterface
- class \Drupal\Core\StreamWrapper\PrivateStream
Expanded class hierarchy of PrivateStream
3 files declare their use of PrivateStream
- FileSystemForm.php in core/
modules/ system/ src/ Form/ FileSystemForm.php - HtaccessWriter.php in core/
lib/ Drupal/ Core/ File/ HtaccessWriter.php - ImageStyleCustomStreamWrappersTest.php in core/
modules/ image/ tests/ src/ Kernel/ ImageStyleCustomStreamWrappersTest.php
File
- core/
lib/ Drupal/ Core/ StreamWrapper/ PrivateStream.php, line 14
Namespace
Drupal\Core\StreamWrapperView source
class PrivateStream extends LocalStream {
/**
* {@inheritdoc}
*/
public static function getType() {
return StreamWrapperInterface::LOCAL_NORMAL;
}
/**
* {@inheritdoc}
*/
public function getName() {
return t('Private files');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return t('Private local files served by Drupal.');
}
/**
* {@inheritdoc}
*/
public function getDirectoryPath() {
return static::basePath();
}
/**
* {@inheritdoc}
*/
public function getExternalUrl() {
$path = str_replace('\\', '/', $this
->getTarget());
return Url::fromRoute('system.private_file_download', [
'filepath' => $path,
], [
'absolute' => TRUE,
'path_processing' => FALSE,
])
->toString();
}
/**
* Returns the base path for private://.
*
* Note that this static method is used by \Drupal\system\Form\FileSystemForm
* so you should alter that form or substitute a different form if you change
* the class providing the stream_wrapper.private service.
*
* @return string|null
* The base path for private://. NULL means the private directory is not
* set.
*/
public static function basePath() {
return Settings::get('file_private_path');
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
LocalStream:: |
public | function |
Returns canonical, absolute path of the resource. Overrides StreamWrapperInterface:: |
1 |
LocalStream:: |
protected | function | Returns the canonical absolute path of the URI, if possible. | 1 |
LocalStream:: |
public | function |
Opens file or URL. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Advisory file locking. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Write to stream. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Flushes the output. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Sets metadata on the stream. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Truncate stream. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Delete a file. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Renames a file or directory. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Create a directory. Overrides PhpStreamWrapperInterface:: |
1 |
LocalStream:: |
public | function |
Removes a directory. Overrides PhpStreamWrapperInterface:: |
1 |
PrivateStream:: |
public static | function |
Returns the type of stream wrapper. Overrides LocalStream:: |
|
PrivateStream:: |
public | function |
Returns the name of the stream wrapper for use in the UI. Overrides StreamWrapperInterface:: |
|
PrivateStream:: |
public | function |
Returns the description of the stream wrapper for use in the UI. Overrides StreamWrapperInterface:: |
|
PrivateStream:: |
public | function |
Gets the path that the wrapper is responsible for. Overrides LocalStream:: |
|
PrivateStream:: |
public | function |
Returns a web accessible URL for the resource. Overrides StreamWrapperInterface:: |
|
PrivateStream:: |
public static | function | Returns the base path for private://. | |
LocalStream:: |
public | function |
Sets the absolute stream resource URI. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Returns the stream resource URI. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
protected | function | Returns the local writable target of the resource within the stream. | |
LocalStream:: |
public | function |
Read from stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Tests for end-of-file on a file pointer. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Seeks to specific location in a stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve the current position of a stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve information about a file resource. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Closes stream. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve the underlying stream resource. Overrides PhpStreamWrapperInterface:: |
|
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 | function |
Gets the name of the directory from a given path. Overrides StreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Retrieve information about a file. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Open directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Read entry from directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Rewind directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
public | function |
Close directory handle. Overrides PhpStreamWrapperInterface:: |
|
LocalStream:: |
private | function | Returns file system service. | |
LocalStream:: |
public | property | Stream context resource. | |
LocalStream:: |
public | property | A generic resource handle. | |
LocalStream:: |
protected | property | Instance URI (stream). | |
StreamWrapperInterface:: |
constant | A filter that matches all wrappers. | ||
StreamWrapperInterface:: |
constant | Refers to a local file system location. | ||
StreamWrapperInterface:: |
constant | Wrapper is readable (almost always true). | ||
StreamWrapperInterface:: |
constant | Wrapper is writable. | ||
StreamWrapperInterface:: |
constant | Exposed in the UI and potentially web accessible. | ||
StreamWrapperInterface:: |
constant | Defines the stream wrapper bit flag for a hidden file. | ||
StreamWrapperInterface:: |
constant | Hidden, readable and writable using local files. | ||
StreamWrapperInterface:: |
constant | Visible, readable and writable. | ||
StreamWrapperInterface:: |
constant | Visible and read-only. | ||
StreamWrapperInterface:: |
constant | The default 'type' flag. | ||
StreamWrapperInterface:: |
constant | Visible, readable and writable using local files. |