Same name and namespace in other branches

1. 11.x core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory::getSync()
2. 10 core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory::getSync()
3. 9 core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory::getSync()
4. 8.9.x core/lib/Drupal/Core/Config/FileStorageFactory.php \Drupal\Core\Config\FileStorageFactory::getSync()

Returns a StorageInterface object working with the sync config directory.

Return value

\Drupal\Core\Config\StorageInterface The config storage object for the configuration sync directory.

Throws

\Drupal\Core\Config\ConfigDirectoryNotDefinedException In case the sync directory does not exist or is not defined in $settings['config_sync_directory'].

1 call to FileStorageFactory::getSync()

FileStorageFactoryTest::testGetSync in core/tests/Drupal/KernelTests/Core/Config/FileStorageFactoryTest.php

Tests get sync.

File

core/lib/Drupal/Core/Config/FileStorageFactory.php, line 31

Class

FileStorageFactory

Provides a factory for creating config storage objects.

Namespace

Drupal\Core\Config

Code

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"]');
  }
  @trigger_error(__CLASS__ . '::getSync() is deprecated in drupal:11.5.0 and is removed from drupal:13.0.0. Use the "config.storage.sync" service instead. See https://www.drupal.org/node/3586484', E_USER_DEPRECATED);
  return \Drupal::service('config.storage.sync');
}

---