class AssetsStream
Same name in other branches
- 11.x core/lib/Drupal/Core/StreamWrapper/AssetsStream.php \Drupal\Core\StreamWrapper\AssetsStream
Defines a Drupal stream wrapper class for optimized assets (assets://).
Provides support for storing publicly accessible optimized assets files with the Drupal file interface.
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements \Drupal\Core\StreamWrapper\StreamWrapperInterface
- class \Drupal\Core\StreamWrapper\PublicStream extends \Drupal\Core\StreamWrapper\LocalStream
- class \Drupal\Core\StreamWrapper\AssetsStream extends \Drupal\Core\StreamWrapper\PublicStream uses \Drupal\Core\StringTranslation\StringTranslationTrait
- class \Drupal\Core\StreamWrapper\PublicStream extends \Drupal\Core\StreamWrapper\LocalStream
Expanded class hierarchy of AssetsStream
1 file declares its use of AssetsStream
- FileSystemForm.php in core/
modules/ system/ src/ Form/ FileSystemForm.php
1 string reference to 'AssetsStream'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses AssetsStream
File
-
core/
lib/ Drupal/ Core/ StreamWrapper/ AssetsStream.php, line 14
Namespace
Drupal\Core\StreamWrapperView source
class AssetsStream extends PublicStream {
use StringTranslationTrait;
/**
* {@inheritdoc}
*/
public static function getType() : int {
return StreamWrapperInterface::LOCAL_HIDDEN;
}
/**
* {@inheritdoc}
*/
public function getName() : string {
return $this->t('Optimized assets files');
}
/**
* {@inheritdoc}
*/
public function getDescription() : string {
return $this->t('Public local optimized assets files served by the webserver.');
}
/**
* {@inheritdoc}
*/
public static function basePath($site_path = NULL) : string {
return Settings::get('file_assets_path', parent::basePath($site_path));
}
/**
* {@inheritdoc}
*/
public static function baseUrl() : string {
$public_path = Settings::get('file_public_path', 'sites/default/files');
$path = Settings::get('file_assets_path', $public_path);
if ($path === $public_path) {
$base_url = PublicStream::baseUrl();
}
else {
$base_url = $GLOBALS['base_url'] . '/' . $path;
}
return $base_url;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
AssetsStream::basePath | public static | function | Returns the base path for public://. | Overrides PublicStream::basePath | |
AssetsStream::baseUrl | public static | function | Finds and returns the base URL for public://. | Overrides PublicStream::baseUrl | |
AssetsStream::getDescription | public | function | Returns the description of the stream wrapper for use in the UI. | Overrides PublicStream::getDescription | |
AssetsStream::getName | public | function | Returns the name of the stream wrapper for use in the UI. | Overrides PublicStream::getName | |
AssetsStream::getType | public static | function | Returns the type of stream wrapper. | Overrides PublicStream::getType | |
LocalStream::$context | public | property | Stream context resource. | ||
LocalStream::$handle | public | property | A generic resource handle. | ||
LocalStream::$uri | protected | property | Instance URI (stream). | ||
LocalStream::dirname | public | function | Gets the name of the directory from a given path. | Overrides StreamWrapperInterface::dirname | |
LocalStream::dir_closedir | public | function | Close directory handle. | Overrides PhpStreamWrapperInterface::dir_closedir | |
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::getFileSystem | private | function | Returns file system service. | ||
LocalStream::getTarget | protected | function | Returns the local writable target of the resource within the stream. | ||
LocalStream::getUri | public | function | Returns the stream resource URI. | Overrides StreamWrapperInterface::getUri | |
LocalStream::mkdir | public | function | Create a directory. | Overrides PhpStreamWrapperInterface::mkdir | 1 |
LocalStream::realpath | public | function | Returns canonical, absolute path of the resource. | Overrides StreamWrapperInterface::realpath | 1 |
LocalStream::rename | public | function | Renames a file or directory. | Overrides PhpStreamWrapperInterface::rename | 1 |
LocalStream::rmdir | public | function | Removes a directory. | Overrides PhpStreamWrapperInterface::rmdir | 1 |
LocalStream::setUri | public | function | Sets the absolute stream resource URI. | Overrides StreamWrapperInterface::setUri | |
LocalStream::stream_cast | public | function | Retrieve the underlying stream resource. | Overrides PhpStreamWrapperInterface::stream_cast | |
LocalStream::stream_close | public | function | Closes stream. | Overrides PhpStreamWrapperInterface::stream_close | |
LocalStream::stream_eof | public | function | Tests for end-of-file on a file pointer. | Overrides PhpStreamWrapperInterface::stream_eof | |
LocalStream::stream_flush | public | function | Flushes the output. | Overrides PhpStreamWrapperInterface::stream_flush | 1 |
LocalStream::stream_lock | public | function | Advisory file locking. | Overrides PhpStreamWrapperInterface::stream_lock | 1 |
LocalStream::stream_metadata | public | function | Sets metadata on the stream. | Overrides PhpStreamWrapperInterface::stream_metadata | 1 |
LocalStream::stream_open | public | function | Opens file or URL. | Overrides PhpStreamWrapperInterface::stream_open | 1 |
LocalStream::stream_read | public | function | Read from stream. | Overrides PhpStreamWrapperInterface::stream_read | |
LocalStream::stream_seek | public | function | Seeks to specific location in a stream. | Overrides PhpStreamWrapperInterface::stream_seek | |
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::stream_stat | public | function | Retrieve information about a file resource. | Overrides PhpStreamWrapperInterface::stream_stat | |
LocalStream::stream_tell | public | function | Retrieve the current position of a stream. | Overrides PhpStreamWrapperInterface::stream_tell | |
LocalStream::stream_truncate | public | function | Truncate stream. | Overrides PhpStreamWrapperInterface::stream_truncate | 1 |
LocalStream::stream_write | public | function | Write to stream. | Overrides PhpStreamWrapperInterface::stream_write | 1 |
LocalStream::unlink | public | function | Delete a file. | Overrides PhpStreamWrapperInterface::unlink | 1 |
LocalStream::url_stat | public | function | Retrieve information about a file. | Overrides PhpStreamWrapperInterface::url_stat | |
PublicStream::getDirectoryPath | public | function | Gets the path that the wrapper is responsible for. | Overrides LocalStream::getDirectoryPath | |
PublicStream::getExternalUrl | public | function | Returns a web accessible URL for the resource. | Overrides StreamWrapperInterface::getExternalUrl | |
PublicStream::getLocalPath | protected | function | Returns the canonical absolute path of the URI, if possible. | Overrides LocalStream::getLocalPath | |
StreamWrapperInterface::ALL | constant | A filter that matches all wrappers. | |||
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 writable using local files. | |||
StreamWrapperInterface::LOCAL_NORMAL | constant | Visible, readable and writable using local files. | |||
StreamWrapperInterface::NORMAL | constant | The default 'type' flag. | |||
StreamWrapperInterface::READ | constant | Wrapper is readable (almost always true). | |||
StreamWrapperInterface::READ_VISIBLE | constant | Visible and read-only. | |||
StreamWrapperInterface::VISIBLE | constant | Exposed in the UI and potentially web accessible. | |||
StreamWrapperInterface::WRITE | constant | Wrapper is writable. | |||
StreamWrapperInterface::WRITE_VISIBLE | constant | Visible, readable and writable. | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.