1. class
  2. Drupal
  3. \
  4. Core
  5. \
  6. Config
  7. \
  8. ConfigCollectionInfo

ConfigCollectionInfo

class ConfigCollectionInfo extends Event (View source)

Gets information on all the possible configuration collections.

Properties

protected array $collections

Configuration collection information keyed by collection name.

Methods

addCollection(string $collection, ConfigFactoryOverrideInterface $override_service = NULL)

Adds a collection to the list of possible collections.

array
getCollectionNames(bool $include_default = TRUE)

Gets the list of possible collection names.

ConfigFactoryOverrideInterface|null
getOverrideService(string $collection)

Gets the config factory override service responsible for the collection.

Details

at line 35
addCollection(string $collection, ConfigFactoryOverrideInterface $override_service = NULL)

Adds a collection to the list of possible collections.

Parameters

string $collection

Collection name to add.
ConfigFactoryOverrideInterface $override_service

(optional) The configuration factory override service responsible for the collection.

Exceptions

InvalidArgumentException

at line 51
array getCollectionNames(bool $include_default = TRUE)

Gets the list of possible collection names.

Parameters

bool $include_default

(Optional) Include the default collection. Defaults to TRUE.

Return Value

array

The list of possible collection names.

at line 70
ConfigFactoryOverrideInterface|null getOverrideService(string $collection)

Gets the config factory override service responsible for the collection.

Parameters

string $collection

The configuration collection.

Return Value

ConfigFactoryOverrideInterface|null

The override service responsible for the collection if one exists. NULL if not.