class ThemeSettings in Drupal 8

Provides a configuration API wrapper for runtime merged theme settings.

Theme settings use configuration for base values but the runtime theme settings are calculated based on various site settings and are therefore not persisted.

Hierarchy

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

See also

theme_get_setting()

1 file declares its use of ThemeSettings

theme.inc in core/includes/theme.inc

The theme system, which controls the output of Drupal.

File

core/lib/Drupal/Core/Theme/ThemeSettings.php, line 16

Namespace

Drupal\Core\Theme

class ThemeSettings extends ConfigBase {

  /**
   * The theme of the theme settings object.
   *
   * @var string
   */
  protected $theme;

  /**
   * Constructs a theme settings object.
   *
   * @param string $theme
   *   The name of the theme settings object being constructed.
   */
  public function __construct($theme) {
    $this->theme = $theme;
  }

  /**
   * Returns the theme of this theme settings object.
   *
   * @return string
   *   The theme of this theme settings object.
   */
  public function getTheme() {
    return $this->theme;
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheTags() {
    return [
      'rendered',
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyTrait::$cacheContexts	protected	property	Cache contexts.
CacheableDependencyTrait::$cacheMaxAge	protected	property	Cache max-age.
CacheableDependencyTrait::$cacheTags	protected	property	Cache tags.
CacheableDependencyTrait::setCacheability	protected	function	Sets cacheability; useful for value object constructors.
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.	1
ConfigBase::get	public	function	Gets data from this configuration object.	1
ConfigBase::getCacheContexts	public	function	The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
ConfigBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
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.	1
ConfigBase::setData	public	function	Replaces the data of this configuration object.	1
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::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
RefinableCacheableDependencyTrait::addCacheableDependency	public	function		1
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
ThemeSettings::$theme	protected	property	The theme of the theme settings object.
ThemeSettings::getCacheTags	public	function	The cache tags associated with this object. Overrides ConfigBase::getCacheTags
ThemeSettings::getTheme	public	function	Returns the theme of this theme settings object.
ThemeSettings::__construct	public	function	Constructs a theme settings object.