FileStorageFactory.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Config/FileStorageFactory.php
  2. 10 core/lib/Drupal/Core/Config/FileStorageFactory.php
  3. 11.x core/lib/Drupal/Core/Config/FileStorageFactory.php

Namespace

Drupal\Core\Config

File

core/lib/Drupal/Core/Config/FileStorageFactory.php

View source
<?php

namespace Drupal\Core\Config;

use Drupal\Core\Site\Settings;

/**
 * Provides a factory for creating config file storage objects.
 */
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);
    }

}

Classes

Title Deprecated Summary
FileStorageFactory Provides a factory for creating config file storage objects.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.