class DesignToken
Same name in this branch
- main core/lib/Drupal/Core/Theme/DesignToken/DesignToken.php \Drupal\Core\Theme\DesignToken\DesignToken
Same name and namespace in other branches
- 11.x core/lib/Drupal/Core/Theme/Entity/DesignToken.php \Drupal\Core\Theme\Entity\DesignToken
- 11.x core/lib/Drupal/Core/Theme/DesignToken/DesignToken.php \Drupal\Core\Theme\DesignToken\DesignToken
Configuration entity.
Allow to override and scope design tokens.
@internal This API is experimental.
Attributes
#[ConfigEntityType(id: 'design_token', label: new TranslatableMarkup('Design token'), entity_keys: [
'id' => 'id',
'label' => 'id',
], admin_permission: 'administer design tokens', constraints: [
'ImmutableProperties' => [
'properties' => [
'id',
'path',
'type',
],
],
], config_export: [
'id',
'path',
'type',
'scopes',
])]
Hierarchy
- class \Drupal\Core\Entity\EntityBase implements \Drupal\Core\Entity\EntityInterface uses \Drupal\Core\Cache\RefinableCacheableDependencyTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
- class \Drupal\Core\Theme\Entity\DesignToken implements \Drupal\Core\Theme\Entity\DesignTokenInterface, \Drupal\Core\Entity\EntityWithPluginCollectionInterface extends \Drupal\Core\Config\Entity\ConfigEntityBase
- class \Drupal\Core\Config\Entity\ConfigEntityBase implements \Drupal\Core\Config\Entity\ConfigEntityInterface uses \Drupal\Core\Plugin\PluginDependencyTrait, \Drupal\Core\Entity\SynchronizableEntityTrait extends \Drupal\Core\Entity\EntityBase
Expanded class hierarchy of DesignToken
6 files declare their use of DesignToken
- DesignTokenConfigEntityKernelTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Theme/ DesignToken/ DesignTokenConfigEntityKernelTest.php - DesignTokenEntityTest.php in core/
tests/ Drupal/ Tests/ Core/ Theme/ DesignToken/ DesignTokenEntityTest.php - DesignTokenResourceTestBase.php in core/
tests/ Drupal/ FunctionalTests/ Rest/ DesignTokenResourceTestBase.php - DesignTokenTest.php in core/
modules/ jsonapi/ tests/ src/ Functional/ DesignTokenTest.php - DesignTokenValidationTest.php in core/
tests/ Drupal/ KernelTests/ Core/ Theme/ DesignToken/ DesignTokenValidationTest.php
File
-
core/
lib/ Drupal/ Core/ Theme/ Entity/ DesignToken.php, line 23
Namespace
Drupal\Core\Theme\EntityView source
class DesignToken extends ConfigEntityBase implements DesignTokenInterface, EntityWithPluginCollectionInterface {
/**
* The design token ID.
*/
protected ?string $id;
/**
* The design token path.
*/
protected string $path;
/**
* The design token type.
*/
protected string $type;
/**
* The design token scopes.
*/
protected array $scopes;
/**
* Holds the collection of scopes.
*/
private DesignTokenValuePluginCollection $scopesCollection;
/**
* {@inheritdoc}
*/
public function getCssVariableName() : string {
$name = $this->path;
$name = \strtr($name, [
'_' => '-',
' ' => '-',
'.' => '-',
]);
return "--{$name}";
}
/**
* {@inheritdoc}
*/
public function getScopes() : DesignTokenValuePluginCollection {
if (!isset($this->scopesCollection)) {
/** @var \Drupal\Core\Theme\DesignToken\DesignTokenValuePluginManagerInterface $manager */
$manager = \Drupal::service(DesignTokenValuePluginManagerInterface::class);
$this->scopesCollection = new DesignTokenValuePluginCollection($manager, $this->type, $this->scopes);
}
return $this->scopesCollection;
}
/**
* {@inheritdoc}
*/
public function getPluginCollections() {
return [
'scopes' => $this->getScopes(),
];
}
/**
* {@inheritdoc}
*/
public function preSave(EntityStorageInterface $storage) : void {
parent::preSave($storage);
// Ensure scope does not contain a dot.
foreach ($this->scopes as $scope => $value) {
if (\strpos($scope, '.') !== FALSE) {
$this->scopes[static::getConfigScopeName($scope)] = $value;
unset($this->scopes[$scope]);
}
}
}
/**
* {@inheritdoc}
*/
public static function toCss(array $tokens) : string {
// Regroup values by scope.
$scopes = [];
foreach ($tokens as $token) {
foreach ($token->getScopes() as $scope => $value) {
$scope = static::getCssScopeName($scope);
if (!isset($scopes[$scope])) {
$scopes[$scope] = [];
}
$scopes[$scope][$token->getCssVariableName()] = $value;
}
}
return static::getCssVariablesInlineCss($scopes);
}
/**
* Prepares a scope for CSS usage.
*
* Transform DOT_CONVERSION_CHARACTER into dot.
*
* @param string $scope
* The scope to convert.
*
* @return string
* The converted scope.
*/
public static function getCssScopeName(string $scope) : string {
return \str_replace(self::DOT_CONVERSION_CHARACTER, '.', $scope);
}
/**
* Prepares a scope for config storage.
*
* Transform dot into DOT_CONVERSION_CHARACTER.
*
* @param string $scope
* The scope to convert.
*
* @return string
* The converted scope.
*/
public static function getConfigScopeName(string $scope) : string {
return \str_replace('.', self::DOT_CONVERSION_CHARACTER, $scope);
}
/**
* Prepares inline CSS from scope grouped CSS variables.
*
* @param array $scopes
* The prepared scopes.
*
* @return string
* The inline CSS.
*/
protected static function getCssVariablesInlineCss(array $scopes) : string {
$css = '';
foreach ($scopes as $scope => $variables) {
if (!\is_array($variables) || empty($variables)) {
continue;
}
$scope_variables = [];
foreach ($variables as $variableName => $variableValue) {
$scope_variables[] = "{$variableName}:{$variableValue->toCss()};";
}
$css .= "{$scope}{" . \implode('', $scope_variables) . '}';
}
return $css;
}
}
Members
| Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | 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. | ||||
| ConfigEntityBase::$isUninstalling | private | property | Whether the config is being deleted by the uninstall process. | ||||
| ConfigEntityBase::$langcode | protected | property | The language code of the entity's default language. | ||||
| ConfigEntityBase::$originalId | protected | property | The original ID of the configuration entity. | ||||
| ConfigEntityBase::$status | protected | property | The enabled/disabled status of the configuration entity. | 4 | |||
| ConfigEntityBase::$third_party_settings | protected | property | Third party entity settings. | ||||
| ConfigEntityBase::$trustedData | Deprecated | protected | property | Trust supplied data and not use configuration schema on save. | |||
| ConfigEntityBase::$uuid | protected | property | The UUID for this entity. | ||||
| ConfigEntityBase::$_core | protected | property | Information maintained by Drupal core about configuration. | ||||
| ConfigEntityBase::addDependency | protected | function | Overrides \Drupal\Core\Entity\DependencyTrait:addDependency(). | ||||
| ConfigEntityBase::calculateDependencies | public | function | Calculates dependencies and stores them in the dependency property. | Overrides ConfigEntityInterface::calculateDependencies | 12 | ||
| ConfigEntityBase::createDuplicate | public | function | Creates a duplicate of the entity. | Overrides EntityBase::createDuplicate | 1 | ||
| ConfigEntityBase::disable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Disable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::disable | 1 | ||
| ConfigEntityBase::enable | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Enable'), pluralize: FALSE)] | Overrides ConfigEntityInterface::enable | |||
| ConfigEntityBase::get | public | function | Returns the value of a property. | Overrides ConfigEntityInterface::get | |||
| ConfigEntityBase::getCacheTagsToInvalidate | public | function | Returns the cache tags that should be used to invalidate caches. | Overrides EntityBase::getCacheTagsToInvalidate | 2 | ||
| ConfigEntityBase::getConfigDependencyName | public | function | Gets the configuration dependency name. | Overrides EntityBase::getConfigDependencyName | |||
| ConfigEntityBase::getConfigManager | protected static | function | Gets the configuration manager. | ||||
| ConfigEntityBase::getConfigTarget | public | function | Gets the configuration target identifier for the entity. | Overrides EntityBase::getConfigTarget | |||
| ConfigEntityBase::getDependencies | public | function | Gets the configuration dependencies. | Overrides ConfigEntityInterface::getDependencies | |||
| ConfigEntityBase::getOriginalId | public | function | Gets the original ID. | Overrides EntityBase::getOriginalId | |||
| ConfigEntityBase::getThirdPartyProviders | public | function | Gets the list of third parties that store information. | Overrides ThirdPartySettingsInterface::getThirdPartyProviders | |||
| ConfigEntityBase::getThirdPartySetting | public | function | Gets the value of a third-party setting. | Overrides ThirdPartySettingsInterface::getThirdPartySetting | |||
| ConfigEntityBase::getThirdPartySettings | public | function | Gets all third-party settings of a given module. | Overrides ThirdPartySettingsInterface::getThirdPartySettings | |||
| ConfigEntityBase::getTypedConfig | protected | function | Gets the typed config manager. | ||||
| ConfigEntityBase::hasTrustedData | public | function | Gets whether on not the data is trusted. | Overrides ConfigEntityInterface::hasTrustedData | |||
| ConfigEntityBase::invalidateTagsOnDelete | protected static | function | Override to never invalidate the individual entities' cache tags; the config system already invalidates them. |
Overrides EntityBase::invalidateTagsOnDelete | |||
| ConfigEntityBase::invalidateTagsOnSave | protected | function | Override to never invalidate the entity's cache tag; the config system already invalidates it. |
Overrides EntityBase::invalidateTagsOnSave | |||
| ConfigEntityBase::isInstallable | public | function | Checks whether this entity is installable. | Overrides ConfigEntityInterface::isInstallable | 2 | ||
| ConfigEntityBase::isNew | public | function | Overrides EntityBase::isNew(). | Overrides EntityBase::isNew | |||
| ConfigEntityBase::isUninstalling | public | function | Returns whether this entity is being changed during the uninstall process. | Overrides ConfigEntityInterface::isUninstalling | |||
| ConfigEntityBase::loadMultipleOverrideFree | public static | function | Loads one or more entities in their original form without overrides. | ||||
| ConfigEntityBase::loadOverrideFree | public static | function | Loads one entity in their original form without overrides. | ||||
| ConfigEntityBase::onDependencyRemoval | public | function | Informs the entity that entities it depends on will be deleted. | Overrides ConfigEntityInterface::onDependencyRemoval | 8 | ||
| ConfigEntityBase::preDelete | public static | function | Acts on entities before they are deleted and before hooks are invoked. | Overrides EntityBase::preDelete | 8 | ||
| ConfigEntityBase::save | public | function | Saves an entity permanently. | Overrides EntityBase::save | 2 | ||
| ConfigEntityBase::set | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set a value'), pluralize: 'setMultiple')] | Overrides ConfigEntityInterface::set | 1 | ||
| ConfigEntityBase::setOriginalId | public | function | Sets the original ID. | Overrides EntityBase::setOriginalId | |||
| ConfigEntityBase::setStatus | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set status'), pluralize: FALSE)] | Overrides ConfigEntityInterface::setStatus | |||
| ConfigEntityBase::setThirdPartySetting | public | function | #[ActionMethod(adminLabel: new TranslatableMarkup('Set third-party setting'))] | Overrides ThirdPartySettingsInterface::setThirdPartySetting | |||
| ConfigEntityBase::setUninstalling | public | function | |||||
| ConfigEntityBase::sort | public static | function | Callback for uasort() to sort configuration entities by weight and label. | 6 | |||
| ConfigEntityBase::status | public | function | Returns whether the configuration entity is enabled. | Overrides ConfigEntityInterface::status | 4 | ||
| ConfigEntityBase::toArray | public | function | Gets an array of all property values. | Overrides EntityBase::toArray | 3 | ||
| ConfigEntityBase::toUrl | public | function | Gets the URL object for the entity. | Overrides EntityBase::toUrl | |||
| ConfigEntityBase::trustData | public | function | Sets that the data should be trusted. | Overrides ConfigEntityInterface::trustData | |||
| ConfigEntityBase::unsetThirdPartySetting | public | function | Unsets a third-party setting. | Overrides ThirdPartySettingsInterface::unsetThirdPartySetting | |||
| ConfigEntityBase::__construct | public | function | Constructs an Entity object. | Overrides EntityBase::__construct | 9 | ||
| ConfigEntityBase::__sleep | public | function | Overrides EntityBase::__sleep | 4 | |||
| 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 | Aliased as: traitSleep | 2 | |||
| DependencySerializationTrait::__wakeup | public | function | 2 | ||||
| DependencyTrait::$dependencies | protected | property | The object's dependencies. | ||||
| DependencyTrait::addDependencies | protected | function | Adds multiple dependencies. | ||||
| DependencyTrait::addDependency | protected | function | Adds a dependency. | Aliased as: addDependencyTrait | |||
| DesignToken::$id | protected | property | The design token ID. | ||||
| DesignToken::$path | protected | property | The design token path. | ||||
| DesignToken::$scopes | protected | property | The design token scopes. | ||||
| DesignToken::$scopesCollection | private | property | Holds the collection of scopes. | ||||
| DesignToken::$type | protected | property | The design token type. | ||||
| DesignToken::getConfigScopeName | public static | function | Prepares a scope for config storage. | ||||
| DesignToken::getCssScopeName | public static | function | Prepares a scope for CSS usage. | ||||
| DesignToken::getCssVariableName | public | function | Gets CSS variable name. | Overrides DesignTokenInterface::getCssVariableName | |||
| DesignToken::getCssVariablesInlineCss | protected static | function | Prepares inline CSS from scope grouped CSS variables. | ||||
| DesignToken::getPluginCollections | public | function | Gets the plugin collections used by this object. | Overrides ObjectWithPluginCollectionInterface::getPluginCollections | |||
| DesignToken::getScopes | public | function | Gets scopes with design token plugin values according to the type. | Overrides DesignTokenInterface::getScopes | |||
| DesignToken::preSave | public | function | Acts on an entity before the presave hook is invoked. | Overrides ConfigEntityBase::preSave | |||
| DesignToken::toCss | public static | function | Exports the given tokens into CSS variables. | Overrides DesignTokenInterface::toCss | |||
| DesignTokenInterface::DOT_CONVERSION_CHARACTER | public | constant | The character used has placeholder for the dot character. | ||||
| EntityBase::$enforceIsNew | protected | property | Boolean indicating whether the entity should be forced to be new. | ||||
| EntityBase::$entityTypeId | protected | property | The entity type. | ||||
| EntityBase::$originalEntity | protected | property | The original unchanged entity. | ||||
| EntityBase::$typedData | protected | property | A weak reference to the typed data object wrapping this entity. | ||||
| EntityBase::access | public | function | Checks data value access. | Overrides AccessibleInterface::access | 1 | ||
| EntityBase::bundle | public | function | Gets the bundle of the entity. | Overrides EntityInterface::bundle | 1 | ||
| EntityBase::create | public static | function | Constructs a new entity object, without permanently saving it. | Overrides EntityInterface::create | 2 | ||
| EntityBase::delete | public | function | Deletes an entity permanently. | Overrides EntityInterface::delete | 1 | ||
| EntityBase::enforceIsNew | public | function | Enforces an entity to be new. | Overrides EntityInterface::enforceIsNew | |||
| EntityBase::entityTypeBundleInfo | protected | function | Gets the entity type bundle info service. | ||||
| EntityBase::entityTypeManager | protected | function | Gets the entity type manager. | ||||
| EntityBase::getCacheContexts | public | function | The cache contexts associated with this object. | Overrides CacheableDependencyTrait::getCacheContexts | |||
| EntityBase::getCacheMaxAge | public | function | The maximum age for which this object may be cached. | Overrides CacheableDependencyTrait::getCacheMaxAge | |||
| EntityBase::getCacheTags | public | function | The cache tags associated with this object. | Overrides CacheableDependencyTrait::getCacheTags | |||
| EntityBase::getConfigDependencyKey | public | function | Gets the key that is used to store configuration dependencies. | Overrides EntityInterface::getConfigDependencyKey | |||
| EntityBase::getEntityType | public | function | Gets the entity type definition. | Overrides EntityInterface::getEntityType | 1 | ||
| EntityBase::getEntityTypeId | public | function | Gets the ID of the type of the entity. | Overrides EntityInterface::getEntityTypeId | |||
| EntityBase::getListCacheTagsToInvalidate | protected | function | The list cache tags to invalidate for this entity. | ||||
| EntityBase::getOriginal | public | function | Returns the original unchanged entity. | Overrides EntityInterface::getOriginal | |||
| EntityBase::getTypedData | public | function | #[\NoDiscard] | Overrides EntityInterface::getTypedData | |||
| EntityBase::getTypedDataClass | private | function | Returns the typed data class name for this entity. | ||||
| EntityBase::hasLinkTemplate | public | function | Indicates if a link template exists for a given key. | Overrides EntityInterface::hasLinkTemplate | |||
| EntityBase::id | public | function | Gets the identifier. | Overrides EntityInterface::id | 10 | ||
| EntityBase::label | public | function | Gets the label of the entity. | Overrides EntityInterface::label | 6 | ||
| EntityBase::language | public | function | Gets the language of the entity. | Overrides EntityInterface::language | 1 | ||
| EntityBase::languageManager | protected | function | Gets the language manager. | ||||
| EntityBase::linkTemplates | protected | function | Gets an array link templates. | 1 | |||
| EntityBase::load | public static | function | Loads an entity. | Overrides EntityInterface::load | |||
| EntityBase::loadMultiple | public static | function | Loads one or more entities. | Overrides EntityInterface::loadMultiple | |||
| EntityBase::postCreate | public | function | Acts on a created entity before hooks are invoked. | Overrides EntityInterface::postCreate | 5 | ||
| EntityBase::postDelete | public static | function | Acts on deleted entities before the delete hook is invoked. | Overrides EntityInterface::postDelete | 17 | ||
| EntityBase::postLoad | public static | function | Acts on loaded entities. | Overrides EntityInterface::postLoad | 3 | ||
| EntityBase::postSave | public | function | Acts on a saved entity before the insert or update hook is invoked. | Overrides EntityInterface::postSave | 12 | ||
| EntityBase::preCreate | public static | function | Changes the values of an entity before it is created. | Overrides EntityInterface::preCreate | 6 | ||
| EntityBase::referencedEntities | public | function | Gets a list of entities referenced by this entity. | Overrides EntityInterface::referencedEntities | 1 | ||
| EntityBase::setOriginal | public | function | Sets the original unchanged entity. | Overrides EntityInterface::setOriginal | |||
| EntityBase::toLink | public | function | Generates the HTML for a link to this entity. | Overrides EntityInterface::toLink | |||
| EntityBase::uriRelationships | public | function | Gets a list of URI relationships supported by this entity. | Overrides EntityInterface::uriRelationships | |||
| EntityBase::urlRouteParameters | protected | function | Gets an array of placeholders for this entity. | 2 | |||
| EntityBase::uuid | public | function | Gets the entity UUID (Universally Unique Identifier). | Overrides EntityInterface::uuid | 1 | ||
| EntityBase::uuidGenerator | protected | function | Gets the UUID generator. | ||||
| PluginDependencyTrait::calculatePluginDependencies | protected | function | Calculates and adds dependencies of a specific plugin instance. | 1 | |||
| PluginDependencyTrait::getPluginDependencies | protected | function | Calculates and returns dependencies of a specific plugin instance. | ||||
| PluginDependencyTrait::moduleHandler | protected | function | Wraps the module handler. | 1 | |||
| PluginDependencyTrait::themeHandler | protected | function | Wraps the theme handler. | 1 | |||
| RefinableCacheableDependencyTrait::addCacheableDependency | public | function | 1 | ||||
| RefinableCacheableDependencyTrait::addCacheContexts | public | function | |||||
| RefinableCacheableDependencyTrait::addCacheTags | public | function | |||||
| RefinableCacheableDependencyTrait::mergeCacheMaxAge | public | function | |||||
| SynchronizableEntityTrait::$isSyncing | protected | property | Is entity being created updated or deleted through synchronization process. | ||||
| SynchronizableEntityTrait::isSyncing | public | function | |||||
| SynchronizableEntityTrait::setSyncing | public | function |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.