Defines the immutable configuration object.
Encapsulates all capabilities needed for runtime configuration handling except being able to change the configuration.
If you need to be able to change configuration use \Drupal\Core\Form\ConfigFormBaseTrait or \Drupal\Core\Config\ConfigFactoryInterface::getEditable().
Hierarchy
- class \Drupal\Core\Config\ConfigBase implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
- class \Drupal\Core\Config\StorableConfigBase
- class \Drupal\Core\Config\Config
- class \Drupal\Core\Config\ImmutableConfig
- class \Drupal\Core\Config\Config
- class \Drupal\Core\Config\StorableConfigBase
See also
\Drupal\Core\Form\ConfigFormBaseTrait
\Drupal\Core\Config\ConfigFactoryInterface::getEditable()
\Drupal\Core\Config\ConfigFactoryInterface::get()
Related topics
- Configuration API
- Information about the Configuration API.
File
- core/lib/Drupal/Core/Config/ImmutableConfig.php, line 21
Namespace
Drupal\Core\Config
Members
| Name | Modifiers | Type | Description |
|---|---|---|---|
| Config::$eventDispatcher | protected | property | An event dispatcher instance to use for configuration events. |
| Config::$moduleOverrides | protected | property | The current module overrides. |
| Config::$overriddenData | protected | property | The current runtime data. |
| Config::$settingsOverrides | protected | property | The current settings overrides. |
| Config::get | public | function | Gets data from this configuration object. Overrides ConfigBase::get |
| Config::getOriginal | public | function | Gets original data from this configuration object. |
| Config::getRawData | public | function | Gets the raw data without overrides. |
| Config::initWithData | public | function | Initializes a configuration object with pre-loaded data. Overrides StorableConfigBase::initWithData |
| Config::resetOverriddenData | protected | function | Resets the current data, so overrides are re-applied. |
| Config::setData | public | function | Replaces the data of this configuration object. Overrides ConfigBase::setData |
| Config::setModuleOverride | public | function | Sets module overrides for this configuration object. |
| Config::setOverriddenData | protected | function | Sets the current data for this configuration object. |
| Config::setSettingsOverride | public | function | Sets settings.php overrides for this configuration object. |
| Config::__construct | public | function | Constructs a configuration object. |
| ConfigBase::$data | protected | property | The data of the configuration object. |
| ConfigBase::$name | protected | property | The name of the configuration object. |
| ConfigBase::castSafeStrings | protected | function | Casts any objects that implement MarkupInterface to string. |
| ConfigBase::getCacheContexts | public | function | The cache contexts associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheContexts |
| ConfigBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. Overrides RefinableCacheableDependencyTrait::getCacheMaxAge |
| ConfigBase::getCacheTags | public | function | The cache tags associated with this object. Overrides RefinableCacheableDependencyTrait::getCacheTags |
| ConfigBase::getName | public | function | Returns the name of this configuration object. |
| ConfigBase::MAX_NAME_LENGTH | constant | The maximum length of a configuration object name. | |
| ConfigBase::merge | public | function | Merges data into a configuration object. |
| ConfigBase::setName | public | function | Sets the name of this configuration object. |
| ConfigBase::validateKeys | protected | function | Validates all keys in a passed in config array structure. |
| ConfigBase::validateName | public static | function | Validates the configuration object name. |
| DependencySerializationTrait::$_serviceIds | protected | property | An array of service IDs keyed by property name used for serialization. |
| DependencySerializationTrait::__sleep | public | function | |
| DependencySerializationTrait::__wakeup | public | function | |
| ImmutableConfig::clear | public | function | Unsets a value in this configuration object. Overrides Config::clear |
| ImmutableConfig::delete | public | function | Deletes the configuration object. Overrides Config::delete |
| ImmutableConfig::save | public | function | Saves the configuration object. Overrides Config::save |
| ImmutableConfig::set | public | function | Sets a value in this configuration object. Overrides Config::set |
| RefinableCacheableDependencyTrait::$cacheContexts | protected | property | Cache contexts. |
| RefinableCacheableDependencyTrait::$cacheMaxAge | protected | property | Cache max-age. |
| RefinableCacheableDependencyTrait::$cacheTags | protected | property | Cache tags. |
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | Adds a dependency on an object: merges its cacheability metadata. Overrides RefinableCacheableDependencyInterface::addCacheableDependency |
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | Adds cache contexts. Overrides RefinableCacheableDependencyInterface::addCacheContexts |
| RefinableCacheableDependencyTrait::addCacheTags | public | function | Adds cache tags. Overrides RefinableCacheableDependencyInterface::addCacheTags |
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | Merges the maximum age (in seconds) with the existing maximum age. Overrides RefinableCacheableDependencyInterface::mergeCacheMaxAge |
| StorableConfigBase::$isNew | protected | property | Whether the configuration object is new or has been saved to the storage. |
| StorableConfigBase::$originalData | protected | property | The data of the configuration object. |
| StorableConfigBase::$schemaWrapper | protected | property | The config schema wrapper object for this configuration object. |
| StorableConfigBase::$storage | protected | property | The storage used to load and save this configuration object. |
| StorableConfigBase::$typedConfigManager | protected | property | The typed config manager. |
| StorableConfigBase::castValue | protected | function | Casts the value to correct data type using the configuration schema. |
| StorableConfigBase::getSchemaWrapper | protected | function | Gets the schema wrapper for the whole configuration object. |
| StorableConfigBase::getStorage | public | function | Retrieves the storage used to load and save this configuration object. |
| StorableConfigBase::isNew | public | function | Returns whether this configuration object is new. |
| StorableConfigBase::validateValue | protected | function | Validate the values are allowed data types. |
Please login to continue.