abstract class ConfigBase

Provides a base class for configuration objects with get/set support.

Encapsulates all capabilities needed for runtime configuration handling for a specific configuration object.

Extend directly from this class for non-storable configuration where the configuration API is desired but storage is not possible; for example, if the data is derived at runtime. For storable configuration, extend \Drupal\Core\Config\StorableConfigBase.

Hierarchy

• class \Drupal\Core\Config\ConfigBase implements RefinableCacheableDependencyInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait

See also

\Drupal\Core\Config\StorableConfigBase

\Drupal\Core\Config\Config

\Drupal\Core\Theme\ThemeSettings

File

core/lib/Drupal/Core/Config/ConfigBase.php, line 27

Namespace

Drupal\Core\Config

Members

Name	Modifiers	Type	Description
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::clear	public	function	Unsets a value in this configuration object.
ConfigBase::get	public	function	Gets data from this configuration object.
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::set	public	function	Sets a value in this configuration object.
ConfigBase::setData	public	function	Replaces the data of this 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
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