class NullStorage

Defines a stub storage controller.

This storage is always empty; the controller reads and writes nothing.

The stub implementation is needed for synchronizing configuration during installation of a module, in which case all configuration being shipped with the module is known to be new. Therefore, the module installation process is able to short-circuit the full diff against the active configuration; the diff would yield all currently available configuration as items to remove, since they do not exist in the module's default configuration directory.

This also can be used for testing purposes.

Hierarchy

Expanded class hierarchy of NullStorage

1 file declares its use of NullStorage
config.inc in drupal/core/includes/config.inc
This is the API for configuration storage.

File

drupal/core/lib/Drupal/Core/Config/NullStorage.php, line 24
Definition of Drupal\Core\Config\NullStorage.

Namespace

Drupal\Core\Config
View source
class NullStorage implements StorageInterface {

  /**
   * Implements Drupal\Core\Config\StorageInterface::exists().
   */
  public function exists($name) {
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::read().
   */
  public function read($name) {
    return array();
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::write().
   */
  public function write($name, array $data) {
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::delete().
   */
  public function delete($name) {
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::rename().
   */
  public function rename($name, $new_name) {
    return FALSE;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::encode().
   */
  public function encode($data) {
    return $data;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::decode().
   */
  public function decode($raw) {
    return $raw;
  }

  /**
   * Implements Drupal\Core\Config\StorageInterface::listAll().
   */
  public function listAll($prefix = '') {
    return array();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
NullStorage::decode public function Implements Drupal\Core\Config\StorageInterface::decode(). Overrides StorageInterface::decode
NullStorage::delete public function Implements Drupal\Core\Config\StorageInterface::delete(). Overrides StorageInterface::delete
NullStorage::encode public function Implements Drupal\Core\Config\StorageInterface::encode(). Overrides StorageInterface::encode
NullStorage::exists public function Implements Drupal\Core\Config\StorageInterface::exists(). Overrides StorageInterface::exists
NullStorage::listAll public function Implements Drupal\Core\Config\StorageInterface::listAll(). Overrides StorageInterface::listAll
NullStorage::read public function Implements Drupal\Core\Config\StorageInterface::read(). Overrides StorageInterface::read
NullStorage::rename public function Implements Drupal\Core\Config\StorageInterface::rename(). Overrides StorageInterface::rename
NullStorage::write public function Implements Drupal\Core\Config\StorageInterface::write(). Overrides StorageInterface::write