class NormalizedReadOnlyStorage in Configuration Normalizer 2.0.x

Defines the normalized read only storage.

Hierarchy

• class \Drupal\Core\Config\ReadOnlyStorage implements StorageInterface
  • class \Drupal\config_normalizer\Config\NormalizedReadOnlyStorage implements NormalizedReadOnlyStorageInterface

File

src/Config/NormalizedReadOnlyStorage.php, line 12

Namespace

Drupal\config_normalizer\Config

class NormalizedReadOnlyStorage extends ReadOnlyStorage implements NormalizedReadOnlyStorageInterface {

  /**
   * The config item normalizer.
   *
   * @var \Drupal\config_normalizer\ConfigNormalizerInterface
   */
  protected $normalizer;

  /**
   * Create a NormalizedReadOnlyStorage decorating another storage.
   *
   * @param \Drupal\Core\Config\StorageInterface $storage
   *   The decorated storage.
   * @param \Drupal\config_normalizer\ConfigNormalizerInterface|mixed $normalizer
   *   The normalization manager. In 2.0.0 we will add a typehint.
   * @param array $context
   *   (optional, deprecated) This parameter will be removed in 2.0.0.
   */
  public function __construct(StorageInterface $storage, $normalizer, array $context = []) {
    parent::__construct($storage);
    if (!$normalizer instanceof ConfigNormalizerInterface) {
      $normalizer = \Drupal::service('config_normalizer.normalizer');
    }
    $this->normalizer = $normalizer;
  }

  /**
   * {@inheritdoc}
   */
  public function getContext() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function setContext(array $context = []) {
  }

  /**
   * {@inheritdoc}
   */
  public function read($name) {
    $data = parent::read($name);
    $data = $this
      ->normalize($name, $data);
    return $data;
  }

  /**
   * {@inheritdoc}
   */
  public function readMultiple(array $names) {
    $list = parent::readMultiple($names);
    foreach ($list as $name => &$data) {
      $data = $this
        ->normalize($name, $data);
    }
    return $list;
  }

  /**
   * {@inheritdoc}
   */
  public function createCollection($collection) {
    return new static($this->storage
      ->createCollection($collection), $this->normalizer);
  }

  /**
   * Normalizes configuration data.
   *
   * @param string $name
   *   The name of a configuration object to load.
   * @param array|bool $data
   *   The configuration data to normalize.
   *
   * @return array|bool
   *   The configuration data stored for the configuration object name. If no
   *   configuration data exists for the given name, FALSE is returned.
   */
  protected function normalize($name, $data) {
    if (!is_bool($data)) {
      $data = $this->normalizer
        ->normalize($name, $data);
    }
    return $data;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
NormalizedReadOnlyStorage::$normalizer	protected	property	The config item normalizer.
NormalizedReadOnlyStorage::createCollection	public	function	Creates a collection on the storage. Overrides ReadOnlyStorage::createCollection
NormalizedReadOnlyStorage::getContext	public	function	Gets the context to be used for normalization. Overrides NormalizedReadOnlyStorageInterface::getContext
NormalizedReadOnlyStorage::normalize	protected	function	Normalizes configuration data.
NormalizedReadOnlyStorage::read	public	function	Reads configuration data from the storage. Overrides ReadOnlyStorage::read
NormalizedReadOnlyStorage::readMultiple	public	function	Reads configuration data from the storage. Overrides ReadOnlyStorage::readMultiple
NormalizedReadOnlyStorage::setContext	public	function	Sets the context to be used for normalization. Overrides NormalizedReadOnlyStorageInterface::setContext
NormalizedReadOnlyStorage::__construct	public	function	Create a NormalizedReadOnlyStorage decorating another storage. Overrides ReadOnlyStorage::__construct
NormalizedReadOnlyStorageInterface::DEFAULT_CONTEXT Deprecated		constant	The default context for normalization.
NormalizedReadOnlyStorageInterface::DEFAULT_NORMALIZATION_MODE Deprecated		constant	The default normalization mode.
NormalizedReadOnlyStorageInterface::NORMALIZATION_MODE_COMPARE Deprecated		constant	Mode in which the storage is being prepared for comparison.
NormalizedReadOnlyStorageInterface::NORMALIZATION_MODE_PROVIDE Deprecated		constant	Mode in which the storage is being prepared for providing configuration.
ReadOnlyStorage::$storage	protected	property	The config storage that we are decorating.
ReadOnlyStorage::decode	public	function	Decodes configuration data from the storage-specific format. Overrides StorageInterface::decode
ReadOnlyStorage::delete	public	function	Deletes a configuration object from the storage. Overrides StorageInterface::delete
ReadOnlyStorage::deleteAll	public	function	Deletes configuration objects whose names start with a given prefix. Overrides StorageInterface::deleteAll
ReadOnlyStorage::encode	public	function	Encodes configuration data into the storage-specific format. Overrides StorageInterface::encode
ReadOnlyStorage::exists	public	function	Returns whether a configuration object exists. Overrides StorageInterface::exists
ReadOnlyStorage::getAllCollectionNames	public	function	Gets the existing collections. Overrides StorageInterface::getAllCollectionNames
ReadOnlyStorage::getCollectionName	public	function	Gets the name of the current collection the storage is using. Overrides StorageInterface::getCollectionName
ReadOnlyStorage::listAll	public	function	Gets configuration object names starting with a given prefix. Overrides StorageInterface::listAll
ReadOnlyStorage::rename	public	function	Renames a configuration object in the storage. Overrides StorageInterface::rename
ReadOnlyStorage::write	public	function	Writes configuration data to the storage. Overrides StorageInterface::write
StorageInterface::DEFAULT_COLLECTION		constant	The default collection name.