class TranslationsStream
Same name in other branches
- 9 core/modules/locale/src/StreamWrapper/TranslationsStream.php \Drupal\locale\StreamWrapper\TranslationsStream
- 8.9.x core/modules/locale/src/StreamWrapper/TranslationsStream.php \Drupal\locale\StreamWrapper\TranslationsStream
- 11.x core/modules/locale/src/StreamWrapper/TranslationsStream.php \Drupal\locale\StreamWrapper\TranslationsStream
Defines a Drupal translations (translations://) stream wrapper class.
Provides support for storing translation files.
Hierarchy
- class \Drupal\Core\StreamWrapper\LocalStream implements \Drupal\Core\StreamWrapper\StreamWrapperInterface
- class \Drupal\locale\StreamWrapper\TranslationsStream extends \Drupal\Core\StreamWrapper\LocalStream
Expanded class hierarchy of TranslationsStream
1 string reference to 'TranslationsStream'
- locale.services.yml in core/
modules/ locale/ locale.services.yml - core/modules/locale/locale.services.yml
1 service uses TranslationsStream
- stream_wrapper.translations in core/
modules/ locale/ locale.services.yml - Drupal\locale\StreamWrapper\TranslationsStream
File
-
core/
modules/ locale/ src/ StreamWrapper/ TranslationsStream.php, line 13
Namespace
Drupal\locale\StreamWrapperView source
class TranslationsStream extends LocalStream {
/**
* {@inheritdoc}
*/
public static function getType() {
return StreamWrapperInterface::LOCAL_HIDDEN;
}
/**
* {@inheritdoc}
*/
public function getName() {
return t('Translation files');
}
/**
* {@inheritdoc}
*/
public function getDescription() {
return t('Translation files');
}
/**
* {@inheritdoc}
*/
public function getDirectoryPath() {
return \Drupal::config('locale.settings')->get('translation.path');
}
/**
* Implements Drupal\Core\StreamWrapper\StreamWrapperInterface::getExternalUrl().
* @throws \LogicException
* PO files URL should not be public.
*/
public function getExternalUrl() {
throw new \LogicException('PO files URL should not be public.');
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
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::getLocalPath | protected | function | Returns the canonical absolute path of the URI, if possible. | 1 | |
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 | |
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. | |||
TranslationsStream::getDescription | public | function | Returns the description of the stream wrapper for use in the UI. | Overrides StreamWrapperInterface::getDescription | |
TranslationsStream::getDirectoryPath | public | function | Gets the path that the wrapper is responsible for. | Overrides LocalStream::getDirectoryPath | |
TranslationsStream::getExternalUrl | public | function | Implements Drupal\Core\StreamWrapper\StreamWrapperInterface::getExternalUrl(). | Overrides StreamWrapperInterface::getExternalUrl | |
TranslationsStream::getName | public | function | Returns the name of the stream wrapper for use in the UI. | Overrides StreamWrapperInterface::getName | |
TranslationsStream::getType | public static | function | Returns the type of stream wrapper. | Overrides LocalStream::getType |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.