class FileStorageFactory
Same name in other branches
- 9 core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory
- 8.9.x core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory
- 11.x core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory
Provides a factory for creating config file storage objects.
Hierarchy
- class \Drupal\Core\Config\FileStorageFactory
Expanded class hierarchy of FileStorageFactory
1 file declares its use of FileStorageFactory
- FileStorageFactoryTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Config/ FileStorageFactoryTest.php
File
-
core/
lib/ Drupal/ Core/ Config/ FileStorageFactory.php, line 10
Namespace
Drupal\Core\ConfigView source
class FileStorageFactory {
/**
* Returns a FileStorage object working with the sync config directory.
*
* @return \Drupal\Core\Config\FileStorage FileStorage
*
* @throws \Drupal\Core\Config\ConfigDirectoryNotDefinedException
* In case the sync directory does not exist or is not defined in
* $settings['config_sync_directory'].
*/
public static function getSync() {
$directory = Settings::get('config_sync_directory', FALSE);
if ($directory === FALSE) {
throw new ConfigDirectoryNotDefinedException('The config sync directory is not defined in $settings["config_sync_directory"]');
}
return new FileStorage($directory);
}
}
Members
Title Sort descending | Modifiers | Object type | Summary |
---|---|---|---|
FileStorageFactory::getSync | public static | function | Returns a FileStorage object working with the sync config directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.